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

Inheritance diagram for pyoculus.problems.m3dc1_bfield.M3DC1Bfield:

Public Member Functions
	__init__ (self, B_sim, R0, Z0)
	Set up the M3DC1 field for use of pyoculus.

	B (self, RphiZ, *args)
	The magnetic field, being used by parent class CylindricalBfield.

Public Member Functions inherited from pyoculus.problems.cylindrical_bfield.CylindricalBfield
	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
	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.

Protected Attributes
	_B = B_sim

Protected Attributes inherited from pyoculus.problems.cylindrical_problem.CylindricalProblem
	_R0 = R0

	_Z0 = Z0

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

Detailed Description

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

Constructor & Destructor Documentation

pyoculus.problems.m3dc1_bfield.M3DC1Bfield.__init__	(	self,
		B_sim,
		R0,
		Z0 )

Set up the M3DC1 field for use of pyoculus.

Parameters

B_sim	the M3DC1 data generated by sim.get_bfield('B', time=sometime)
R0	the R coordinate of the magnetic axis
Z0	the Z coordinate of the magnetic axis

pyoculus.problems.m3dc1_bfield.M3DC1Bfield.B	(		self,
			RphiZ,
		*	args )

The magnetic field, being used by parent class CylindricalBfield.

Parameters

RphiZ array with coordinates \((R, \phi, Z)\)

pyoculus.problems.m3dc1_bfield.M3DC1Bfield._B = B_sim

protected

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