desc.objectives.get_equilibrium_objective

class desc.objectives.get_equilibrium_objective(eq, mode='force', normalize=True)Source

Get the objective function for a typical force balance equilibrium problem.

Parameters:

• eq (Equilibrium) – Equilibrium that will be optimized to satisfy the Objective.

• mode (one of {"force", "forces", "energy"}) – which objective to return. “force” computes force residuals on unified grid. “forces” uses two different grids for radial and helical forces. “energy” is for minimizing MHD energy.

• normalize (bool) – Whether to normalize units of objective.

Returns:

objective, ObjectiveFunction – An objective function with default force balance objectives.