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, t, st, *args) | |
| Returns ODE RHS, with tangent. | |
| convert_coords (self, coord1) | |
| Converts coordinates, identity here. | |
 Public Member Functions inherited from pyoculus.problems.base_problem.BaseProblem | |
Public Attributes | |
| 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" |
Constructor & Destructor Documentation
◆ __init__()
| pyoculus.problems.toroidal_problem.ToroidalProblem.__init__ | ( | self | ) |
Set up the problem with two cyclical coordinates, e.g.
\[ (s, \theta, \zeta) \]
Reimplemented from pyoculus.problems.base_problem.BaseProblem.
Reimplemented in pyoculus.problems.qfm_bfield.QFMBfield, pyoculus.problems.spec_bfield.SPECBfield, pyoculus.problems.toroidal_bfield.ToroidalBfield, and pyoculus.problems.two_waves.TwoWaves.
Member Function Documentation
◆ convert_coords()
| pyoculus.problems.toroidal_problem.ToroidalProblem.convert_coords | ( | self, | |
| coord1 ) |
Converts coordinates, identity here.
- Parameters
-
coords1 the coordinates to convert
- Returns
- the converted coordinates
Reimplemented from pyoculus.problems.base_problem.BaseProblem.
Reimplemented in pyoculus.problems.qfm_bfield.QFMBfield, pyoculus.problems.spec_bfield.SPECBfield, and pyoculus.problems.two_waves.TwoWaves.
◆ f()
| pyoculus.problems.toroidal_problem.ToroidalProblem.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.base_problem.BaseProblem.
Reimplemented in pyoculus.problems.toroidal_bfield.ToroidalBfield.
◆ f_tangent()
| pyoculus.problems.toroidal_problem.ToroidalProblem.f_tangent | ( | self, | |
| t, | |||
| 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.base_problem.BaseProblem.
Reimplemented in pyoculus.problems.toroidal_bfield.ToroidalBfield.
Member Data Documentation
◆ poincare_plot_type
| str pyoculus.problems.toroidal_problem.ToroidalProblem.poincare_plot_type = "yx" |
◆ poincare_plot_xlabel
| str pyoculus.problems.toroidal_problem.ToroidalProblem.poincare_plot_xlabel = "x" |
◆ poincare_plot_ylabel
| str pyoculus.problems.toroidal_problem.ToroidalProblem.poincare_plot_ylabel = "y" |
◆ problem_size
| int pyoculus.problems.toroidal_problem.ToroidalProblem.problem_size = 2 |
The documentation for this class was generated from the following file:
- pyoculus/problems/toroidal_problem.py
