celeritas::StepperInterface Class Reference

Interface class for stepper classes. More...

#include <Stepper.hh>

Inheritance diagram for celeritas::StepperInterface:

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.

Member Function Documentation

actions()

virtual ActionSequenceT const & celeritas::StepperInterface::actions ( ) const

pure virtual

Get action sequence for timing diagnostics.

Implemented in celeritas::Stepper< M >.

kill_active()

virtual void celeritas::StepperInterface::kill_active ( )

pure virtual

Implemented in celeritas::Stepper< M >.

operator()() [1/2]

virtual StepperResult celeritas::StepperInterface::operator() ( )

pure virtual

Implemented in celeritas::Stepper< M >.

operator()() [2/2]

virtual StepperResult celeritas::StepperInterface::operator() ( SpanConstPrimary  primaries )

pure virtual

Implemented in celeritas::Stepper< M >.

reseed()

virtual void celeritas::StepperInterface::reseed ( UniqueEventId  event_id )

pure virtual

Implemented in celeritas::Stepper< M >.

sp_state()

virtual SPState celeritas::StepperInterface::sp_state ( )

pure virtual

Get a shared pointer to the state (TEMPORARY)

Implemented in celeritas::Stepper< M >.

state()

virtual CoreStateInterface const & celeritas::StepperInterface::state ( ) const

pure virtual

Get the core state interface.

Implemented in celeritas::Stepper< M >.

warm_up()

virtual void celeritas::StepperInterface::warm_up ( )

pure virtual

Implemented in celeritas::Stepper< M >.

---

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

• Stepper.hh
• Stepper.cc