desc.objectives.PlasmaVesselDistance

class desc.objectives.PlasmaVesselDistance(surface, eq=None, target=None, bounds=(1, inf), weight=1, normalize=True, normalize_target=True, surface_grid=None, plasma_grid=None, name='plasma vessel distance')

Target the distance between the plasma and a surounding surface.

Computes the minimum distance from each point on the surface grid to a point on the plasma grid. For dense grids, this will approximate the global min, but in general will only be an upper bound on the minimum separation between the plasma and the surrounding surface.

Parameters:

• surface (Surface) – Bounding surface to penalize distance to.

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

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

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

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

Methods

build(eq[, use_jit, verbose])	Build constant arrays.
compute(*args, **kwargs)	Compute plasma-surface distance.
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.