desc.objectives.get_equilibrium_objective

class desc.objectives.get_equilibrium_objective(mode='force', normalize=True)[source]

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

Parameters:

mode (one of {"force", "forces", "energy", "vacuum"}) – 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. “vacuum” directly minimizes current density.
normalize (bool) – Whether to normalize units of objective.

Returns:

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