magnetic_dipole_field

provides a perfect dipole magnetic field.

XML element: <magnetic_dipole_field>
C++ type: KMagneticDipoleField
Also available as: ksfield_magnetic_dipole
Attributes

Attribute

Type

Description

location

KEMStreamableThreeVector

cartesian components of the location of the dipole.

moment

KEMStreamableThreeVector

the components of the dipole moment vector in ampere * meter^2.

name

string

the name of the magnetic field.

Example:

<magnetic_dipole_field name="magnetic_dipole" location="0.1 0. 0." moment="0. 0. 10."/>

Used as:

  • <ksfield_magnetic_dipole> (deprecated: define fields in the <kemfield> section instead (legacy alias)) in <kassiopeia>

  • <magnetic_dipole_field> in <kemfield>

Can be referenced by:

More information

Used in example configurations: