desc.magnetic_fields.PoloidalMagneticField.compute_magnetic_field

PoloidalMagneticField.compute_magnetic_field(coords, params=None, basis='rpz', source_grid=None, transforms=None, chunk_size=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) – Dict of values for R0, B0, and iota.

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

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

  • transforms (dict of Transform) – Transforms for R, Z, lambda, etc. Default is to build from source_grid Unused by this MagneticField class.

  • chunk_size (int or None) – Unused by this class, only kept for API compatibility. Size to split computation into chunks of evaluation points. If no chunking should be done or the chunk size is the full input then supply None. Default is None.

Returns:

field (ndarray, shape(N,3)) – magnetic field at specified points, in cylindrical form [BR, Bphi,BZ]