ksgen_generator_composite

creates initial particle states according to the policies supplied for generating their positions, directions, energies, and times.

XML element: <ksgen_generator_composite>
C++ type: KSGenGeneratorComposite
Also available as: decay_product_generator
Child elements

Element

Description

direction_spherical_composite

creates the direction of a generated particle according to the value objects supplied, interpreting them to be spherical coordinates.

direction_spherical_magnetic_field

direction_surface_composite

energy_beta_decay

energy_beta_recoil

energy_composite

creates the kinetic energy of a generated particle according to the value objects supplied.

energy_krypton_event

creates the kinetic energies of a set of particles originating from the beta decay of 83Kr.

energy_lead_event

energy_radon_event

creates the kinetic energies of a set of particles originating from the alpha decay of Rn followed by the beta decay of Po.

energy_rydberg

l_composite

l_statistical

l_uniform_max_n

momentum_rectangular_composite

n_composite

pid_fix

generates a single fixed value.

pid_formula

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

pid_gauss

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

pid_histogram

generates a single random value drawn from a ROOT histogram.

pid_list

pid_pareto

pid_set

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

pid_uniform

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

position_cylindrical_composite

creates the position of a generated particle according to the value objects supplied, interpreting them to be cylindrical coordinates.

position_flux_tube

position_frustrum_composite

position_homogeneous_flux_tube

position_mask

position_mesh_surface_random

position_rectangular_composite

creates the position of a generated particle according to the value objects supplied, interpreting them in rectangular coordinates.

position_space_random

position_spherical_composite

creates the position of a generated particle according to the value objects supplied, interpreting them to be spherical coordinates.

position_surface_adjustment_step

position_surface_random

spin_composite

spin_relative_composite

time_composite

creates the time of a generated particle according to the value objects supplied.

Attributes

Attribute

Type

Description

creator

string

Refers to the name of one of: <ksgen_direction_spherical_composite>, <ksgen_direction_spherical_magnetic_field>, <ksgen_direction_surface_composite>, <ksgen_energy_beta_decay>, <ksgen_energy_beta_recoil>, <ksgen_energy_composite>, <ksgen_energy_krypton_event>, <ksgen_energy_lead_event>, <ksgen_energy_radon_event>, <ksgen_energy_rydberg>, <ksgen_l_composite>, <ksgen_l_statistical>, <ksgen_l_uniform_max_n>, <ksgen_momentum_rectangular_composite>, <ksgen_n_composite>, <ksgen_position_cylindrical_composite>, <ksgen_position_flux_tube>, <ksgen_position_frustrum_composite>, <ksgen_position_homogeneous_flux_tube>, <ksgen_position_mask>, <ksgen_position_mesh_surface_random>, <ksgen_position_rectangular_composite>, <ksgen_position_space_random>, <ksgen_position_spherical_composite>, <ksgen_position_surface_adjustment_step>, <ksgen_position_surface_random>, <ksgen_spin_composite>, <ksgen_spin_composite_relative>, <ksgen_time_composite>.

name

string

the name of this generator.

pid

double

the id of the particle species to generate. 11 is electron.

special

string

Refers to the name of a KSGenSpecial object.

string_id

string

the string id of the particle species to generate. “e-” is for the electron. This is an alternative to using a pid. If both pid and string_id are used, pid overrides string_id. Only one should be used, to avoid confusion.

Example:

<ksgen_generator_composite name="generator_composite" pid="11">
    <energy_composite>
        <energy_fix value="1000."/>
    </energy_composite>
    <position_cylindrical_composite>
        <r_fix value="3.e-4"/>
        <phi_fix value="0."/>
        <z_fix value="-1.e-3"/>
    </position_cylindrical_composite>
    <direction_spherical_composite>
        <theta_fix value="90."/>
        <phi_fix value="0."/>
    </direction_spherical_composite>
    <time_composite>
        <time_fix value="0."/>
    </time_composite>
</ksgen_generator_composite>

Used as:

Can be referenced by:

More information

Appears in the documentation:

Used in example configurations: