celeritas::InitializeTracksAction Class Reference

Initialize track states. More...

#include <InitializeTracksAction.hh>

Inheritance diagram for celeritas::InitializeTracksAction:

Public Member Functions
	InitializeTracksAction (ActionId id)
	Construct with explicit Id.
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.
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.

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

Initialize track states.

Tracks created from secondaries produced in this action will have the geometry state copied over from the parent instead of initialized from the position. If there are more empty slots than new secondaries, they will be filled by any track initializers remaining from previous steps using the position.

With TrackOrder::init_charge, new neutral tracks are placed in the vacancies at the front of the track vector and new charged tracks in the vacancies at the back. The placement is determined on the device from a prefix sum of neutral flags over all track slots, so the number of new tracks never has to be copied to the host.

Member Function Documentation

action_id()

ActionId celeritas::InitializeTracksAction::action_id ( ) const

inlinefinalvirtual

ID of the action.

Implements celeritas::ActionInterface.

description()

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

inlinefinalvirtual

Description of the action for user interaction.

Implements celeritas::ActionInterface.

label()

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

inlinefinalvirtual

Short name for the action.

Implements celeritas::ActionInterface.

order()

StepActionOrder celeritas::InitializeTracksAction::order ( ) const

inlinefinalvirtual

Dependency ordering of the action.

Implements celeritas::StepActionInterface< P, S >.

---

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

• InitializeTracksAction.hh
• InitializeTracksAction.cc
• InitializeTracksAction.cu