Celeritas  0.5.0-56+6b053cd
Public Member Functions | Protected Member Functions | List of all members
celeritas::StepperInterface Class Referenceabstract

Interface class for stepper classes. More...

#include <Stepper.hh>

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

Public Types

Type aliases
using Input = StepperInput
 
using ActionSequenceT = ActionSequence
 
using SpanConstPrimary = Span< Primary const >
 
using result_type = StepperResult
 
using SPState = std::shared_ptr< CoreStateInterface >
 

Public Member Functions

virtual void warm_up ()=0
 
virtual StepperResult operator() ()=0
 
virtual StepperResult operator() (SpanConstPrimary primaries)=0
 
virtual void kill_active ()=0
 
virtual void reseed (UniqueEventId event_id)=0
 
virtual ActionSequenceT const & actions () const =0
 Get action sequence for timing diagnostics.
 
virtual CoreStateInterface const & state () const =0
 Get the core state interface.
 
virtual SPState sp_state ()=0
 Get a shared pointer to the state (TEMPORARY)
 

Protected Member Functions

 CELER_DEFAULT_COPY_MOVE (StepperInterface)
 

Detailed Description

Interface class for stepper classes.

This allows higher-level classes not to care whether the stepper operates on host or device.

Note
This class and its daughter may be removed soon to facilitate step gathering.

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