celeritas::test::MockModel Class Reference

Mock model. More...

#include <MockModel.hh>

Inheritance diagram for celeritas::test::MockModel:

Classes
struct	Input

Public Types
Type aliases
using	BarnMicroXs = RealQuantity< units::Barn >
using	ModelCallback = std::function< void(ActionId)>
using	VecMicroXs = std::vector< BarnMicroXs >
using	SPConstMaterials = std::shared_ptr< MaterialParams const >
Public Types inherited from celeritas::Model
using	XsTable = std::vector< inp::UniformGrid >
	Type aliases.
using	SetApplicability = std::set< Applicability >
Public Types inherited from celeritas::ActionTypeTraits< P, S >
using	CoreParams = P
using	CoreStateHost = S< MemSpace::host >
using	CoreStateDevice = S< MemSpace::device >
using	SpanCoreStateHost = Span< S< MemSpace::host > *const >
using	SpanCoreStateDevice = Span< S< MemSpace::device > *const >

Public Member Functions
	MockModel (Input data)
SetApplicability	applicability () const final
	Get the applicable particle type and energy ranges of the model.
XsTable	micro_xs (Applicability range) const final
	Get the microscopic cross sections for the given particle and material.
void	step (CoreParams const &, CoreStateHost &) const final
void	step (CoreParams const &, CoreStateDevice &) const final
ActionId	action_id () const final
	ID of this action for verification and ordering.
std::string_view	label () const final
	Short unique label of the action.
std::string_view	description () const final
	Description of the action.
Public Member Functions inherited from celeritas::Model
StepActionOrder	order () const final
	Dependency ordering of the action.
Public Member Functions inherited from celeritas::StepActionInterface< P, S >
virtual void	step (P const &, S< MemSpace::host > &) const =0
	Execute the action with host data.
virtual void	step (P const &, S< MemSpace::device > &) const =0
	Execute the action with device data.
Public Member Functions inherited from celeritas::ActionInterface
virtual	~ActionInterface () noexcept=0
	Default destructor.

Additional Inherited Members
Protected Member Functions inherited from celeritas::ActionInterface
	CELER_DEFAULT_COPY_MOVE (ActionInterface)

Detailed Description

Mock model.

The model is applicable to a single particle type and energy range. Its "interact" simply calls a test-code-provided callback with the model ID.

Member Function Documentation

action_id()

ActionId celeritas::test::MockModel::action_id ( ) const

inlinefinalvirtual

ID of this action for verification and ordering.

Implements celeritas::ActionInterface.

applicability()

auto celeritas::test::MockModel::applicability ( ) const

finalvirtual

Get the applicable particle type and energy ranges of the model.

Implements celeritas::Model.

description()

std::string_view celeritas::test::MockModel::description ( ) const

inlinefinalvirtual

Description of the action.

Implements celeritas::ActionInterface.

label()

std::string_view celeritas::test::MockModel::label ( ) const

inlinefinalvirtual

Short unique label of the action.

Implements celeritas::ActionInterface.

micro_xs()

auto celeritas::test::MockModel::micro_xs ( Applicability  range ) const

finalvirtual

Get the microscopic cross sections for the given particle and material.

Implements celeritas::Model.

---

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

• MockModel.hh
• MockModel.cc