electrostatic_field

provides an electric field arising from disctretized elements computed with kemfield as initialized with kgeobag. To use this field, a valid geometry must have been constructed in the <geometry> section. The electrostatic field requires exactly one charge density solver for the boundary element method and one field solver. See the charge density solver and field solver elements for the available solvers.

XML element: <electrostatic_field>
C++ type: KGElectrostaticBoundaryField
Also available as: field_electrostatic, ksfield_electrostatic
Child elements

Element

Description

boundary_element_info

display the number of discretized surface elements of the geometry on the console before any computation starts.

cached_bem_solver

This solver loads precomputed charge densities from .kbd files.

cached_charge_density_solver

This solver loads precomputed charge densities from .kbd files.

explicit_superposition_cached_bem_solver

the explicit superposition cached charge densiy solver computes the superposition field of the different configurations specified in the component elements by adding their scaled charge densities.

explicit_superposition_cached_charge_density_solver

the explicit superposition cached charge densiy solver computes the superposition field of the different configurations specified in the component elements by adding their scaled charge densities.

fast_multipole_field_solver

the fast multipole field solver adaptively divides the world cube into smaller cube and computes multipole expansions around the cube center describing the far field for the source elements inside the cube.

gauss_seidel_bem_solver

gauss_seidel_charge_density_solver

gaussian_elimination_bem_solver

uses the gaussian elimination technique to compute charge densities.

gaussian_elimination_charge_density_solver

uses the gaussian elimination technique to compute charge densities.

integrating_field_solver

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

krylov_bem_solver

the old Krylov solver only allows a single level preconditioning but the new Krylov solver cannot store intermediate results to restart after the process has been terminated externally (time limit on server, blackout,…)

krylov_bem_solver_new

the Krylov charge density solver is a solver using Krylov subspace methods to solve the linear charge densities equation.

krylov_bem_solver_old

the old Krylov solver only allows a single level preconditioning but the new Krylov solver cannot store intermediate results to restart after the process has been terminated externally (time limit on server, blackout,…)

krylov_charge_density_solver

the Krylov charge density solver is a solver using Krylov subspace methods to solve the linear charge densities equation.

krylov_charge_density_solver_old

the old Krylov solver only allows a single level preconditioning but the new Krylov solver cannot store intermediate results to restart after the process has been terminated externally (time limit on server, blackout,…)

robin_hood_bem_solver

the robin hood charge density solver is an iterative linear equation solver.

robin_hood_charge_density_solver

the robin hood charge density solver is an iterative linear equation solver.

timer

display the times for charge density solving and field solver initialization.

viewer

the viewer opens a window and displays the geometry.

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. No directory should default to the KEMField cache.

file

string

name of file in which to cache computation.

hash_masked_bits

unsigned int

this value is passed to the charge density solver to configure the retrival mechanism for precomputed solutions of the charge density solver. You should not have to use this option.

hash_threshold

double

this value is passed to the charge density solver to configure the retrival mechanism for precomputed solutions of the charge density solver. You should not have to use this option.

maximum_element_aspect_ratio

double

elements with an aspect ratio above this value are ignored in the electric field computation. The aspect ratio of a triangle is the ratio of the longest side over the corresponding height. The aspect ratio of a rectangle is the ratio of the longer side over the shorter side. The aspect ratio of a wire is the length divided by the diameter.

minimum_element_area

double

elements of the geometry with an area below this value are ignored in the electric field computation

name

string

the name of the electric field.

spaces

string

Refers to KGeoBag spaces (path in the geometry).

surfaces

string

paths to KGeoBag surfaces which are equipped with both a discretization and electromagnetic properties. Surfaces not fulfilling both criteria are ignored.

Refers to KGeoBag surfaces (path in the geometry).

symmetry

string

may be none, axial or discrete_axial, which constrains methods that may be used in computation. The symmetry is always defined along the z-axis.

Values: none, axial, discrete_axial.

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:

<electrostatic_field
    name="field_electrostatic"
    directory="."
    file="Electrodes.kbd"
    system="assembly"
    surfaces="assembly/@electrode_tag"
    symmetry="axial"
    hash_masked_bits="0"
    hash_threshold="1e5"
    minimum_element_area="1e-3"
    maximum_element_aspect_ratio="1e100"
>
    <gaussian_elimination_charge_density_solver/>
    <integrating_field_solver/>
</electrostatic_field>

Used as:

Can be referenced by:

More information

Appears in the documentation:

Used in example configurations: