celeritas::optical::BoundaryAction< E > Class Template Reference

Optical boundary action templated by executor. More...

#include <BoundaryAction.hh>

Inheritance diagram for celeritas::optical::BoundaryAction< E >:

Public Member Functions
	BoundaryAction (ActionId)
	Construct the boundary action from an action ID.
void	step (CoreParams const &, CoreStateHost &) const final
	Launch kernel with host data.
void	step (CoreParams const &, CoreStateDevice &) const final
	Execute kernel with device data.
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.
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
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 >
Protected Member Functions inherited from celeritas::ActionInterface
	CELER_DEFAULT_COPY_MOVE (ActionInterface)

Detailed Description

template<class E>
class celeritas::optical::BoundaryAction< E >

Optical boundary action templated by executor.

Manages initialization and finalization of optical boundary crossing actions. The template parameter E should be either InitBoundaryExecutor or PostBoundaryExecutor , which corresponds to the kernel this action will execute during its stepping phase. The action name and description are managed by BoundaryActionTraits<E> .

Member Function Documentation

order()

template<class E >

StepActionOrder celeritas::optical::BoundaryAction< E >::order ( ) const

inlinefinalvirtual

Dependency ordering of the action.

Implements celeritas::StepActionInterface< P, S >.

step()

template<class E >

void celeritas::optical::BoundaryAction< E >::step ( CoreParams const &  params, CoreStateDevice &  state  ) const

final

Execute kernel with device data.

Launch kernel with device data.

---

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

• BoundaryAction.hh
• BoundaryAction.cc
• BoundaryAction.cu