Celeritas 0.6.0-2+develop.96611fab
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
celeritas::UserActionIntegration Class Referencefinal

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

#include <UserActionIntegration.hh>

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

Public Member Functions

void BeginOfRunAction (G4Run const *run) final
 Start the run.
 
void BeginOfEventAction (G4Event const *event)
 Send Celeritas the event ID.
 
void PreUserTrackingAction (G4Track *track)
 Send tracks to Celeritas if applicable and "StopAndKill" if so.
 
void EndOfEventAction (G4Event const *event)
 Flush offloaded tracks from Celeritas.
 
- Public Member Functions inherited from celeritas::IntegrationBase
OffloadMode GetMode () const
 Access whether Celeritas is set up, enabled, or uninitialized.
 
void SetOptions (SetupOptions &&opts)
 Set options before starting the run.
 
void BuildForMaster ()
 
void Build ()
 
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 UserActionIntegrationInstance ()
 Access the singleton.
 

Additional Inherited Members

- Protected Member Functions inherited from celeritas::IntegrationBase
 IntegrationBase ()
 Initialize logging on first access.
 
 CELER_DEFAULT_COPY_MOVE (IntegrationBase)
 

Detailed Description

Simple interface for G4VUserTrackingAction-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.

Note
Prefer to use celeritas::TrackingManagerIntegration instead of this class, unless you need support for Geant4 earlier than 11.1.
Todo:
Provide default minimal action initialization classes for user?

Member Function Documentation

◆ BeginOfRunAction()

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

Start the run.

Implements celeritas::IntegrationBase.


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