Common interface for integrating Celeritas into user applications. More...

#include <IntegrationBase.hh>

Inheritance diagram for celeritas::IntegrationBase:

[legend]

Public Member Functions
void	BuildForMaster ()

void	Build ()

User integration points
void	SetOptions (SetupOptions &&opts)
	Set options before starting the run.

void	BeginOfRunAction (G4Run const *run)
	Start the run.

void	EndOfRunAction (G4Run const *run)
	End the run.

Low-level Celeritas accessors
OffloadMode	GetMode () const
	Access whether Celeritas is set up, enabled, or uninitialized.

CoreParams const &	GetParams ()
	Access global Celeritas shared params during a run, if not disabled.

CoreStateInterface &	GetState ()
	Access thread-local Celeritas core state data for user diagnostics.

Protected Member Functions
	IntegrationBase ()
	Initialize MPI and logging on first access.

	IntegrationBase (IntegrationBase const &)=default

IntegrationBase &	operator= (IntegrationBase const &)=default

	IntegrationBase (IntegrationBase &&)=default

IntegrationBase &	operator= (IntegrationBase &&)=default

virtual void	verify_local_setup ()=0
	Verify setup after initialization (called if thread is doing offload)

Detailed Description

Common interface for integrating Celeritas into user applications.

This implements common functionality for the Celeritas integration classes. The GetParams and GetState methods may only be used during a run with Celeritas offloading enabled.

See also: celeritas::UserActionIntegration; celeritas::TrackingManagerIntegration

This and the integration daughters all share common data in detail::IntegrationSingleton.

Member Function Documentation

◆ BeginOfRunAction()

void celeritas::IntegrationBase::BeginOfRunAction ( G4Run const * run )

Start the run.

This handles shared/local setup and calls verify_setup if offload is enabled.

◆ GetMode()

OffloadMode celeritas::IntegrationBase::GetMode ( ) const

Access whether Celeritas is set up, enabled, or uninitialized.

This is only legal to call after SetOptions.

◆ GetState()

CoreStateInterface & celeritas::IntegrationBase::GetState ( )

Access thread-local Celeritas core state data for user diagnostics.

This can only be called when Celeritas is enabled (not kill-offload, not disabled).
This cannot be called from the main thread of an MT application.

◆ SetOptions()

void celeritas::IntegrationBase::SetOptions ( SetupOptions && opts )

Set options before starting the run.

This captures the input to indicate that options cannot be modified by the framework after this point.

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