desc.objectives.PrincipalCurvature

class desc.objectives.PrincipalCurvature(eq=None, target=1, bounds=None, weight=1, normalize=True, normalize_target=True, grid=None, name='principal-curvature')

Target a particular value for the (unsigned) principal curvature.

The two principal curvatures at a given point of a surface are the maximum and minimum values of the curvature as expressed by the eigenvalues of the shape operator at that point. They measure how the surface bends by different amounts in different directions at that point.

This objective targets the maximum absolute value of the two principal curvatures. Principal curvature with large absolute value indicates a tight radius of curvature which may be difficult to obtain with coils or magnets.

Parameters:

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

• target (float, ndarray, optional) – Target value(s) of the objective. len(target) must be equal to Objective.dim_f

• 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.

• grid (Grid, ndarray, optional) – Collocation grid containing the nodes to evaluate at.

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

Methods

build(eq[, use_jit, verbose])	Build constant arrays.
compute(*args, **kwargs)	Compute max absolute principal curvature.
compute_scalar(*args, **kwargs)	Compute the scalar form of the objective.
compute_scaled(*args, **kwargs)	Compute and apply the target/bounds, weighting, and normalization.
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).
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.
target_arg	Name of argument corresponding to the target.
weight	Weighting to apply to the Objective, relative to other Objectives.