pyoculus.problems.cylindrical_problem.CylindricalProblem Class Reference

Inheritance diagram for pyoculus.problems.cylindrical_problem.CylindricalProblem:

Public Member Functions
	__init__ (self, R0, Z0, Nfp=1)
	Set up cylindrical system.
	f_RZ (self, phi, RZ, *args)
	Returns ODE RHS.
	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 Attributes
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"

Protected Attributes
	_R0 = R0
	_Z0 = Z0

Constructor & Destructor Documentation

__init__()

pyoculus.problems.cylindrical_problem.CylindricalProblem.__init__	(		self,
			R0,
			Z0,
			Nfp = 1 )

Set up cylindrical system.

\[ (R, \varphi, Z) \]

Reimplemented from pyoculus.problems.base_problem.BaseProblem.

Reimplemented in pyoculus.problems.cartesian_bfield.CartesianBfield, pyoculus.problems.cylindrical_bfield.CylindricalBfield, pyoculus.problems.m3dc1_bfield.M3DC1Bfield, and pyoculus.problems.simsgeo_biot_savart.SimsgeoBiotSavart.

Member Function Documentation

f()

pyoculus.problems.cylindrical_problem.CylindricalProblem.f	(		self,
			zeta,
			y,
		*	args )

Returns ODE RHS.

Parameters

zeta	cylindrical angle in ODE
y

Reimplemented from pyoculus.problems.base_problem.BaseProblem.

f_RZ()

pyoculus.problems.cylindrical_problem.CylindricalProblem.f_RZ	(		self,
			phi,
			RZ,
		*	args )

Returns ODE RHS.

Parameters

zeta	cylindrical angle in ODE
RZ	\((R, Z)\) in ODE
*args	extra parameters for the ODE

Returns

the RHS of the ODE

Reimplemented in pyoculus.problems.cartesian_bfield.CartesianBfield, and pyoculus.problems.cylindrical_bfield.CylindricalBfield.

f_RZ_tangent()

pyoculus.problems.cylindrical_problem.CylindricalProblem.f_RZ_tangent	(		self,
			phi,
			RZ,
		*	args )

Returns ODE RHS, with tangent.

Parameters

zeta	cylindrical angle in ODE
RZ	\((R, Z, dR_1, dZ_1, dR_2, dZ_2)\) in ODE
*args	extra parameters for the ODE

Returns

the RHS of the ODE, with tangent

Reimplemented in pyoculus.problems.cartesian_bfield.CartesianBfield.

f_tangent()

pyoculus.problems.cylindrical_problem.CylindricalProblem.f_tangent	(		self,
			zeta,
			y,
		*	args )

Returns ODE RHS.

Parameters

zeta	cylindrical angle in ODE
y

Reimplemented from pyoculus.problems.base_problem.BaseProblem.

set_axis()

pyoculus.problems.cylindrical_problem.CylindricalProblem.set_axis	(		self,
			R0,
			Z0 )

Set the axis.

Parameters

R0	\(R_0\)
Z0	\(Z_0\)

Member Data Documentation

_R0

pyoculus.problems.cylindrical_problem.CylindricalProblem._R0 = R0

protected

_Z0

pyoculus.problems.cylindrical_problem.CylindricalProblem._Z0 = Z0

protected

Nfp

pyoculus.problems.cylindrical_problem.CylindricalProblem.Nfp = Nfp

poincare_plot_type

str pyoculus.problems.cylindrical_problem.CylindricalProblem.poincare_plot_type = "RZ"

poincare_plot_xlabel

str pyoculus.problems.cylindrical_problem.CylindricalProblem.poincare_plot_xlabel = "R(m)"

poincare_plot_ylabel

str pyoculus.problems.cylindrical_problem.CylindricalProblem.poincare_plot_ylabel = "Z(m)"

problem_size

int pyoculus.problems.cylindrical_problem.CylindricalProblem.problem_size = 2

---

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

• pyoculus/problems/cylindrical_problem.py