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. It then transforms these (among other things using the fast Fourier transformation) into local expansions describing the influence of sources far enough away on the electric field and potential inside the cube. These expansions are stored inside a tree structure describing the different cubes. This is the initialization procedure.

After initialization the field and potential is evaluated at a point by computing the corresponding expansion and adding the directly determined contribution of nearby source elements.

XML element: <fast_multipole_field_solver>
C++ type: KElectricFastMultipoleFieldSolver
Child elements

Element

Description

viewer

Attributes

Attribute

Type

Description

expansion_degree

unsigned int

the maximum degree of the multipole and local expansions used in the algorithm for precise results values in the range of 10 to 13 are recommended combined with a zero_mask size of 3. The example uses smaller values to speed up the computation to a manageable time for a demonstation.

insertion_ratio

double

elements are accepted by a cube if they are within the smallest ball around the cube multiplied by this factor which should be greater than one (for example 1.3). This allows small elements sitting on the borders of cubes to be accepted by small cubes and limit direct evaluation to a more local region.

maximum_tree_depth

unsigned int

the maximum depth to which cubes are subdivided this restricts the tree size and computation time for the local moments at the cost of more direct evaluations later

neighbor_order

unsigned int

the distance in cubes that neighbors are defined by Cubes being having less than this number of cubes inbetween them in any direction are considered neighbors. Neighbors define the dead zone where the multipole expansion is not valid. Greater numbers like 3 make the algorithm more accurate but slower

region_expansion_factor

double

the factor by which the estimated region for the world cube is expanded in size to compensate for slight errors in the region estimation algorithm and to ensure all source elements are inside the world cube

split_mode

bool

top_level_divisions

unsigned int

the world cube gets divided into this many cubes along each side to create the first level of cubes.

tree_level_divisions

unsigned int

in all but the first subdivision the cubes get divided into this many cubes along each side. Two is the smallest useful value and a very good choice, too.

use_caching

bool

currently without effect

use_opencl

bool

use OpenCl to speed up the initialization process and direct evaluations.

use_region_size_estimation

bool

this boolean option allows the automatic selection of the world cube from the underlying geometry so that all field sources are covered. Use with a region expansion factor (for example 1.1) to compensate for slight errors in the estimate. Try larger ones if elements are missed out.

verbosity

unsigned int

values between 0 and 3 define the amount of output on the console. A value of zero is mostly silent and a value of three gives maximum information.

world_cube_center_x

double

world_cube_center_y

double

world_cube_center_z

double

if the region estimation in not used, the cube center can be defined manually by passing these options the position of the user’s choice

world_cube_length

double

manually set the side length of the world cube

Example:

<fast_multipole_field_solver
    top_level_divisions="4"
    tree_level_divisions="2"
    expansion_degree="5"
    neighbor_order="2"
    maximum_tree_depth="2"
    region_expansion_factor="1.1"
    use_region_size_estimation="true"
    world_cube_center_x="0.1"
    world_cube_center_y="0.1"
    world_cube_center_z="0.1"
    world_cube_length="1.5"
    use_caching="true"
    verbosity="3"
    insertion_ratio="1.33333333333"
    use_opencl="true"
/>

Used as:

More information

Used in example configurations: