celeritas::optical::GeneratorDistributionData Struct Reference

Input data for sampling optical photons. More...

#include <GeneratorData.hh>

Public Member Functions
	operator bool () const
	Check whether the data are assigned.

Public Attributes
GeneratorType	type {GeneratorType::size_}
	Cherenkov or scintillation.
size_type	num_photons {}
	Sampled number of photons to generate.
PrimaryId	primary
	For correlating to G4 tracks.
real_type	step_length {}
units::ElementaryCharge	charge
OptMatId	material
real_type	continuous_edep_fraction {}
ScintComponentId	component_id
EnumArray< StepPoint, GeneratorStepData >	points

Friends
std::ostream &	operator<< (std::ostream &os, GeneratorDistributionData const &)

Detailed Description

Input data for sampling optical photons.

This contains all the data needed to sample optical photons directly generated by tracks in the main stepping loop.

continuous_edep_fraction is the ratio of the energy deposited along the step to the total energy deposition over the step (including the local deposition at the discrete interaction point).

component_id optionally specifies the component for the scintillation emission. If it is provided, all photons will be generated from this component; otherwise, the component will be sampled using the yield.

If the material is not provided, it will be determined during initialization.

---

The documentation for this struct was generated from the following file:

• GeneratorData.hh