celeritas::optical::RayleighModel Class Reference

Set up and launch the optical Rayleigh scattering model interaction. More...

#include <RayleighModel.hh>

Inheritance diagram for celeritas::optical::RayleighModel:

Public Types
Type aliases
using	SPConstImported = std::shared_ptr< ImportedModels const >
using	SPConstMaterials = std::shared_ptr< MaterialParams const >
using	SPConstCoreMaterials = std::shared_ptr<::celeritas::MaterialParams const >
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
	RayleighModel (ActionId id, SPConstImported imported)
	Construct the model from imported data.
	RayleighModel (ActionId id, SPConstImported imported, SPConstMaterials materials, SPConstCoreMaterials core_materials, std::vector< ImportOpticalRayleigh > rayleigh)
	Construct the model from imported data and imported material parameters. More...
void	build_mfps (OpticalMaterialId, 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. More...
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.

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

Detailed Description

Set up and launch the optical Rayleigh scattering model interaction.

Constructor & Destructor Documentation

RayleighModel()

celeritas::optical::RayleighModel::RayleighModel	(	ActionId	id,
		SPConstImported	imported,
		SPConstMaterials	materials,
		SPConstCoreMaterials	core_materials,
		std::vector< ImportOpticalRayleigh >	import_rayleigh_materials
	)

Construct the model from imported data and imported material parameters.

Uses RayleighMfpCalculator to calculate missing imported MFPs from material parameters.

Member Function Documentation

step()

void celeritas::optical::RayleighModel::step ( CoreParams const &  , CoreStateDevice &    ) const

final

Execute the model on the device.

Interact with device data.

---

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

• optical/model/RayleighModel.hh
• optical/model/RayleighModel.cc
• optical/model/RayleighModel.cu