Celeritas  0.5.0-56+6b053cd
Public Member Functions | List of all members
celeritas::ScintillationOffload Class Reference

Sample the number of scintillation photons to be generated. More...

#include <ScintillationOffload.hh>

Public Member Functions

CELER_FUNCTION ScintillationOffload (ParticleTrackView const &particle, SimTrackView const &sim, Real3 const &pos, units::MevEnergy energy_deposition, NativeCRef< optical::ScintillationData > const &shared, OffloadPreStepData const &step_data)
 Construct with input parameters.
 
template<class Generator >
CELER_FUNCTION optical::GeneratorDistributionData operator() (Generator &rng)
 Return an GeneratorDistributionData object. More...
 

Detailed Description

Sample the number of scintillation photons to be generated.

This populates the GeneratorDistributionData used by the ScintillationGenerator to generate optical photons using post-step and cached pre-step data.

The mean number of photons is a product of the energy deposition and a material-dependent yield fraction (photons per MeV). The actual number of photons sampled is determined by sampling:

Member Function Documentation

◆ operator()()

template<class Generator >
CELER_FUNCTION optical::GeneratorDistributionData celeritas::ScintillationOffload::operator() ( Generator &  rng)
inline

Return an GeneratorDistributionData object.

If no photons are sampled, an empty object is returned and can be verified via its own operator bool.


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