desc.magnetic_fields.ScalarPotentialField.compute_magnetic_field

ScalarPotentialField.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 (dict or array-like of dict, optional) – Dictionary of optimizable parameters, eg field.params_dict.

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

• source_grid (Grid, int or None) – Unused by this MagneticField class.

Returns:

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