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< ScintillationData > const &shared, OffloadPreStepData const &step_data)
	Construct with input parameters.
template<class Generator >
CELER_FUNCTION optical::GeneratorDistributionData	operator() (Generator &rng)
	Collect the distribution data needed to sample scintillation photons.

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:

• for large (n > 10) mean yield, from a Gaussian distribution with a material-dependent spread, or
• for small yields, from a Poisson distribution.

Constructor & Destructor Documentation

ScintillationOffload()

CELER_FUNCTION celeritas::ScintillationOffload::ScintillationOffload ( ParticleTrackView const &  particle, SimTrackView const &  sim, Real3 const &  pos, units::MevEnergy  energy_deposition, NativeCRef< ScintillationData > const &  shared, OffloadPreStepData const &  step_data  )

inline

Construct with input parameters.

Todo:

Implement sampling for particles

Todo:

Use visible energy deposition when Birks law is implemented

Member Function Documentation

operator()()

template<class Generator >

CELER_FUNCTION optical::GeneratorDistributionData celeritas::ScintillationOffload::operator() ( Generator &  rng )

inline

Collect the distribution data needed to sample scintillation photons.

If no photons are sampled an empty object is returned.

---

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

• ScintillationOffload.hh