desc.objectives.BoundaryError.compute

BoundaryError.compute(*params, constants=None)Source

Compute boundary force error.

Parameters:

• params (dict) – One or more dictionaries of parameters. If field_fixed=True, then params[0] is the equilibrium parameters, e.g. Equilibrium.params_dict. If eq_fixed=True, then params[0:] are field parameters, e.g. MagneticField.params_dict. Otherwise, params[0] are the equilibrium params and params[1:] are the field params.

• constants (dict) – Dictionary of constant data, eg transforms, profiles etc. Defaults to self.constants. (Deprecated)

Returns:

f (ndarray) – Boundary error. First half is √g𝐁⋅𝐧 in T*m^2, second half is √g[[B² + 2μ₀p]] in T^2*m^2. If sheet current is included, third half is √g||μ₀𝐊 − 𝐧 × [𝐁]|| in T*m^2