celeritas::optical::WavelengthShiftModel Class Reference

Set up and launch the optical WLS model interaction. More...

#include <WavelengthShiftModel.hh>

Inheritance diagram for celeritas::optical::WavelengthShiftModel:

Classes
struct	Input
	Material-dependent WLS data, indexed by OptMatId. More...

Public Types
Type aliases
using	SPConstImported = std::shared_ptr< ImportedModels const >
using	HostRef = HostCRef< WavelengthShiftData >
using	DeviceRef = DeviceCRef< WavelengthShiftData >
Public Types inherited from celeritas::optical::Model
using	ModelBuilder = std::function< std::shared_ptr< Model >(ActionId)>
	Function to build optical models with a given action id.
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
	WavelengthShiftModel (ActionId, SPConstImported, Input)
	Construct the model from imported data and imported material parameters.
void	build_mfps (OptMatId, MfpBuilder &) const final
	Build the mean free paths for the model.
void	step (CoreParams const &, CoreStateHost &) const final
	Execute the model on the host.
void	step (CoreParams const &, CoreStateDevice &) const final
	Execute the model on the device.
HostRef const &	host_ref () const
	Access data on the host.
DeviceRef const &	device_ref () const
	Access data on the device.
Public Member Functions inherited from celeritas::optical::Model
StepActionOrder	order () const override
	Action order for optical models is always post-step.
	ConcreteAction (ActionId id, std::string label) noexcept(!CELERITAS_DEBUG)
	Construct a concrete action from a label and ID.
	ConcreteAction (ActionId id, std::string label, std::string description) noexcept(!CELERITAS_DEBUG)
	Construct a concrete action from an ID, a unique label, and a description.
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.
Public Member Functions inherited from celeritas::ConcreteAction
	ConcreteAction (ActionId id, std::string label) noexcept(!CELERITAS_DEBUG)
	Construct a concrete action from a label and ID.
	ConcreteAction (ActionId id, std::string label, std::string description) noexcept(!CELERITAS_DEBUG)
	Construct a concrete action from an ID, a unique label, and a description.
	~ConcreteAction () noexcept override
	Default destructor.
	CELER_DELETE_COPY_MOVE (ConcreteAction)
ActionId	action_id () const final
	ID of this action for verification.
std::string_view	label () const final
	Short label.
std::string_view	description () const final
	Descriptive label.

Static Public Member Functions
static ModelBuilder	make_builder (SPConstImported, Input)
	Create a model builder from imported data.

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

Detailed Description

Set up and launch the optical WLS model interaction.

Member Function Documentation

build_mfps()

void celeritas::optical::WavelengthShiftModel::build_mfps ( OptMatId  mat, MfpBuilder &  build  ) const

finalvirtual

Build the mean free paths for the model.

Implements celeritas::optical::Model.

step()

void celeritas::optical::WavelengthShiftModel::step ( CoreParams const &  params, CoreStateDevice &  state  ) const

final

Execute the model on the device.

Interact with device data.

---

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

• WavelengthShiftModel.hh
• WavelengthShiftModel.cc
• WavelengthShiftModel.cu