Expose setup options through the Geant4 "macro" UI interface. More...

#include <SetupOptionsMessenger.hh>

Inheritance diagram for celeritas::SetupOptionsMessenger:

Public Member Functions
	SetupOptionsMessenger (SetupOptions *options)

	~SetupOptionsMessenger () override
	Default destructor.

Protected Member Functions
void	SetNewValue (G4UIcommand *command, G4String newValue) override
	Dispatch a command.

G4String	GetCurrentValue (G4UIcommand *command) override
	Get the value of the given command.

Detailed Description

Expose setup options through the Geant4 "macro" UI interface.

The following options are exposed in the /celer/ command "directory":

Command	Description
geometryFile	Override detector geometry with a custom GDML
outputFile	Filename for JSON diagnostic output
physicsOutputFile	Filename for ROOT dump of physics data
offloadOutputFile	Filename for HepMC3/ROOT/JSON dump of offloaded tracks
geometryOutputFile	Filename for GDML export
maxNumTracks	Number of tracks to be transported simultaneously
maxNumEvents	Maximum number of events in use
maxNumSteps	Limit on number of step iterations before aborting
maxInitializers	Maximum number of track initializers
secondaryStackFactor	At least the average number of secondaries per track
autoFlush	Number of tracks to buffer before offloading
maxFieldSubsteps	Limit on substeps in field propagator
slotDiagnosticPrefix	Print IDs of particles in all slots (expensive)

The following option is exposed in the /celer/detector/ command "directory":

Command	Description
enabled	Call back to Geant4 sensitive detectors

If a CUDA/HIP device is available, additional options are available under /celer/device/ (or a DEPRECATED /celer/cuda path, to be removed in v0.7):

Command	Description
stackSize	Set the CUDA per-thread stack size for VecGeom
heapSize	Set the CUDA per-thread heap size for VecGeom
actionTimes	Add timers around every action (may reduce performance)
defaultStream	Launch all kernels on the default stream (DEPRECATED)

Warning: The given SetupOptions should be global or otherwise must exceed the scope of this UI messenger.

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

Public Member Functions