Public Member Functions | |
| __init__ (self) | |
| Set up the problem. | |
| 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. | |
Public Attributes | |
| bool | has_jacobian = False |
| if the output magnetic field contains the jacobian factor or not | |
Constructor & Destructor Documentation
◆ __init__()
| pyoculus.problems.bfield_problem.BfieldProblem.__init__ | ( | self | ) |
Set up the problem.
Reimplemented in pyoculus.problems.cartesian_bfield.CartesianBfield, pyoculus.problems.cylindrical_bfield.CylindricalBfield, pyoculus.problems.m3dc1_bfield.M3DC1Bfield, pyoculus.problems.qfm_bfield.QFMBfield, pyoculus.problems.simsgeo_biot_savart.SimsgeoBiotSavart, pyoculus.problems.spec_bfield.SPECBfield, pyoculus.problems.toroidal_bfield.ToroidalBfield, and pyoculus.problems.two_waves.TwoWaves.
Member Function Documentation
◆ B()
| pyoculus.problems.bfield_problem.BfieldProblem.B | ( | self, | |
| coords, | |||
| * | args ) |
Returns magnetic fields.
- Parameters
-
coordinates *args extra parameters
- Returns
- the contravariant magnetic fields
Reimplemented in pyoculus.problems.m3dc1_bfield.M3DC1Bfield, pyoculus.problems.qfm_bfield.QFMBfield, pyoculus.problems.simsgeo_biot_savart.SimsgeoBiotSavart, pyoculus.problems.spec_bfield.SPECBfield, and pyoculus.problems.two_waves.TwoWaves.
◆ B_many()
| pyoculus.problems.bfield_problem.BfieldProblem.B_many | ( | self, | |
| x1arr, | |||
| x2arr, | |||
| x3arr, | |||
| input1D = True, | |||
| * | args ) |
Returns magnetic fields, with multipy coordinate inputs.
- Parameters
-
x1arr the first coordinates. Should have the same length as the other two if input1D=True. x2arr the second coordinates. Should have the same length as the other two if input1D=True. x3arr the third coordinates. Should have the same length as the other two if input1D=True. input1D if False, create a meshgrid with sarr, tarr and zarr, if True, treat them as a list of points *args extra parameters
- Returns
- the contravariant magnetic fields
Reimplemented in pyoculus.problems.qfm_bfield.QFMBfield, pyoculus.problems.spec_bfield.SPECBfield, and pyoculus.problems.two_waves.TwoWaves.
◆ dBdX()
| pyoculus.problems.bfield_problem.BfieldProblem.dBdX | ( | self, | |
| coords, | |||
| * | args ) |
Returns magnetic fields.
- Parameters
-
coordinates *args extra parameters
- Returns
- B, dBdX, the contravariant magnetic fields, the derivatives of them
Reimplemented in pyoculus.problems.qfm_bfield.QFMBfield, pyoculus.problems.simsgeo_biot_savart.SimsgeoBiotSavart, pyoculus.problems.spec_bfield.SPECBfield, and pyoculus.problems.two_waves.TwoWaves.
◆ dBdX_many()
| pyoculus.problems.bfield_problem.BfieldProblem.dBdX_many | ( | self, | |
| x1arr, | |||
| x2arr, | |||
| x3arr, | |||
| input1D = True, | |||
| * | args ) |
Returns magnetic fields.
- Parameters
-
x1arr the first coordinates. Should have the same length as the other two if input1D=True. x2arr the second coordinates. Should have the same length as the other two if input1D=True. x3arr the third coordinates. Should have the same length as the other two if input1D=True. input1D if False, create a meshgrid with sarr, tarr and zarr, if True, treat them as a list of points *args extra parameters
- Returns
- B, dBdX, the contravariant magnetic fields, the derivatives of them
Reimplemented in pyoculus.problems.qfm_bfield.QFMBfield, pyoculus.problems.spec_bfield.SPECBfield, and pyoculus.problems.two_waves.TwoWaves.
Member Data Documentation
◆ has_jacobian
| bool pyoculus.problems.bfield_problem.BfieldProblem.has_jacobian = False |
if the output magnetic field contains the jacobian factor or not
The documentation for this class was generated from the following file:
- pyoculus/problems/bfield_problem.py
