magnetic_superposition_field

combine an unlimited number of magnetic fields to a superposition field acting like a single magnetic field

XML element: <magnetic_superposition_field>
C++ type: KMagneticSuperpositionField
Also available as: ksfield_magnetic_super_position
Child elements

Element

Description

add_field

add a magnetic field to the superposition and specify the factor by which its intensity is scaled.

Attributes

Attribute

Type

Description

name

string

the name of the superposition field

require

string

use_caching

bool

store computed values for the magnetic potential, field or gradient in a cache. The next time the same point will be evaluated, the value is already available from the cache. This works only with static fields.

Example:

<magnetic_superposition_field
    name="magnetic_superposition"
    use_caching="true"
>
    <add_field name="magnetic_constant" enhancement="1.0" />
    <add_field name="magnetic_dipole" enhancement="1.0" />
</magnetic_superposition_field>

Used as:

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

  • <magnetic_superposition_field> in <kemfield>

Can be referenced by: