desc.objectives.FixModeZ

class desc.objectives.FixModeZ(eq=None, target=None, bounds=None, weight=1, normalize=True, normalize_target=True, modes=True, name='Fix Mode Z')

Fixes Fourier-Zernike Z coefficients.

Parameters:

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

• target (float, ndarray, optional) –

  Fourier-Zernike Z coefficient target values. If None,

  uses Equilibrium’s Z coefficients.

• bounds (tuple, optional) – Lower and upper bounds on the objective. Overrides target. len(bounds[0]) and len(bounds[1]) must be equal to Objective.dim_f

• weight (float, ndarray, optional) – Weighting to apply to the Objective, relative to other Objectives. len(weight) must be equal to Objective.dim_f

• normalize (bool) – Whether to compute the error in physical units or non-dimensionalize.

• normalize_target (bool) – Whether target should be normalized before comparing to computed values. if normalize is True and the target is in physical units, this should also be set to True.

• modes (ndarray, optional) – Basis modes numbers [l,m,n] of Fourier-Zernike modes to fix. len(target) = len(weight) = len(modes). If True uses all of the Equilibrium’s modes. Must be either True or specified as an array

• name (str) – Name of the objective function.

Methods

build([eq, use_jit, verbose])	Build constant arrays.
compute(Z_lmn, **kwargs)	Compute Fixed mode Z errors.
compute_scalar(*args, **kwargs)	Compute the scalar form of the objective.
compute_scaled(*args, **kwargs)	Compute and apply weighting and normalization.
compute_scaled_error(*args, **kwargs)	Compute and apply the target/bounds, weighting, and normalization.
compute_unscaled(*args, **kwargs)	Compute the raw value of the objective.
copy([deepcopy])	Return a (deep)copy of this object.
eq(other)	Compare equivalence between DESC objects.
jit()	Apply JIT to compute methods, or re-apply after updating self.
load(load_from[, file_format])	Initialize from file.
print_value(*args, **kwargs)	Print the value of the objective.
save(file_name[, file_format, file_mode])	Save the object.
update_target(eq)	Update target values using an Equilibrium.
xs(eq)	Return a tuple of args required by this objective from the Equilibrium eq.

Attributes

args	Names (str) of arguments to the compute functions.
bounds	Lower and upper bounds of the objective.
built	Whether the transforms have been precomputed (or not).
constants	Constant parameters such as transforms and profiles.
derivatives	Derivatives of the function wrt the argument given by the dict keys.
dim_f	Number of objective equations.
dimensions	Dimensions of the argument given by the dict keys.
fixed	Whether the objective fixes individual parameters (or linear combo).
linear	Whether the objective is a linear function (or nonlinear).
name	Name of objective function (str).
normalization	normalizing scale factor.
scalar	Whether default "compute" method is a scalar or vector.
target	Target value(s) of the objective.
weight	Weighting to apply to the Objective, relative to other Objectives.