pyoculus.problems.cylindrical_bfield.CylindricalBfield Class Reference

Class that used to setup the cylindrical bfield problem used in ODE solver. More...

Inheritance diagram for pyoculus.problems.cylindrical_bfield.CylindricalBfield:

Public Member Functions
	__init__ (self, R0, Z0, Nfp=1)
	Set up the problem.
	f_RZ (self, phi, RZ, *args)
	Returns ODE RHS.
Public Member Functions inherited from pyoculus.problems.cylindrical_problem.CylindricalProblem
	f_RZ_tangent (self, phi, RZ, *args)
	Returns ODE RHS, with tangent.
	f (self, zeta, y, *args)
	Returns ODE RHS.
	f_tangent (self, zeta, y, *args)
	Returns ODE RHS.
	set_axis (self, R0, Z0)
	Set the axis.
Public Member Functions inherited from pyoculus.problems.base_problem.BaseProblem
	convert_coords (self, coord1)
	Converts coordinates (for example \(s,\theta,\zeta\) to \(R,Z,\varphi\))
Public Member Functions inherited from pyoculus.problems.bfield_problem.BfieldProblem
	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.

Additional Inherited Members
Public Attributes inherited from pyoculus.problems.cylindrical_problem.CylindricalProblem
int	problem_size = 2
str	poincare_plot_type = "RZ"
str	poincare_plot_xlabel = "R(m)"
str	poincare_plot_ylabel = "Z(m)"
	Nfp = 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
Protected Attributes inherited from pyoculus.problems.cylindrical_problem.CylindricalProblem
	_R0 = R0
	_Z0 = Z0

Detailed Description

Class that used to setup the cylindrical bfield problem used in ODE solver.

The system of ODEs is given by

\[ \frac{dR}{d\phi} = \frac{B^{R}}{B^{\phi}} \]

\[ \frac{dZ}{d\phi} = \frac{B^{Z}}{B^{\phi}} \]

Constructor & Destructor Documentation

__init__()

pyoculus.problems.cylindrical_bfield.CylindricalBfield.__init__	(		self,
			R0,
			Z0,
			Nfp = 1 )

Set up the problem.

Parameters

R0	the R coordinate of the magnetic axis
Z0	the Z coordinate of the magnetic axis

Reimplemented from pyoculus.problems.cylindrical_problem.CylindricalProblem.

Reimplemented in pyoculus.problems.m3dc1_bfield.M3DC1Bfield.

Member Function Documentation

f_RZ()

pyoculus.problems.cylindrical_bfield.CylindricalBfield.f_RZ	(		self,
			phi,
			RZ,
		*	args )

Returns ODE RHS.

Parameters

phi	cylindrical angle in ODE
RZ	\((R, Z)\) in ODE
*args	parameter for the ODE

Returns

the RHS of the ODE

Reimplemented from pyoculus.problems.cylindrical_problem.CylindricalProblem.

---

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

• pyoculus/problems/cylindrical_bfield.py