Class MagneticDipoleField

Inheritance Relationships

Base Type

Class Documentation

class MagneticDipoleField : public MagneticField

Magnetic dipole field defined by the magnetic moment and the ‘core’ radius.

Public Functions

inline MagneticDipoleField(const Vector3d &origin, const Vector3d &moment, const double radius)


  • origin – singularity of the dipole field

  • moment – magnetic moment of the dipole field

  • radius – inside a radius around the origin the magnetic field is constant: moment * 2 * mu0 / 3

virtual Vector3d getField(const Vector3d &position) const
inline virtual Vector3d getField(const Vector3d &position, double z) const
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