Celeritas 0.6.0-47+develop.b3cbb238
Loading...
Searching...
No Matches
Public Member Functions | List of all members
celeritas::CherenkovOffload Class Reference

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

#include <CherenkovOffload.hh>

Public Member Functions

CELER_FUNCTION CherenkovOffload (ParticleTrackView const &particle, SimTrackView const &sim, optical::MaterialView const &mat, Real3 const &pos, NativeCRef< CherenkovData > const &shared, OffloadPreStepData const &step_data)
 Construct with optical material, Cherenkov, and step information.
 
template<class Generator >
CELER_FUNCTION GeneratorDistributionData operator() (Generator &rng)
 Collect the distribution data needed to sample Cherenkov photons.
 

Detailed Description

Sample the number of Cherenkov photons to be generated.

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

The number of photons is sampled from a Poisson distribution with a mean

\[ \langle n \rangle = \ell_\text{step} \difd{N}{x} \]

where \( \ell_\text{step} \) is the step length.

Member Function Documentation

◆ operator()()

template<class Generator >
CELER_FUNCTION GeneratorDistributionData celeritas::CherenkovOffload::operator() ( Generator rng)
inline

Collect the distribution data needed to sample Cherenkov photons.

If no photons are sampled an empty object is returned.


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