zonal_harmonic_field_solver (in electromagnet_field)

uses the zonal harmonic expansion about an axis to compute fields. only valid if the symmetry parameter is set to axial.

XML element: <zonal_harmonic_field_solver>
C++ type: KZonalHarmonicMagnetostaticFieldSolver
Attributes

Attribute

Type

Description

central_sourcepoint_end

double

ending z value for the central set of source points.

central_sourcepoint_fractional_distance

double

central_sourcepoint_spacing

double

in all cases the spacing in meters between central source points will be at least this.

central_sourcepoint_start

double

starting z value for the central set of source points.

coaxiality_tolerance

double

convergence_parameter

double

the series is declared converged when the sum of latest five terms divided by the entire sum is less than this ratio.

convergence_ratio

double

an expansion will not be attempted when the distance from the field point to the nearest source point divided by that source point’s convergence radius exceeds this ratio.

number_of_bifurcations

int

controls the number of times the surface container is recursively split. each split at each level results in an independent zonal harmonic expansion.

number_of_central_coefficients

int

the number of central coefficients to store per source point.

number_of_remote_coefficients

int

the number of remote coefficients to store per source point.

number_of_remote_sourcepoints

int

proximity_to_sourcepoint

double

an expansion will include a single term with no convergence check when the distance from the field point to the nearest source point divided by that source point’s convergence radius is less than this ratio.

remote_sourcepoint_end

double

ending z value for the remote set of source points.

remote_sourcepoint_start

double

starting z value for the remote set of source points.

use_fixed_sourcepoint_range

bool

use_fractional_central_sourcepoint_spacing

bool

if true, the distance from one source point to the next will be computed using a fraction of the previous source point’s convergence radius.

Example:

<zonal_harmonic_field_solver
    number_of_bifurcations="-1"
    convergence_ratio=".99"
    convergence_parameter="1.e-15"
    proximity_to_sourcepoint="1.e-12"
    number_of_central_coefficients="500"
    use_fractional_central_sourcepoint_spacing="false"
    central_sourcepoint_spacing="2.e-6"
    central_sourcepoint_start="-3.3e-3"
    central_sourcepoint_end="3.3e-3"
    number_of_remote_coefficients="200"
    remote_sourcepoint_start="-1.e-1"
    remote_sourcepoint_end="1.e-1"
/>

Used as:

More information

Appears in the documentation:

Used in example configurations: