pyoculus.fields.qfm_bfield

class pyoculus.fields.qfm_bfield.QFMBfield(pb: ToroidalBfield, surfaces: SurfacesToroidal)

B(coords, *args)

! Returns magnetic fields

@param coords

$( ho, artheta,zeta) $

@param *args extra parameters @returns the contravariant magnetic fields

dBdX(coords, *args)

! Returns magnetic fields

@param coords

$(s, heta,zeta) $

@param *args extra parameters @returns B, dBdX, the contravariant magnetic fields, the derivatives of them

B_many(x1arr, x2arr, x3arr, input1D=True, *args)

! Returns magnetic fields, with multipy coordinate inputs @param x1arr the first coordinates. Should have the same length as the other two if input1D=True. @param x2arr the second coordinates. Should have the same length as the other two if input1D=True. @param x3arr the third coordinates. Should have the same length as the other two if input1D=True. @param input1D if False, create a meshgrid with sarr, tarr and zarr, if True, treat them as a list of points @param *args parameter @returns the contravariant magnetic fields

dBdX_many(x1arr, x2arr, x3arr, input1D=True, *args)

! Returns magnetic fields @param x1arr the first coordinates. Should have the same length as the other two if input1D=True. @param x2arr the second coordinates. Should have the same length as the other two if input1D=True. @param x3arr the third coordinates. Should have the same length as the other two if input1D=True. @param input1D if False, create a meshgrid with sarr, tarr and zarr, if True, treat them as a list of points @param *args extra parameters @returns B, dBdX, the contravariant magnetic fields, the derivatives of them

convert_coords(stz)

! Python wrapper for getting the xyz coordinates from stz @param stz the stz coordinate @returns the xyz coordinates