celeritas::OffloadAction< G > Class Template Reference

Generate optical distribution data. More...

#include <OffloadAction.hh>

Inheritance diagram for celeritas::OffloadAction< G >:

Classes
struct	Input
	Offload input data. More...

Public Types
Type aliases
using	TraitsT = detail::OffloadTraits< G >
using	SPConstParams = std::shared_ptr< typename TraitsT::Params const >
using	SPConstMaterial = std::shared_ptr< optical::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
	OffloadAction (ActionId action_id, Input &&)
	Construct with action ID, aux IDs, and optical properties.
SPConstParams const &	params () const
	Access shared data used by this offload physics.
Action interface
ActionId	action_id () const final
	ID of the action.
std::string_view	label () const final
	Short name for the action.
std::string_view	description () const final
	Description of the action.
StepAction interface
StepActionOrder	order () const final
	Dependency ordering of the action.
void	step (CoreParams const &, CoreStateHost &) const final
	Execute the action with host data.
void	step (CoreParams const &, CoreStateDevice &) const final
	Execute the action with device data.
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.

Static Public Member Functions
static std::shared_ptr< OffloadAction >	make_and_insert (CoreParams const &, Input &&)
	Construct and add to core params.

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

Detailed Description

template<GeneratorType G>
class celeritas::OffloadAction< G >

Generate optical distribution data.

Member Function Documentation

action_id()

template<GeneratorType G>

ActionId celeritas::OffloadAction< G >::action_id ( ) const

inlinefinalvirtual

ID of the action.

Implements celeritas::ActionInterface.

description()

template<GeneratorType G>

std::string_view celeritas::OffloadAction< G >::description ( ) const

inlinefinalvirtual

Description of the action.

Implements celeritas::ActionInterface.

label()

template<GeneratorType G>

std::string_view celeritas::OffloadAction< G >::label ( ) const

inlinefinalvirtual

Short name for the action.

Implements celeritas::ActionInterface.

order()

template<GeneratorType G>

StepActionOrder celeritas::OffloadAction< G >::order ( ) const

inlinefinalvirtual

Dependency ordering of the action.

Implements celeritas::StepActionInterface< P, S >.

---

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

• OffloadAction.hh
• OffloadAction.cc
• OffloadAction.cu