celeritas::StepActionInterface< P, S > Class Template Reference

Interface for kernel actions in a stepping loop. More...

#include <ActionInterface.hh>

Inherits celeritas::ActionTypeTraits< P, S >, and celeritas::ActionInterface.

Inherited by celeritas::ActionDiagnostic, celeritas::AlongStepCartMapFieldMscAction, celeritas::AlongStepCylMapFieldMscAction, celeritas::AlongStepGeneralLinearAction, celeritas::AlongStepNeutralAction, celeritas::AlongStepRZMapFieldMscAction, celeritas::AlongStepUniformMscAction, celeritas::ExtendFromPrimariesAction, celeritas::ExtendFromSecondariesAction, celeritas::InitializeTracksAction, celeritas::Model, celeritas::OffloadAction< G >, celeritas::OffloadGatherAction< S >, celeritas::SlotDiagnostic, celeritas::SortTracksAction, celeritas::StepDiagnostic, celeritas::optical::AlongStepAction, celeritas::optical::BoundaryAction< E >, celeritas::optical::DetectorAction, celeritas::optical::DiscreteSelectAction, celeritas::optical::GeneratorBase [virtual], celeritas::optical::LocateVacanciesAction, celeritas::optical::Model, celeritas::optical::PreStepAction, celeritas::optical::StepDiagnostic, celeritas::optical::SurfaceSteppingAction, celeritas::optical::TrackingCutAction, celeritas::optical::test::CollectResultsAction< Collector >, celeritas::test::DummyAction, and celeritas::test::MockInteractAction.

Public Member Functions
virtual StepActionOrder	order () const =0
	Dependency ordering of the action inside the step.
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.
virtual ActionId	action_id () const =0
	ID of this action for verification and ordering.
virtual std::string_view	label () const =0
	Short unique label of the action.
virtual std::string_view	description () const =0
	Description of the action.

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
	ActionInterface (ActionInterface const &)=default
ActionInterface &	operator= (ActionInterface const &)=default
	ActionInterface (ActionInterface &&)=default
ActionInterface &	operator= (ActionInterface &&)=default

Detailed Description

template<class P, template< MemSpace M > class S>
class celeritas::StepActionInterface< P, S >

Interface for kernel actions in a stepping loop.

Template Parameters

P	Core param class
S	Core state class

Member Function Documentation

order()

template<class P , template< MemSpace M > class S>

virtual StepActionOrder celeritas::StepActionInterface< P, S >::order ( ) const

pure virtual

Dependency ordering of the action inside the step.

Implemented in celeritas::AlongStepCartMapFieldMscAction, celeritas::AlongStepCylMapFieldMscAction, celeritas::AlongStepGeneralLinearAction, celeritas::AlongStepNeutralAction, celeritas::AlongStepRZMapFieldMscAction, celeritas::AlongStepUniformMscAction, celeritas::optical::AlongStepAction, celeritas::optical::DetectorAction, celeritas::optical::DiscreteSelectAction, celeritas::optical::LocateVacanciesAction, celeritas::optical::PreStepAction, celeritas::optical::StepDiagnostic, celeritas::optical::TrackingCutAction, celeritas::optical::GeneratorBase, celeritas::OffloadAction< G >, celeritas::OffloadGatherAction< S >, celeritas::optical::BoundaryAction< E >, celeritas::optical::SurfaceSteppingAction, celeritas::Model, celeritas::ExtendFromPrimariesAction, celeritas::ExtendFromSecondariesAction, celeritas::InitializeTracksAction, celeritas::SortTracksAction, celeritas::ActionDiagnostic, celeritas::SlotDiagnostic, celeritas::StepDiagnostic, celeritas::test::DummyAction, celeritas::optical::test::CollectResultsAction< Collector >, celeritas::test::MockInteractAction, and celeritas::optical::Model.

---

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

• corecel/sys/ActionInterface.hh