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.
<electromagnet_field>KGStaticElectromagnetFieldksfield_electromagnetElement |
Description |
|---|---|
performs a sum over all components to obtain the final field. |
|
uses the zonal harmonic expansion about an axis to compute fields. |
Attribute |
Type |
Description |
|---|---|---|
|
|
name of directory in which to cache computation. |
|
|
|
|
|
name of file in which to cache computation. |
|
|
the name of the magnetic field. |
|
|
|
|
|
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). |
|
|
paths to kgeobag surfaces which are equipped with both a discretization and electromagnetic properties. Refers to KGeoBag surfaces (path in the geometry). |
|
|
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:
root_fieldof <induced_azimuthal_electric_field>magnetic_fieldof <ks_simulation>fieldof <magnetic_fieldmap_calculator>root_fieldof <ramped_magnetic_field>
More information
Appears in the documentation:
Fields (Magnetic fields)
Used in example configurations:
<Kassiopeia/XML/Examples/DipoleTrapMeshedSpaceSimulation.xml>
<Kassiopeia/XML/Examples/VTK/DipoleTrapMeshedSpaceSimulation.xml>