desc.magnetic_fields.MagneticFieldFromUser.compute_magnetic_vector_potential

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

Compute magnetic vector potential at a set of points.

Parameters:

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

  • params (dict or array-like of dict, optional) – Dict of values for B0.

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

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

  • 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:

A (ndarray, shape(N,3)) – magnetic vector potential at specified points