Celeritas 0.7.0-dev.194+develop.0df4cab59
Loading...
Searching...
No Matches
Public Member Functions | List of all members
celeritas::LocalOpticalOffload Class Referencefinal

Manage offloading of optical distribution data to Celeritas. More...

#include <LocalOpticalOffload.hh>

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

Public Types

Type aliases
using DistributionData = optical::GeneratorDistributionData
 
- Public Types inherited from celeritas::LocalOffloadInterface
using MapStrDbl = std::unordered_map< std::string, double >
 

Public Member Functions

 LocalOpticalOffload (SetupOptions const &options, SharedParams &params)
 Construct with options and shared data.
 
void Push (DistributionData const &)
 Buffer distribution data for generating optical photons.
 
 operator bool () const
 Whether the class instance is initialized.
 
LocalOffload interface
void Initialize (SetupOptions const &, SharedParams &) final
 Initialize with options and shared data.
 
void InitializeEvent (int) final
 Set the event ID and reseed the Celeritas RNG at the start of an event.
 
void Flush () final
 Generate and transport optical photons from the buffered distribution data.
 
void Finalize () final
 Clear local data.
 
bool Initialized () const final
 Initialize with options and shared data.
 
size_type GetBufferSize () const final
 Initialize with options and shared data.
 
MapStrDbl GetActionTime () const final
 Get the accumulated action times.
 
- Public Member Functions inherited from celeritas::LocalOffloadInterface
 operator bool () const
 Whether the class instance is initialized.
 

Additional Inherited Members

- Protected Member Functions inherited from celeritas::LocalOffloadInterface
 CELER_DEFAULT_COPY_MOVE (LocalOffloadInterface)
 

Detailed Description

Manage offloading of optical distribution data to Celeritas.

Member Function Documentation

◆ Finalize()

void celeritas::LocalOpticalOffload::Finalize ( )
finalvirtual

Clear local data.

Implements celeritas::LocalOffloadInterface.

◆ Flush()

void celeritas::LocalOpticalOffload::Flush ( )
finalvirtual

Generate and transport optical photons from the buffered distribution data.

Todo:
Duplicated in LocalTransporter

Implements celeritas::LocalOffloadInterface.

◆ GetActionTime()

auto celeritas::LocalOpticalOffload::GetActionTime ( ) const
finalvirtual

Get the accumulated action times.

Implements celeritas::LocalOffloadInterface.

◆ GetBufferSize()

size_type celeritas::LocalOpticalOffload::GetBufferSize ( ) const
inlinefinalvirtual

Initialize with options and shared data.

Implements celeritas::LocalOffloadInterface.

◆ Initialize()

void celeritas::LocalOpticalOffload::Initialize ( SetupOptions const options,
SharedParams params 
)
finalvirtual

Initialize with options and shared data.

Implements celeritas::LocalOffloadInterface.

◆ Initialized()

bool celeritas::LocalOpticalOffload::Initialized ( ) const
inlinefinalvirtual

Initialize with options and shared data.

Implements celeritas::LocalOffloadInterface.

◆ InitializeEvent()

void celeritas::LocalOpticalOffload::InitializeEvent ( int  id)
finalvirtual

Set the event ID and reseed the Celeritas RNG at the start of an event.

Implements celeritas::LocalOffloadInterface.


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