Class LogarithmicSpiralField
Defined in File GalacticMagneticField.h
Inheritance Relationships
Base Type
public MagneticField(Class MagneticField)
Class Documentation
-
class LogarithmicSpiralField : public MagneticField
Galactic disk field model of axisymmetric (ASS) or bisymmetric (BSS) logarithmic spiral shape.
Public Functions
-
inline LogarithmicSpiralField(bool isBSS = true, double b0 = 1., double pitch = M_1_PI / 4., double rsol = 8.5 * kpc, double rc = 3 * kpc, double d = 5 * kpc, double z0 = 3 * kpc)
Constructor
- Parameters:
isBSS – switch for the magnetic field model true for BSS, false for ASS
b0 – magnetic field strength
pitch – pitch angle [rad]
rsol – distance of sun from Galactic center
rc – radius of central region with constant field
d – distance to first field reversal
z0 – vertical attenuation length
-
inline void setParameters(bool isBSS, double b0, double pitch, double rsol, double rc, double d, double z0)
-
inline size_t addReference() const
-
inline size_t removeReference() const
-
inline int removeReferenceNoDelete() const
-
inline size_t getReferenceCount() const
Protected Attributes
-
mutable size_t _referenceCount
-
inline LogarithmicSpiralField(bool isBSS = true, double b0 = 1., double pitch = M_1_PI / 4., double rsol = 8.5 * kpc, double rc = 3 * kpc, double d = 5 * kpc, double z0 = 3 * kpc)