ksgen_position_flux_tube

XML element: <ksgen_position_flux_tube>
C++ type: KSGenPositionFluxTube
Also available as: position_flux_tube
Child elements

Element

Description

phi_fix

generates a single fixed value.

phi_gauss

generates a single random value drawn from a portion of a gaussian distribution.

phi_set

generates a set of constant values evenly spaced along an interval inclusive of the beginning and end points.

phi_uniform

generates a single random value drawn from a portion of a uniform distribution.

r_formula

generates a single random value drawn from a portion of a user-defined distribution.

z_fix

generates a single fixed value.

z_formula

generates a single random value drawn from a portion of a user-defined distribution.

z_gauss

generates a single random value drawn from a portion of a gaussian distribution.

z_set

generates a set of constant values evenly spaced along an interval inclusive of the beginning and end points.

z_uniform

generates a single random value drawn from a portion of a uniform distribution.

Attributes

Attribute

Type

Description

flux

double

magnetic_field_name

string

n_integration_step

int

name

string

only_surface

bool

phi

string

Refers to the name of one of: <ksgen_value_angle_cosine>, <ksgen_value_angle_spherical>, <ksgen_value_boltzmann>, <ksgen_value_fermi>, <ksgen_value_fix>, <ksgen_value_formula>, <ksgen_value_gauss>, <ksgen_value_generalized_gauss>, <ksgen_value_histogram>, <ksgen_value_list>, <ksgen_value_pareto>, <ksgen_value_radius_cylindrical>, <ksgen_value_radius_fraction>, <ksgen_value_radius_spherical>, <ksgen_value_set>, <ksgen_value_uniform>, <ksgen_value_z_frustrum>.

space

string

Refers to a KGeoBag space (path in the geometry).

surface

string

Refers to a KGeoBag surface (path in the geometry).

z

string

Refers to the name of one of: <ksgen_value_angle_cosine>, <ksgen_value_angle_spherical>, <ksgen_value_boltzmann>, <ksgen_value_fermi>, <ksgen_value_fix>, <ksgen_value_formula>, <ksgen_value_gauss>, <ksgen_value_generalized_gauss>, <ksgen_value_histogram>, <ksgen_value_list>, <ksgen_value_pareto>, <ksgen_value_radius_cylindrical>, <ksgen_value_radius_fraction>, <ksgen_value_radius_spherical>, <ksgen_value_set>, <ksgen_value_uniform>, <ksgen_value_z_frustrum>.

Used as:

Can be referenced by: