pyoculus.problems.qfm_bfield.QFMBfield Class Reference

Class that used to setup the bfield problem based on QFM. More...

Inheritance diagram for pyoculus.problems.qfm_bfield.QFMBfield:

Public Member Functions
	__init__ (self, ToroidalBfield pb, SurfacesToroidal surfaces)
	Set up the problems based on a known magnetic field and the QFM surfaces.
	B (self, coords, *args)
	Returns magnetic fields.
	dBdX (self, coords, *args)
	Returns magnetic fields.
	B_many (self, x1arr, x2arr, x3arr, input1D=True, *args)
	Returns magnetic fields, with multipy coordinate inputs.
	dBdX_many (self, x1arr, x2arr, x3arr, input1D=True, *args)
	Returns magnetic fields.
	convert_coords (self, stz)
	Python wrapper for getting the xyz coordinates from stz.
Public Member Functions inherited from pyoculus.problems.toroidal_bfield.ToroidalBfield
	__init__ (self)
	Set up the problem with two cyclical coordinates, e.g.
	f (self, zeta, st, *args)
	Returns ODE RHS.
	f_tangent (self, zeta, st, *args)
	Returns ODE RHS, with tangent.
Public Member Functions inherited from pyoculus.problems.toroidal_problem.ToroidalProblem
	__init__ (self)
	Set up the problem with two cyclical coordinates, e.g.
Public Member Functions inherited from pyoculus.problems.base_problem.BaseProblem
	__init__ (self)
Public Member Functions inherited from pyoculus.problems.bfield_problem.BfieldProblem
	__init__ (self)
	Set up the problem.

Public Attributes
	pb = pb
	surfaces = surfaces
	Nfp = pb.Nfp
Public Attributes inherited from pyoculus.problems.base_problem.BaseProblem
int	problem_size = 2
str	poincare_plot_type = "yx"
str	poincare_plot_xlabel = "y"
str	poincare_plot_ylabel = "x"
Public Attributes inherited from pyoculus.problems.bfield_problem.BfieldProblem
bool	has_jacobian = False
	if the output magnetic field contains the jacobian factor or not

Detailed Description

Class that used to setup the bfield problem based on QFM.

Constructor & Destructor Documentation

__init__()

pyoculus.problems.qfm_bfield.QFMBfield.__init__	(		self,
		ToroidalBfield	pb,
		SurfacesToroidal	surfaces )

Set up the problems based on a known magnetic field and the QFM surfaces.

Parameters

pb	the TorodialBfield problem we will used as the original coordinates and fields
surfaces	the QFM surfaces

Member Function Documentation

B()

pyoculus.problems.qfm_bfield.QFMBfield.B	(		self,
			coords,
		*	args )

Returns magnetic fields.

Parameters

coords	\((\rho,\vartheta,\zeta)\)
*args	extra parameters

Returns

the contravariant magnetic fields

Reimplemented from pyoculus.problems.bfield_problem.BfieldProblem.

B_many()

pyoculus.problems.qfm_bfield.QFMBfield.B_many	(		self,
			x1arr,
			x2arr,
			x3arr,
			input1D = True,
		*	args )

Returns magnetic fields, with multipy coordinate inputs.

Parameters

x1arr	the first coordinates. Should have the same length as the other two if input1D=True.
x2arr	the second coordinates. Should have the same length as the other two if input1D=True.
x3arr	the third coordinates. Should have the same length as the other two if input1D=True.
input1D	if False, create a meshgrid with sarr, tarr and zarr, if True, treat them as a list of points
*args	parameter

Returns

the contravariant magnetic fields

Reimplemented from pyoculus.problems.bfield_problem.BfieldProblem.

convert_coords()

pyoculus.problems.qfm_bfield.QFMBfield.convert_coords	(		self,
			stz )

Python wrapper for getting the xyz coordinates from stz.

Parameters

stz	the stz coordinate

Returns

the xyz coordinates

Reimplemented from pyoculus.problems.toroidal_problem.ToroidalProblem.

dBdX()

pyoculus.problems.qfm_bfield.QFMBfield.dBdX	(		self,
			coords,
		*	args )

Returns magnetic fields.

Parameters

coords	\((s,\theta,\zeta)\)
*args	extra parameters

Returns

B, dBdX, the contravariant magnetic fields, the derivatives of them

Reimplemented from pyoculus.problems.bfield_problem.BfieldProblem.

dBdX_many()

pyoculus.problems.qfm_bfield.QFMBfield.dBdX_many	(		self,
			x1arr,
			x2arr,
			x3arr,
			input1D = True,
		*	args )

Returns magnetic fields.

Parameters

x1arr	the first coordinates. Should have the same length as the other two if input1D=True.
x2arr	the second coordinates. Should have the same length as the other two if input1D=True.
x3arr	the third coordinates. Should have the same length as the other two if input1D=True.
input1D	if False, create a meshgrid with sarr, tarr and zarr, if True, treat them as a list of points
*args	extra parameters

Returns

B, dBdX, the contravariant magnetic fields, the derivatives of them

Reimplemented from pyoculus.problems.bfield_problem.BfieldProblem.

Member Data Documentation

Nfp

pyoculus.problems.qfm_bfield.QFMBfield.Nfp = pb.Nfp

pb

pyoculus.problems.qfm_bfield.QFMBfield.pb = pb

surfaces

pyoculus.problems.qfm_bfield.QFMBfield.surfaces = surfaces

---

The documentation for this class was generated from the following file:

• pyoculus/problems/qfm_bfield.py