Interface class for stepper classes. More...

#include <Stepper.hh>

Inheritance diagram for celeritas::StepperInterface:

Public Types
Type aliases
using	Input = StepperInput

using	SpanConstPrimary = Span< Primary const >

using	result_type = StepperResult

using	SPState = std::shared_ptr< CoreStateInterface >

Public Member Functions
virtual void	warm_up ()=0

virtual void	async ()=0

virtual void	async (SpanConstPrimary primaries)=0

virtual bool	valid () const noexcept=0
	Whether an asynchronous step result can be retrieved.

virtual bool	ready () const =0

virtual void	wait () const =0

virtual StepperResult	get ()=0

virtual size_type	primary_capacity () const noexcept=0
	Fixed capacity of each stepper-owned primary buffer.

virtual size_type	initializer_capacity () const noexcept=0
	Fixed capacity of the track initializer queue.

virtual size_type	secondary_capacity () const noexcept=0
	Fixed capacity of the per-step secondary stack.

virtual size_type	num_buffered_primaries () const noexcept=0
	Number of primaries accumulated in the producer buffer.

virtual void	push_primary (Primary const &primary)=0

virtual void	stage_primaries ()=0

virtual SpanConstPrimary	staged_primaries () const noexcept=0
	Access the unsubmitted primary batch staged for the next step.

virtual StepperResult	operator() ()=0

virtual void	stage_primaries (SpanConstPrimary primaries)=0

virtual StepperResult	operator() (SpanConstPrimary primaries)=0

virtual void	kill_active ()=0

virtual void	reseed (UniqueEventId event_id)=0

virtual ActionSequence 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
	StepperInterface (StepperInterface const &)=default

StepperInterface &	operator= (StepperInterface const &)=default

	StepperInterface (StepperInterface &&)=default

StepperInterface &	operator= (StepperInterface &&)=default

Detailed Description

Interface class for stepper classes.

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

A stepper initially has no asynchronous result, so valid returns false. Calling async, with or without primaries, starts one step and makes the result valid. No other step can be started until get returns the result and restores the initial state. The ready function queries completion without blocking, wait blocks without consuming the result, and get waits if necessary before consuming it. All three require a valid result. A valid result can be ready: valid describes whether the result can be retrieved, rather than whether device execution is still underway.

Primary input is accumulated in a fixed-capacity producer buffer owned by the stepper. Calling stage_primaries transfers that batch into the core state and makes it available to the next call to async. The producer can then accept another batch, including while a previous step result is valid. At most one unsubmitted batch can be staged. The span overload copies its input into stepper-owned storage, so the caller's span need not remain valid after the call returns. The span returned by staged_primaries represents only the current unsubmitted batch and should not be retained after a call that changes the staging state.

Calling async submits staged primaries, if present, and otherwise advances existing tracks without changing the producer buffer. This allows prior transport to be drained while a later primary batch remains buffered. Primaries can be pushed and staged while a previous result is valid, but the next step cannot start until get consumes that result. Thus result completion and primary production have independent lifecycles.

Host steps execute synchronously and are immediately ready. The deprecated call operators preserve synchronous behavior by calling async followed by get.

Before destroying a device Stepper, the caller must ensure that any valid asynchronous operation has completed by calling wait or get, and that any staged primary batch has been submitted with async. Destruction does not add hidden synchronization.

Note: This interface and its implementations may be removed soon to facilitate step gathering.

Member Function Documentation

◆ actions()

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

pure virtual

Get action sequence for timing diagnostics.

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ actions()

◆ async() [1/2]

◆ async() [2/2]

◆ get()

◆ initializer_capacity()

◆ kill_active()

◆ num_buffered_primaries()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ primary_capacity()

◆ push_primary()

◆ ready()

◆ reseed()

◆ secondary_capacity()

◆ sp_state()

◆ stage_primaries() [1/2]

◆ stage_primaries() [2/2]

◆ staged_primaries()

◆ state()

◆ valid()

◆ wait()

◆ warm_up()