desc.coils.MixedCoilSet.compute_magnetic_vector_potential

MixedCoilSet.compute_magnetic_vector_potential(coords, params=None, basis='rpz', source_grid=None, transforms=None, chunk_size=None)Source

Compute magnetic vector potential at a set of points.

Parameters:

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

  • params (dict or array-like of dict, optional) – Parameters to pass to coils, either the same for all coils or one for each. If array-like, should be 1 value per coil.

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

  • source_grid (Grid, int or None or array-like, optional) – Grid used to discretize coils. If an integer, uses that many equally spaced points. Should NOT include endpoint at 2pi. If array-like, should be 1 value per coil.

  • transforms (dict of Transform or array-like) – Transforms for R, Z, lambda, etc. Default is to build from grid.

  • chunk_size (int or None) – 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:

vector_potential (ndarray, shape(n,3)) – magnetic vector potential at specified points, in either rpz or xyz coordinates