Simulation (Kassiopeia)

This page documents the <kassiopeia> section of the configuration. Each child element links to its own page, which in turn lists what can go into it.

XML element: <kassiopeia>
C++ type: KSRoot
Defined in: KSRootBuilder.h:19
Child elements

Element

Description

kess_elastic_elsepa

kess_inelastic_bethefano

kess_inelastic_penn

kess_surface_interaction

ks_command_member

command object encapsulating a request to combine or change simulation objects.

ks_component_delta

ks_component_group

a set of components treated as a single composite.

ks_component_integral

an integral of a component over some set of simulation events.

ks_component_math

ks_component_maximum

the maximum value attained by a component over some set of simulation events.

ks_component_maximum_at

the value of a component where a source component attains a maximum value over some set of simulation events.

ks_component_member

component object encapsulating the extraction of a component from within a composite.

ks_component_minimum

the minimum value attained by a component over some set of simulation events.

ks_component_minimum_at

the value of a component where a source component attains a minimum value over some set of simulation events.

ks_root_electric_field

ks_root_event_modifier

ks_root_generator

ks_root_magnetic_field

ks_root_run_modifier

ks_root_space_interaction

ks_root_space_navigator

ks_root_step_modifier

ks_root_surface_interaction

ks_root_surface_navigator

ks_root_terminator

ks_root_track_modifier

ks_root_trajectory

ks_root_writer

ks_simulation

The final object to be declared within <kassiopeia> is the simulation element.

ksfield_electric_constant

Deprecated: define fields in the <kemfield> section instead (legacy alias)

provides a constant, uniform electric field.

ksfield_electric_induced_azi

Deprecated: define fields in the <kemfield> section instead (legacy alias)

this rather specialized electric field computes the induced electric field from the changes of the z-component of a ramped magnetic field.

ksfield_electric_potentialmap

Deprecated: define fields in the <kemfield> section instead (legacy alias)

electric field interpolated from a precomputed potentialmap

ksfield_electric_potentialmap_calculator

Deprecated: define fields in the <kemfield> section instead (legacy alias)

Creates a potential map stored in the .vti image format.

ksfield_electric_quadrupole

Deprecated: define fields in the <kemfield> section instead (legacy alias)

provides a perfect quadrupole electric field.

ksfield_electric_ramped

Deprecated: define fields in the <kemfield> section instead (legacy alias)

takes an electric field and modulates it with the time according to the selected profile.

ksfield_electric_ramped_2fields

Deprecated: define fields in the <kemfield> section instead (legacy alias)

as an extension to the ramped electric field this field accepts to field.

ksfield_electromagnet

Deprecated: define fields in the <kemfield> section instead (legacy alias)

provides a magnetic field arising from current-bearing elements computed with kemfield as initialized with kgeobag.

ksfield_electrostatic

Deprecated: define fields in the <kemfield> section instead (legacy alias)

provides an electric field arising from disctretized elements computed with kemfield as initialized with kgeobag.

ksfield_magnetic_constant

Deprecated: define fields in the <kemfield> section instead (legacy alias)

provides a constant, uniform magnetic field.

ksfield_magnetic_dipole

Deprecated: define fields in the <kemfield> section instead (legacy alias)

provides a perfect dipole magnetic field.

ksfield_magnetic_fieldmap

Deprecated: define fields in the <kemfield> section instead (legacy alias)

ksfield_magnetic_fieldmap_calculator

Deprecated: define fields in the <kemfield> section instead (legacy alias)

ksfield_magnetic_ramped

Deprecated: define fields in the <kemfield> section instead (legacy alias)

takes an magnetic field and modulates it with the time according to the selected profile.

ksfield_magnetic_super_position

Deprecated: define fields in the <kemfield> section instead (legacy alias)

combine an unlimited number of magnetic fields to a superposition field acting like a single magnetic field

ksgen_direction_spherical_composite

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

ksgen_direction_spherical_magnetic_field

ksgen_direction_surface_composite

ksgen_energy_beta_decay

ksgen_energy_beta_recoil

ksgen_energy_composite

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

ksgen_energy_krypton_event

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

ksgen_energy_lead_event

ksgen_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.

ksgen_energy_rydberg

ksgen_generator_composite

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

ksgen_generator_file

ksgen_generator_simulation

ksgen_l_composite

ksgen_l_statistical

ksgen_l_uniform_max_n

ksgen_momentum_rectangular_composite

ksgen_n_composite

ksgen_position_cylindrical_composite

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

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

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

ksgen_position_space_random

ksgen_position_spherical_composite

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

ksgen_position_surface_adjustment_step

ksgen_position_surface_random

ksgen_spin_composite

ksgen_spin_composite_relative

ksgen_time_composite

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

ksgen_value_angle_cosine

ksgen_value_angle_spherical

generates a single random value drawn from a distribution suitable for randomly distributing polar angles in cylindrical coordinates.

ksgen_value_boltzmann

ksgen_value_fermi

ksgen_value_fix

generates a single fixed value.

ksgen_value_formula

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

ksgen_value_gauss

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

ksgen_value_generalized_gauss

ksgen_value_histogram

generates a single random value drawn from a ROOT histogram.

ksgen_value_list

ksgen_value_pareto

ksgen_value_radius_cylindrical

generates a single random value drawn from a distribution suitable for randomly distributing radii in cylindrical coordinates.

ksgen_value_radius_fraction

ksgen_value_radius_spherical

generates a single random value drawn from a distribution suitable for randomly distributing radii in spherical coordinates.

ksgen_value_set

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

ksgen_value_uniform

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

ksgen_value_z_frustrum

ksgeo_side

a very lightweight wrapper around a kgeobag surface which bounds a space.

ksgeo_space

a very lightweight wrapper around a kgeobag space.

ksgeo_surface

a very lightweight wrapper around a kgeobag surface.

ksint_calculator_constant

this calculator returns a constant cross section and scatters isotropically.

ksint_calculator_ion

ksint_calculator_mott

the Mott scattering calculator.

ksint_decay

ksint_decay_calculator_death_const_rate

ksint_decay_calculator_ferenc_bbr_transition

ksint_decay_calculator_ferenc_ionisation

ksint_decay_calculator_ferenc_spontaneous

ksint_decay_calculator_glukhov_deexcitation

ksint_decay_calculator_glukhov_excitation

ksint_decay_calculator_glukhov_ionisation

ksint_decay_calculator_glukhov_spontaneous

ksint_density_constant

this density returns a constant value computed from the ideal gas law.

ksint_scattering

the main scattering interaction for kassiopeia.

ksint_spin_flip

ksint_spin_flip_pulse

ksint_spin_rotate_y_pulse

ksint_surface_UCN

ksint_surface_diffuse

ksint_surface_multiplication

ksint_surface_specular

ksint_surface_spin_flip

ksmod_dynamic_enhancement

ksmod_event_report

ksmod_split_on_turn

ksnav_meshed_space

A more complex behavior is achieved by the ksnav_meshed_space navigator, which is intended to be used in highly detailed three-dimensional geometries where it has better performance over the default navigator.

ksnav_space

this is the principal space navigator within kassiopeia.

ksnav_surface

this is the principal surface navigator within kassiopeia.

ksterm_death

this terminator kills everything it sees.

ksterm_magnetron

this terminator kills particles after completing a certain azimuthal portion of a magnetron period

ksterm_max_energy

this terminator kills particles whose kinetic energy rises above a given value.

ksterm_max_length

this terminator kills particles whose track length rises above a given value.

ksterm_max_long_energy

this terminator kills particles whose longitudinal kinetic energy rises above a given value.

ksterm_max_r

this terminator kills particles whose position’s radial coordinate rises above a given value.

ksterm_max_step_time

ksterm_max_steps

this terminator kills particles whose track’s step count rises above a given value.

ksterm_max_time

this terminator kills particles whose track time rises above a given value.

ksterm_max_total_time

ksterm_max_z

this terminator kills particles whose position’s z coordinate rises above a given value.

ksterm_min_distance

ksterm_min_energy

this terminator kills particles whose kinetic energy falls below a given value.

ksterm_min_long_energy

this terminator kills particles whose longitudinal kinetic energy falls below a given value.

ksterm_min_r

this terminator kills particles whose position’s radial coordinate falls below a given value.

ksterm_min_z

this terminator kills particles whose position’s z coordinate falls below a given value.

ksterm_output

this terminator kills particles depending on a specific output value.

ksterm_secondaries

this terminator immediately kills secondary particles created during tracking.

ksterm_stepsize

ksterm_trapped

this terminator kills particles whose longitudinal momentum changes sign more than a given number of times.

ksterm_zh_radius

kstraj_control_B_change

kstraj_control_cyclotron

this control suggests a temporal step which is a fraction of the instantaneous cyclotron period.

kstraj_control_energy

this control suggests a temporal step based on conservation of total energy over a step.

kstraj_control_length

this control suggests a temporal step which would result in a step with the given length were the particle to remain at constant speed.

kstraj_control_m_dot

kstraj_control_magnetic_moment

kstraj_control_momentum_numerical_error

kstraj_control_position_numerical_error

kstraj_control_spin_precession

kstraj_control_time

this control suggests a constant temporal step.

kstraj_integrator_rk54

an 5th/4th order embedded runge-kutta integrator.

kstraj_integrator_rk65

an 6th/5th order embedded runge-kutta integrator.

kstraj_integrator_rk8

an 8th order runge-kutta integrator.

kstraj_integrator_rk86

an 8th/6th order embedded runge-kutta integrator.

kstraj_integrator_rk87

an 8th/7th order embedded runge-kutta integrator.

kstraj_integrator_rkdp54

kstraj_integrator_rkdp853

kstraj_integrator_sym4

kstraj_interpolator_crk

kstraj_interpolator_fast

this interpolator uses a linear interpolation internally.

kstraj_interpolator_hermite

kstraj_term_constant_force_propagation

kstraj_term_drift

this term in the equation of motion adds e-cross-b and grad-b drifts to adiabatic simulations.

kstraj_term_gravity

kstraj_term_gyration

this term in the equation of motion adds cyclotron gyrations to adiabatic simulations.

kstraj_term_propagation

this term in the equation of motion moves the particle in external electromagnetic fields.

kstraj_term_synchrotron

this term in the equation of motion bleeds off energy from the particle due to radiative effects.

kstraj_trajectory_adiabatic

this trajectory internally uses an adiabatic representation of the particle.

kstraj_trajectory_adiabatic_spin

kstraj_trajectory_electric

kstraj_trajectory_exact

this trajectory internally uses the exact representation of the particle.

kstraj_trajectory_exact_spin

kstraj_trajectory_exact_trapped

kstraj_trajectory_linear

this trajectory moves the particle forward at constant speed along the direction of its momentum.

kstraj_trajectory_magnetic

this trajectory internally uses a magnetic representation of the particle.

kswrite_ascii

kswrite_root

a writer that makes ROOT files containing results of simulations.

kswrite_root_condition_output

a write condition for the root writer the decision to write or not to write is based on an output variable

kswrite_root_condition_periodic

kswrite_root_condition_step

a write condition for the root writer to reduce output file size while keeping tracking precision only every nth_step (int!) the root writer records a step

kswrite_root_condition_terminator

kswrite_vtk

a writer that makes VTK polydata files containing results of simulations.

output

component object encapsulating the extraction of a component from within a composite.

output_delta

output_group

a set of components treated as a single composite.

output_integral

an integral of a component over some set of simulation events.

output_math

output_maximum

the maximum value attained by a component over some set of simulation events.

output_maximum_at

the value of a component where a source component attains a maximum value over some set of simulation events.

output_minimum

the minimum value attained by a component over some set of simulation events.

output_minimum_at

the value of a component where a source component attains a minimum value over some set of simulation events.

Attributes

Attribute

Type

Description

random_seed

unsigned int

Used as:

  • <kassiopeia> at the top level

  • <kassiopeia> in <kasper>

More information

Appears in the documentation:

Used in example configurations: