desc.magnetic_fields.ScalarPotentialField.compute_magnetic_field

ScalarPotentialField.compute_magnetic_field(coords, params=None, basis='rpz', grid=None)[source]

Compute magnetic field at a set of points.

Parameters:

  • coords (array-like shape(N,3) or Grid) – cylindrical or cartesian coordinates

  • params (dict, optional) – parameters to pass to scalar potential function

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

  • grid (Grid, int or None) – Grid used to discretize MagneticField object if calculating B from biot savart. If an integer, uses that many equally spaced points. Unused by this MagneticField class

Returns:

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