electromagnet_field

provides a magnetic field arising from current-bearing elements computed with kemfield as initialized with kgeobag. to use this field a valid geometry must have been constructed in the <geometry> section. this field must be equipped with at least one field solver to operate. see the field solver elements for the available solvers.

XML element: <electromagnet_field>
C++ type: KGStaticElectromagnetField
Also available as: ksfield_electromagnet
Child elements

Element

Description

integrating_field_solver

performs a sum over all components to obtain the final field.

magfield_coil_field_solver

zonal_harmonic_field_solver

uses the zonal harmonic expansion about an axis to compute fields.

Attributes

Attribute

Type

Description

directory

string

name of directory in which to cache computation.

directory_magfield3

string

file

string

name of file in which to cache computation.

name

string

the name of the magnetic field.

save_magfield3

bool

spaces

string

paths to kgeobag surfaces which are equipped with both a discretization of the boundary and electromagnetic properties.

Refers to KGeoBag spaces (path in the geometry).

surfaces

string

paths to kgeobag surfaces which are equipped with both a discretization and electromagnetic properties.

Refers to KGeoBag surfaces (path in the geometry).

system

string

path to exactly one kgeobag space whose coordinate system the computation will use.

Refers to a KGeoBag space (path in the geometry).

Example:

<electromagnet_field
    name="field_electromagnet"
    directory="."
    file="Magnets.kbd"
    system="assembly"
    surfaces="assembly/@hoop_tag"
    spaces="assembly/@coil_tag"
>
    <integrating_field_solver/>
</electromagnet_field>

Used as:

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

  • <electromagnet_field> in <kemfield>

Can be referenced by:

More information

Appears in the documentation:

Used in example configurations: