desc.magnetic_fields.MagneticFieldFromUser.compute_magnetic_field

MagneticFieldFromUser.compute_magnetic_field(coords, params=None, basis='rpz', source_grid=None)Source

Compute magnetic field at a set of points.

Parameters:

• coords (array-like shape(n,3)) – Nodes to evaluate field at in [R,phi,Z] or [X,Y,Z] coordinates.

• params (array-like, optional) – Optimizable parameters, defaults to field.params.

• basis ({"rpz", "xyz"}) – Basis for input coordinates and returned magnetic field.

• source_grid (Grid, int or None or array-like, optional) – Unused by this class, only kept for API compatibility

Returns:

field (ndarray, shape(N,3)) – magnetic field at specified points