robin_hood_bem_solver

the robin hood charge density solver is an iterative linear equation solver. It redistributes the charges, so that the equation of the row where the worst error is detected is satisfied. It is a Gauss-Seidel variant.

XML element: <robin_hood_bem_solver>
C++ type: KRobinHoodChargeDensitySolver
Also available as: robin_hood_charge_density_solver
Attributes

Attribute

Type

Description

cache_matrix_elements

bool

boolean arguement to store the computed matrix elements of the boundary element matrix. This potentially speeds the computation up as elements don’t have to be recomputed but it is only possible if enough RAM is available to store all matrix elements. The storage size scales with n^2, where n is the number of discretized boundary elements.

check_sub_interval

unsigned int

the algorithm will iterate this many lines of the matrix before checking for convergence and allowing visitors to run. Defaults to the dimension of the boundary element matrix.

display_interval

unsigned int

specify how often the state of the iteration with number of iterations and residual is displayed. While the value is integer it will display every check_sub_interval except for the case that the value is 0. It defaults to 0.

integrator

string

Values: numeric, analytic, rwg, reference, default.

plot_interval

unsigned int

display the convergence curve of the residuum in a graph While the value is integer it will display every check_sub_interval except for the case that the value is 0. It defaults to 0.

split_mode

bool

tolerance

double

specify the desired reduction of the start residual to define convergence. This defaults to 1e-8, meaning that the algorithm will stop when the norm of the residual has fallen to 1e-8 times its value in the first iteration (the norm of the vector describing the desired potential distribution).

use_opencl

bool

speed up the computation by using OpenCL, only when compiled with OpenCL and an available parallel device (i.e graphics card).

use_vtk

bool

this option has to be true for the plot_interval parameter to create a graph showing the convergence

write_interval

unsigned int

specify how often the state of the iteration is saved. It allows to recover the iteration from this state if the job has been interrupted. While the value is integer it will display every check_sub_interval except for the case that the value is 0. It defaults to 0.

Example:

<robin_hood_charge_density_solver
    tolerance="1e-8"
    check_sub_interval="100"
    display_interval="1"
    write_interval="0"
    plot_interval="1"
    cache_matrix_elements="true"
    use_opencl="true"
    use_vtk="true"

/>

Used as:

More information

Appears in the documentation:

Used in example configurations: