magnetic_fieldmap_calculator

XML element: <magnetic_fieldmap_calculator>
C++ type: KMagnetostaticFieldmapCalculator
Also available as: ksfield_magnetic_fieldmap_calculator
Child elements

Element

Description

field_electromagnet

field_magnetic_constant

provides a constant, uniform magnetic field.

field_magnetic_dipole

Attributes

Attribute

Type

Description

center

KEMStreamableThreeVector

compute_gradient

bool

directory

string

field

string

Refers to the name of one of: <constant_magnetic_field>, <electromagnet_field>, <field_electromagnet>, <magnetic_dipole_field>, <magnetic_fieldmap>, <magnetic_superposition_field>, <ramped_magnetic_field>.

file

string

force_update

bool

length

KEMStreamableThreeVector

mirror_x

bool

mirror_y

bool

mirror_z

bool

name

string

spaces

string

Refers to KGeoBag spaces (path in the geometry).

spacing

double

time

double

Used as:

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

  • <magnetic_fieldmap_calculator> in <kemfield>

More information

Appears in the documentation:

Used in example configurations: