celeritas::optical::CoreStateInterface Class Reference

Interface class for optical state data. More...

#include <CoreState.hh>

Inheritance diagram for celeritas::optical::CoreStateInterface:

Public Types
Type aliases
using	size_type = TrackSlotId::size_type
Public Types inherited from celeritas::AuxStateInterface
using	SPState = std::shared_ptr< AuxStateInterface >
	Default destructor.

Public Member Functions
	~CoreStateInterface () override
	Support polymorphic deletion, anchoring to avoid bugs.
virtual StreamId	stream_id () const =0
	Thread/stream ID.
virtual CoreStateCounters	sync_get_counters () const =0
	Synchronize and copy track initialization counters from device to host For host-only code, this replaces the old counters() function.
virtual void	sync_put_counters (CoreStateCounters const &)=0
	Synchronize and copy track initialization counters from host to device For host-only code, this replaces the old counters() function since we return a CoreStateCounters object instead of a reference.
virtual void	reseed (std::shared_ptr< RngParams const >, UniqueEventId)=0
	Reseed the RNGs at the start of an event for reproducibility.
virtual size_type	size () const =0
	Number of track slots.
virtual void	insert_primaries (Span< TrackInitializer const > host_primaries)=0
Public Member Functions inherited from celeritas::AuxStateInterface
virtual	~AuxStateInterface ()
	Default destructor.

Protected Member Functions
	CoreStateInterface (CoreStateInterface const &)=default
CoreStateInterface &	operator= (CoreStateInterface const &)=default
	CoreStateInterface (CoreStateInterface &&)=default
CoreStateInterface &	operator= (CoreStateInterface &&)=default
Protected Member Functions inherited from celeritas::AuxStateInterface
	AuxStateInterface ()=default
	AuxStateInterface (AuxStateInterface const &)=default
	Default destructor.
AuxStateInterface &	operator= (AuxStateInterface const &)=default
	Default destructor.
	AuxStateInterface (AuxStateInterface &&)=default
	Default destructor.
AuxStateInterface &	operator= (AuxStateInterface &&)=default
	Default destructor.

Detailed Description

Interface class for optical state data.

This inherits from the "aux state" interface to allow stream-local storage with the optical offload data.

Member Function Documentation

insert_primaries()

virtual void celeritas::optical::CoreStateInterface::insert_primaries ( Span< TrackInitializer const >  host_primaries )

pure virtual

Implemented in celeritas::optical::CoreState< M >.

reseed()

virtual void celeritas::optical::CoreStateInterface::reseed ( std::shared_ptr< RngParams const >  , UniqueEventId    )

pure virtual

Reseed the RNGs at the start of an event for reproducibility.

Implemented in celeritas::optical::CoreState< M >.

size()

virtual size_type celeritas::optical::CoreStateInterface::size ( ) const

pure virtual

Number of track slots.

Implemented in celeritas::optical::CoreState< M >.

stream_id()

virtual StreamId celeritas::optical::CoreStateInterface::stream_id ( ) const

pure virtual

Thread/stream ID.

Implemented in celeritas::optical::CoreState< M >.

sync_get_counters()

virtual CoreStateCounters celeritas::optical::CoreStateInterface::sync_get_counters ( ) const

pure virtual

Synchronize and copy track initialization counters from device to host For host-only code, this replaces the old counters() function.

Implemented in celeritas::optical::CoreState< M >.

sync_put_counters()

virtual void celeritas::optical::CoreStateInterface::sync_put_counters ( CoreStateCounters const &  )

pure virtual

Synchronize and copy track initialization counters from host to device For host-only code, this replaces the old counters() function since we return a CoreStateCounters object instead of a reference.

Implemented in celeritas::optical::CoreState< M >.

---

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

• optical/CoreState.hh
• optical/CoreState.cc