celeritas::SortTracksAction Class Reference

Sort tracks according to a given strategy specified by TrackOrder. More...

#include <SortTracksAction.hh>

Inheritance diagram for celeritas::SortTracksAction:

Public Member Functions
	SortTracksAction (ActionId id, TrackOrder track_order)
	Construct with sort ordering and track order policy.
	~SortTracksAction () final=default
	Default destructor.
void	step (CoreParams const &params, CoreStateHost &state) const final
	Execute the action with host data.
void	step (CoreParams const &params, CoreStateDevice &state) const final
	Execute the action with device data.
void	begin_run (CoreParams const &, CoreStateHost &) final
	Set host data at the beginning of a run.
void	begin_run (CoreParams const &, CoreStateDevice &) final
	Set device data at the beginning of a run.
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 for user interaction.
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::BeginRunActionInterface< P, S >
virtual void	begin_run (P const &, S< MemSpace::host > &)=0
	Set host data at the beginning of a run.
virtual void	begin_run (P const &, S< MemSpace::device > &)=0
	Set device data at the beginning of a run.

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

Sort tracks according to a given strategy specified by TrackOrder.

This action can be applied at different stage of a simulation step, automatically determined by TrackOrder. This should not have any impact on simulation output: it is only useful for GPU device optimizations.

Todo:

Keep weak pointer to actions? Use aux data?

Member Function Documentation

action_id()

ActionId celeritas::SortTracksAction::action_id ( ) const

inlinefinalvirtual

ID of the action.

Implements celeritas::ActionInterface.

description()

std::string_view celeritas::SortTracksAction::description ( ) const

inlinefinalvirtual

Description of the action for user interaction.

Implements celeritas::ActionInterface.

label()

std::string_view celeritas::SortTracksAction::label ( ) const

finalvirtual

Short name for the action.

Implements celeritas::ActionInterface.

order()

StepActionOrder celeritas::SortTracksAction::order ( ) const

inlinefinalvirtual

Dependency ordering of the action.

Implements celeritas::StepActionInterface< P, S >.

---

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

• SortTracksAction.hh
• SortTracksAction.cc