Celeritas 0.6.0-rc.2.10+develop.de0a3a05
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
celeritas::TrackingManagerIntegration Class Referencefinal

Simple interface for G4VTrackingManager-based integration. More...

#include <TrackingManagerIntegration.hh>

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

Public Member Functions

void BeginOfRunAction (G4Run const *run) final
 Start the run, initializing Celeritas options.
 
- Public Member Functions inherited from celeritas::IntegrationBase
void SetOptions (SetupOptions &&opts)
 Set options before starting the run.
 
void BuildForMaster ()
 Initialize during ActionInitialization on non-worker thread in MT mode.
 
void Build ()
 Initialize during ActionInitialization on a worker thread or serial mode.
 
void EndOfRunAction (G4Run const *run)
 End the run.
 
CoreParams constGetParams ()
 Access Celeritas shared params.
 
CoreStateInterfaceGetState ()
 Access THREAD-LOCAL Celeritas core state data for user diagnostics.
 

Static Public Member Functions

static TrackingManagerIntegrationInstance ()
 Access the public-facing integration singleton.
 

Additional Inherited Members

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

Detailed Description

Simple interface for G4VTrackingManager-based integration.

This singleton integrates both thread-local and global data with the user application. To use this class in your Geant4 application to offload tracks to Celeritas:

The CELER_DISABLE environment variable, if set and non-empty, will disable offloading so that Celeritas will not be built nor kill tracks.

The method names correspond to methods in Geant4 User Actions and must be called from all threads, both worker and master.

Todo:
Provide default minimal action initialization classes for user

Member Function Documentation

◆ BeginOfRunAction()

void celeritas::TrackingManagerIntegration::BeginOfRunAction ( G4Run const run)
finalvirtual

Start the run, initializing Celeritas options.

Implements celeritas::IntegrationBase.


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