celeritas::AlongStepCartMapFieldMscAction Class Reference

Along-step kernel with MSC, energy loss fluctuations, and a CartMapField. More...

#include <AlongStepCartMapFieldMscAction.hh>

Inheritance diagram for celeritas::AlongStepCartMapFieldMscAction:

Public Types
Type aliases
using	SPConstFluctuations = std::shared_ptr< FluctuationParams const >
using	SPConstMsc = std::shared_ptr< UrbanMscParams const >
using	SPConstFieldParams = std::shared_ptr< CartMapFieldParams const >
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 >

Public Member Functions
	AlongStepCartMapFieldMscAction (ActionId id, CartMapFieldInput const &input, SPConstFluctuations fluct, SPConstMsc msc)
	Construct with next action ID, energy loss parameters, and MSC.
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 interaction kernel.
std::string_view	description () const final
	Short description of the action.
StepActionOrder	order () const final
	Dependency ordering of the action.
bool	has_fluct () const
	Whether energy flucutation is in use.
bool	has_msc () const
	Whether MSC is in use.
SPConstFieldParams const &	field () const
	Field map data.
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.

Static Public Member Functions
static std::shared_ptr< AlongStepCartMapFieldMscAction >	from_params (ActionId id, MaterialParams const &materials, ParticleParams const &particles, CartMapFieldInput const &field_input, SPConstMsc const &msc, bool eloss_fluctuation)
	Construct the along-step action from input parameters.

Additional Inherited Members
Protected Member Functions inherited from celeritas::ActionInterface
	CELER_DEFAULT_COPY_MOVE (ActionInterface)

Detailed Description

Along-step kernel with MSC, energy loss fluctuations, and a CartMapField.

Member Function Documentation

action_id()

ActionId celeritas::AlongStepCartMapFieldMscAction::action_id ( ) const

inlinefinalvirtual

ID of the model.

Implements celeritas::ActionInterface.

description()

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

inlinefinalvirtual

Short description of the action.

Implements celeritas::ActionInterface.

label()

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

inlinefinalvirtual

Short name for the interaction kernel.

Implements celeritas::ActionInterface.

order()

StepActionOrder celeritas::AlongStepCartMapFieldMscAction::order ( ) const

inlinefinalvirtual

Dependency ordering of the action.

Implements celeritas::StepActionInterface< P, S >.

---

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

• AlongStepCartMapFieldMscAction.hh
• AlongStepCartMapFieldMscAction.cc
• AlongStepCartMapFieldMscAction.cu