celeritas::UserActionIntegration Class Reference

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

#include <UserActionIntegration.hh>

Inheritance diagram for celeritas::UserActionIntegration:

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
void	SetOptions (SetupOptions &&opts)
	Set options before starting the run.
OffloadMode	GetMode () const
	Access whether Celeritas is set up, enabled, or uninitialized.
void	BuildForMaster ()
void	Build ()
void	EndOfRunAction (G4Run const *run)
	End the run.
CoreParams const &	GetParams ()
	Access Celeritas shared params.
CoreStateInterface &	GetState ()
	Access THREAD-LOCAL Celeritas core state data for user diagnostics.

Static Public Member Functions
static UserActionIntegration &	Instance ()
	Access the singleton.

Additional Inherited Members
Protected Member Functions inherited from celeritas::IntegrationBase
	IntegrationBase ()
	Initialize MPI and 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:

• Use SetOptions to set Celeritas configuration before calling G4RunManager::BeamOn
• Call BeginOfRunAction and EndOfRunAction from UserRunAction
• Call BeginOfEvent and EndOfEvent from UserEventAction
• Call PreUserTrackingAction from your UserTrackingAction

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:

• UserActionIntegration.hh
• UserActionIntegration.cc