Celeritas  0.5.0-56+6b053cd
Public Member Functions | Static Public Member Functions | List of all members
celeritas::AlongStepGeneralLinearAction Class Referencefinal

Along-step kernel for particles without fields. More...

#include <AlongStepGeneralLinearAction.hh>

Inheritance diagram for celeritas::AlongStepGeneralLinearAction:
Inheritance graph
[legend]

Public Types

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

 AlongStepGeneralLinearAction (ActionId id, SPConstFluctuations fluct, SPConstMsc msc)
 Construct with next action ID and optional energy loss parameters.
 
 ~AlongStepGeneralLinearAction ()
 Default destructor.
 
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. More...
 
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.
 
bool has_fluct () const
 Whether energy flucutation is in use.
 
bool has_msc () const
 Whether MSC is in use.
 
- 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< AlongStepGeneralLinearActionfrom_params (ActionId id, MaterialParams const &materials, ParticleParams const &particles, SPConstMsc const &msc, bool eloss_fluctuation)
 Construct the along-step action from input parameters.
 

Additional Inherited Members

- Protected Member Functions inherited from celeritas::ActionInterface
 ActionInterface ()=default
 
 CELER_DEFAULT_COPY_MOVE (ActionInterface)
 

Detailed Description

Along-step kernel for particles without fields.

This kernel is for problems without EM fields, for particle types that may have (but do not need to have) along-step energy loss, optional energy fluctuation, and optional multiple scattering.

Member Function Documentation

◆ step()

void celeritas::AlongStepGeneralLinearAction::step ( CoreParams const &  params,
CoreStateDevice &  state 
) const
inlinefinal

Launch the along-step action on device.

The six kernels should correspons to the six function calls in AlongStep.


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