celeritas::AlongStepNeutralAction Class Reference

Along-step kernel for particles without fields or energy loss. More...

#include <AlongStepNeutralAction.hh>

Inheritance diagram for celeritas::AlongStepNeutralAction:

Public Member Functions
	AlongStepNeutralAction (ActionId id)
	Construct with next action ID.
void	step (CoreParams const &, CoreStateHost &) const final
	Launch the along-step action on host.
void	step (CoreParams const &, CoreStateDevice &) const final
	Launch the along-step action on device.
ActionId	action_id () const final
	ID of the model.
std::string_view	label () const final
	Short name for the along-step kernel.
std::string_view	description () const final
	Short description of the action.
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
	CELER_DEFAULT_COPY_MOVE (ActionInterface)

Detailed Description

Along-step kernel for particles without fields or energy loss.

This should only be used for testing and demonstration purposes because real EM physics always has continuous energy loss for charged particles.

Member Function Documentation

action_id()

ActionId celeritas::AlongStepNeutralAction::action_id ( ) const

inlinefinalvirtual

ID of the model.

Implements celeritas::ActionInterface.

description()

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

inlinefinalvirtual

Short description of the action.

Implements celeritas::ActionInterface.

label()

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

inlinefinalvirtual

Short name for the along-step kernel.

Implements celeritas::ActionInterface.

order()

StepActionOrder celeritas::AlongStepNeutralAction::order ( ) const

inlinefinalvirtual

Dependency ordering of the action.

Implements celeritas::StepActionInterface< P, S >.

---

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

• AlongStepNeutralAction.hh
• AlongStepNeutralAction.cc
• AlongStepNeutralAction.cu