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

Mock process. More...

#include <MockProcess.hh>

Inheritance diagram for celeritas::test::MockProcess:
Inheritance graph
[legend]

Classes

struct  Input
 

Public Types

Type aliases
using BarnMicroXs = RealQuantity< units::Barn >
 
using VecApplicability = std::vector< Applicability >
 
using VecMicroXs = std::vector< BarnMicroXs >
 
using SPConstMaterials = std::shared_ptr< MaterialParams const >
 
using ModelCallback = std::function< void(ActionId)>
 
- Public Types inherited from celeritas::Process
using SPConstModel = std::shared_ptr< Model const >
 
using VecModel = std::vector< SPConstModel >
 
using ActionIdIter = RangeIter< ActionId >
 
using XsGrid = inp::XsGrid
 
using EnergyLossGrid = inp::UniformGrid
 

Public Member Functions

 MockProcess (Input data)
 
VecModel build_models (ActionIdIter start_id) const final
 Construct the models associated with this process.
 
XsGrid macro_xs (Applicability range) const final
 Get the interaction cross sections [l/len] for the given energy range.
 
EnergyLossGrid energy_loss (Applicability range) const final
 Get the energy loss [MeV/len] for the given energy range.
 
bool supports_integral_xs () const final
 Whether the integral method can be used to sample interaction length.
 
bool applies_at_rest () const final
 Whether the process applies when the particle is stopped.
 
std::string_view label () const final
 Name of the process.
 
- Public Member Functions inherited from celeritas::Process
virtual ~Process ()
 Default destructor.
 

Additional Inherited Members

- Protected Member Functions inherited from celeritas::Process
 CELER_DEFAULT_COPY_MOVE (Process)
 

Detailed Description

Mock process.

Multiple instances of this process can be created to test out the physics. The value grids are all parameterized:

The given applicability vector has one element per model that it will create. Each model can have a different particle type and/or energy range.

Member Function Documentation

◆ applies_at_rest()

bool celeritas::test::MockProcess::applies_at_rest ( ) const
finalvirtual

Whether the process applies when the particle is stopped.

Implements celeritas::Process.

◆ build_models()

auto celeritas::test::MockProcess::build_models ( ActionIdIter  start_id) const
finalvirtual

Construct the models associated with this process.

Implements celeritas::Process.

◆ energy_loss()

auto celeritas::test::MockProcess::energy_loss ( Applicability  range) const
finalvirtual

Get the energy loss [MeV/len] for the given energy range.

Implements celeritas::Process.

◆ label()

std::string_view celeritas::test::MockProcess::label ( ) const
finalvirtual

Name of the process.

Implements celeritas::Process.

◆ macro_xs()

auto celeritas::test::MockProcess::macro_xs ( Applicability  range) const
finalvirtual

Get the interaction cross sections [l/len] for the given energy range.

Implements celeritas::Process.

◆ supports_integral_xs()

bool celeritas::test::MockProcess::supports_integral_xs ( ) const
finalvirtual

Whether the integral method can be used to sample interaction length.

Implements celeritas::Process.


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