electric_potentialmap_calculator

Creates a potential map stored in the .vti image format.

XML element: <electric_potentialmap_calculator>
C++ type: KElectrostaticPotentialmapCalculator
Also available as: ksfield_electric_potentialmap_calculator
Child elements

Element

Description

field_electric_constant

provides a constant, uniform electric field.

field_electric_quadrupole

provides a perfect quadrupole electric field.

field_electrostatic

provides an electric field arising from disctretized elements computed with kemfield as initialized with kgeobag.

Attributes

Attribute

Type

Description

center

KEMStreamableThreeVector

The center of the cubic mapping region

compute_field

bool

directory

string

the directory of the data file. Defaults to the KEMField scratch directory.

field

string

the name of the field to map

Refers to the name of one of: <constant_electric_field>, <electric_potentialmap>, <electric_quadrupole_field>, <electrostatic_field>, <linear_electric_field>.

file

string

the name of the image data file containing the map. Use .vti as extension.

force_update

bool

length

KEMStreamableThreeVector

The length of the cube where the map is created

mirror_x

bool

boolean option to reduce the map size for mirror symmetric problems along the x axis

mirror_y

bool

boolean option to reduce the map size for mirror symmetric problems along the y axis

mirror_z

bool

boolean option to reduce the map size for mirror symmetric problems along the z axis. These mirror options are combinable.

name

string

name of the calculator

spaces

string

Define spaces to confine the map to points within the intersection of these spaces.

Refers to KGeoBag spaces (path in the geometry).

spacing

double

Distance between the evaluation points for the map.

Example:

<electric_potentialmap_calculator
    name="electric_potentialmap_calculator"
    directory="."
    file="CompleteXMLPotentialMap.vti"
    center="0 0 0"
    length="1.5 1.5 1.5"
    mirror_x="false"
    mirror_y="false"
    mirror_z="false"
    spacing="0.1"
    spaces="outer_space"
    field="electric_quadrupole"
/>

Used as:

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

  • <electric_potentialmap_calculator> in <kemfield>

More information

Appears in the documentation:

Used in example configurations: