celeritas::LocalOffloadInterface Class Reference

Abstract base class for offloading tracks to Celeritas. More...

#include <LocalOffloadInterface.hh>

Inheritance diagram for celeritas::LocalOffloadInterface:

Public Types
Type aliases
using	MapStrDbl = std::unordered_map< std::string, double >

Public Member Functions
virtual void	Initialize (SetupOptions const &, SharedParams &)=0
virtual void	InitializeEvent (int)=0
virtual void	Flush ()=0
virtual void	Finalize ()=0
virtual bool	Initialized () const =0
virtual size_type	GetBufferSize () const =0
virtual MapStrDbl	GetActionTime () const =0
	operator bool () const
	Whether the class instance is initialized.

Protected Member Functions
	LocalOffloadInterface (LocalOffloadInterface const &)=default
LocalOffloadInterface &	operator= (LocalOffloadInterface const &)=default
	LocalOffloadInterface (LocalOffloadInterface &&)=default
LocalOffloadInterface &	operator= (LocalOffloadInterface &&)=default

Detailed Description

Abstract base class for offloading tracks to Celeritas.

This class must be constructed locally on each worker thread/task/stream,

Warning

Due to Geant4 thread-local allocators, this class must be finalized or destroyed on the same CPU thread in which is created and used!

Constructor & Destructor Documentation

LocalOffloadInterface() [1/3]

celeritas::LocalOffloadInterface::LocalOffloadInterface ( )

protecteddefault

Allow construction and assignment only through daughter classes

LocalOffloadInterface() [2/3]

celeritas::LocalOffloadInterface::LocalOffloadInterface ( LocalOffloadInterface const &  )

protecteddefault

Allow construction and assignment only through daughter classes

LocalOffloadInterface() [3/3]

celeritas::LocalOffloadInterface::LocalOffloadInterface ( LocalOffloadInterface &&  )

protecteddefault

Allow construction and assignment only through daughter classes

Member Function Documentation

Finalize()

virtual void celeritas::LocalOffloadInterface::Finalize ( )

pure virtual

Implemented in celeritas::LocalOpticalOffload, and celeritas::LocalTransporter.

Flush()

virtual void celeritas::LocalOffloadInterface::Flush ( )

pure virtual

Implemented in celeritas::LocalOpticalOffload, and celeritas::LocalTransporter.

GetActionTime()

virtual MapStrDbl celeritas::LocalOffloadInterface::GetActionTime ( ) const

pure virtual

Implemented in celeritas::LocalOpticalOffload, and celeritas::LocalTransporter.

GetBufferSize()

virtual size_type celeritas::LocalOffloadInterface::GetBufferSize ( ) const

pure virtual

Implemented in celeritas::LocalOpticalOffload, and celeritas::LocalTransporter.

Initialize()

virtual void celeritas::LocalOffloadInterface::Initialize ( SetupOptions const &  , SharedParams &    )

pure virtual

Implemented in celeritas::LocalOpticalOffload, and celeritas::LocalTransporter.

Initialized()

virtual bool celeritas::LocalOffloadInterface::Initialized ( ) const

pure virtual

Implemented in celeritas::LocalOpticalOffload, and celeritas::LocalTransporter.

InitializeEvent()

virtual void celeritas::LocalOffloadInterface::InitializeEvent ( int  )

pure virtual

Implemented in celeritas::LocalOpticalOffload, and celeritas::LocalTransporter.

operator=() [1/2]

LocalOffloadInterface & celeritas::LocalOffloadInterface::operator= ( LocalOffloadInterface &&  )

protecteddefault

Allow construction and assignment only through daughter classes

operator=() [2/2]

LocalOffloadInterface & celeritas::LocalOffloadInterface::operator= ( LocalOffloadInterface const &  )

protecteddefault

Allow construction and assignment only through daughter classes

---

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

• LocalOffloadInterface.hh