Celeritas 0.6.0-93+develop.7a7d9941
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
celeritas::OffloadGatherAction Class Referencefinal

Collect pre-step data needed to generate optical distribution data. More...

#include <OffloadGatherAction.hh>

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

Public Member Functions

 OffloadGatherAction (ActionId id, AuxId aux_id)
 Construct with action ID and aux ID.
 
Aux interface
AuxId aux_id () const final
 Index of this class instance in its registry.
 
UPState create_state (MemSpace, StreamId, size_type) const final
 Build state data for a stream.
 
Action interface
ActionId action_id () const final
 ID of the model.
 
std::string_view label () const final
 Short name for the action.
 
std::string_view description () const final
 Descriptive name of the action.
 
StepAction interface
StepActionOrder order () const final
 Dependency ordering of the action.
 
void step (CoreParams const &, CoreStateHost &) const final
 Gather pre-step data.
 
void step (CoreParams const &, CoreStateDevice &) const final
 Gather pre-step 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.
 
- Public Member Functions inherited from celeritas::AuxParamsInterface
virtual ~AuxParamsInterface ()
 Default destructor.
 

Static Public Member Functions

static std::shared_ptr< OffloadGatherActionmake_and_insert (CoreParams const &)
 Construct and add to core params.
 

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 >
 
- Public Types inherited from celeritas::AuxParamsInterface
using UPState = std::unique_ptr< AuxStateInterface >
 Default destructor.
 
- Protected Member Functions inherited from celeritas::ActionInterface
 CELER_DEFAULT_COPY_MOVE (ActionInterface)
 
- Protected Member Functions inherited from celeritas::AuxParamsInterface
 AuxParamsInterface ()=default
 
 CELER_DEFAULT_COPY_MOVE (AuxParamsInterface)
 Default destructor.
 

Detailed Description

Collect pre-step data needed to generate optical distribution data.

This pre-step action stores the optical material ID and other beginning-of-step properties so that optical photons can be generated between the start and end points of the step.

See also
OffloadGatherExecutor

Member Function Documentation

◆ action_id()

ActionId celeritas::OffloadGatherAction::action_id ( ) const
inlinefinalvirtual

ID of the model.

Implements celeritas::ActionInterface.

◆ aux_id()

AuxId celeritas::OffloadGatherAction::aux_id ( ) const
inlinefinalvirtual

Index of this class instance in its registry.

Implements celeritas::AuxParamsInterface.

◆ create_state()

auto celeritas::OffloadGatherAction::create_state ( MemSpace  m,
StreamId  id,
size_type  size 
) const
finalvirtual

Build state data for a stream.

Implements celeritas::AuxParamsInterface.

◆ description()

std::string_view celeritas::OffloadGatherAction::description ( ) const
finalvirtual

Descriptive name of the action.

Implements celeritas::ActionInterface.

◆ label()

std::string_view celeritas::OffloadGatherAction::label ( ) const
inlinefinalvirtual

Short name for the action.

Implements celeritas::ActionInterface.

◆ order()

StepActionOrder celeritas::OffloadGatherAction::order ( ) const
inlinefinalvirtual

Dependency ordering of the action.

Implements celeritas::StepActionInterface< P, S >.


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