pyoculus.problems.toroidal_bfield.ToroidalBfield Class Reference

Inheritance diagram for pyoculus.problems.toroidal_bfield.ToroidalBfield:

Public Member Functions
	__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
	convert_coords (self, coord1)
	Converts coordinates, identity here.
Public Member Functions inherited from pyoculus.problems.base_problem.BaseProblem
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.toroidal_problem.ToroidalProblem
int	problem_size = 2
str	poincare_plot_type = "yx"
str	poincare_plot_xlabel = "x"
str	poincare_plot_ylabel = "y"
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

Constructor & Destructor Documentation

__init__()

pyoculus.problems.toroidal_bfield.ToroidalBfield.__init__

(

self

)

Set up the problem with two cyclical coordinates, e.g.

\[ (s, \theta, \zeta) \]

Reimplemented from pyoculus.problems.toroidal_problem.ToroidalProblem.

Reimplemented in pyoculus.problems.qfm_bfield.QFMBfield, pyoculus.problems.spec_bfield.SPECBfield, and pyoculus.problems.two_waves.TwoWaves.

Member Function Documentation

f()

pyoculus.problems.toroidal_bfield.ToroidalBfield.f	(		self,
			zeta,
			st,
		*	args )

Returns ODE RHS.

Parameters

zeta	cylindrical angle in ODE
st	\((s, \theta)\) in ODE
*args	extra parameters for the ODE

Returns

the RHS of the ODE

Reimplemented from pyoculus.problems.toroidal_problem.ToroidalProblem.

f_tangent()

pyoculus.problems.toroidal_bfield.ToroidalBfield.f_tangent	(		self,
			zeta,
			st,
		*	args )

Returns ODE RHS, with tangent.

Parameters

zeta	cylindrical angle in ODE
st	\((s, \theta, ds_1, d\theta_1, ds_2, d\theta_2)\) in ODE
*args	extra parameters for the ODE

Returns

the RHS of the ODE, with tangent

Reimplemented from pyoculus.problems.toroidal_problem.ToroidalProblem.

---

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

• pyoculus/problems/toroidal_bfield.py