celeritas::CutoffView Class Reference

Access invariant material- and particle-dependent cutoff values. More...

#include <CutoffView.hh>

Public Types
Type aliases
using	CutoffId = OpaqueId< ParticleCutoff >
using	CutoffData = NativeCRef< CutoffParamsData >
using	Energy = units::MevEnergy

Public Member Functions
CELER_FUNCTION	CutoffView (CutoffData const &params, MaterialId material)
	Construct view from host/device for the given material id.
CELER_FUNCTION Energy	energy (ParticleId particle) const
	Return energy cutoff value.
CELER_FUNCTION real_type	range (ParticleId particle) const
	Return range cutoff value.
CELER_FUNCTION bool	apply_post_interaction () const
	Whether to kill secondaries below the production cut post-interaction.
CELER_FUNCTION bool	apply (Secondary const &) const
	Whether the post-interaction cutoff should be applied to the secondary. More...

Detailed Description

Access invariant material- and particle-dependent cutoff values.

CutoffParamsData is defined in CutoffData.hh and constructed by CutoffParams .

CutoffParams cutoffs(input);
CutoffView cutoff_view(cutoffs.host_ref(), material_id);
cutoff_view.energy(particle_id);
cutoff_view.range(particle_id);

Member Function Documentation

apply()

CELER_FUNCTION bool celeritas::CutoffView::apply ( Secondary const &  secondary ) const

inline

Whether the post-interaction cutoff should be applied to the secondary.

This will be true if the apply_post_interaction option is enabled and the seccondary is an electron, positron, or gamma with energy below the production cut.

---

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

• CutoffView.hh