Celeritas  0.5.0-56+6b053cd
Public Types | Public Member Functions | Public Attributes | List of all members
celeritas::Applicability Struct Reference

Range where a model and/or process is valid. More...

#include <Applicability.hh>

Public Types

using EnergyUnits = units::Mev
 
using Energy = Quantity< EnergyUnits >
 

Public Member Functions

 operator bool () const
 Whether applicability is in a valid state.
 

Public Attributes

MaterialId material {}
 
ParticleId particle {}
 
Energy lower = zero_quantity()
 
Energy upper = max_quantity()
 

Detailed Description

Range where a model and/or process is valid.

This class is used during setup for specifying the ranges of applicability for a physics model or process. The interval is closed on the lower energy range and open on the upper energy. So a threshold reaction should have the lower energy set to the threshold.

An unset value for "material" means it applies to all materials; however, the particle ID should always be set.


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