Commands in /run/

/run/

Run control commands.

Sub-directories :

/run/particle/: Commands for G4VUserPhysicsList.

Commands :

initialize

Initialize G4 kernel.

Available Geant4 state(s) : PreInit Idle

beamOn [numberOfEvent] [macroFile] [nSelect]

Start a Run.
If G4 kernel is not initialized, it will be initialized.
Default number of events to be processed is 1.
The second and third arguments can be used for
executing a macro file at the end of each event.
If the second argument, i.e. name of the macro
file, is given but the third argument is not,
the macro file will be executed for all of the
event.
If the third argument (nSelect) is given, the
macro file will be executed only for the first
nSelect events.

Available Geant4 state(s) : PreInit Idle

Parameters

numberOfEvent	type i	Omittable : default value = 1	Parameter range : numberOfEvent >= 0
macroFile	type s	Omittable : default value = *NULL*
nSelect	type i	Omittable : default value = -1	Parameter range : nSelect>=-1

verbose [level]

Set the Verbose level of G4RunManager.
0 : Silent (default)
1 : Display main topics
2 : Display main topics and run summary

Range : level >=0 && level <=2

Available at all Geant4 states.

Parameters

level

type i

Omittable : default value = 0

printProgress [mod]

Display begin_of_event information at given frequency.
If it is set to zero, only the begin_of_run is shown.
If it is set to -1, no print-out is shown.

Range : mod>=-1

Available at all Geant4 states.

Parameters

mod

type i

Omittable : default value = -1

numberOfThreads [nThreads]

Set the number of threads to be used.
This command works only in PreInit state.
This command is valid only for multi-threaded mode.
The command is ignored if it is issued in sequential mode.

Range : nThreads >0

Available Geant4 state(s) : PreInit

Parameters

nThreads

type i

Omittable : default value = 2

useMaximumLogicalCores

Set the number of threads to be the number of available logical cores.
This command works only in PreInit state.
This command is valid only for multi-threaded mode.
The command is ignored if it is issued in sequential mode.

Available Geant4 state(s) : PreInit

pinAffinity [pinAffinity]

Locks each thread to a specific logical core. Workers are locked in round robin to logical cores.
This command is valid only for multi-threaded mode.
This command works only in PreInit state.
This command is ignored if it is issued in sequential mode.
If a value n>0 is provided it starts setting affinity from the n-th CPU (note: counting from 1).
E.g. /run/pinAffinity 3 locks first thread on third logical CPU (number 2).
If a value n<0 is provided never locks on n-th CPU.

Range : pinAffinity > 0 || pinAffinity < 0

Available Geant4 state(s) : PreInit

Parameters

pinAffinity

type i

Omittable : default value = 1

eventModulo [N] [seedOnce]

Set the event modulo for dispatching events to worker threads
i.e. each worker thread is ordered to simulate N events and then
comes back to G4MTRunManager for next set.
If it is set to zero (default value), N is roughly given by this.
N = int( sqrt( number_of_events / number_of_threads ) )
The value N may affect on the computing performance in particular
if N is too small compared to the total number of events.
The second parameter seedOnce specifies how frequently each worker
thread is seeded by the random number sequence centrally managed
by the master G4MTRunManager.
- If seedOnce is set to 0 (default), seeds that are centrally managed
by G4MTRunManager are set for every event of every worker thread.
This option guarantees event reproducibility regardless of number
of threads.
- If seedOnce is set to 1, seeds are set only once for the first
event of each run of each worker thread. Event reproducibility is
guaranteed only if the same number of worker threads are used.
On the other hand, this option offers better computing performance
in particular for applications with relatively small primary
particle energy and large number of events.
- If seedOnce is set to 2, seeds are set only for the first event of
group of N events. This option is reserved for the future use when
Geant4 allows number of threads to be dynamically changed during an
event loop.
This command is valid only for multi-threaded mode.
This command is ignored if it is issued in sequential mode.

Available Geant4 state(s) : PreInit Idle

Parameters

N	type i	Omittable : default value = 0	Parameter range : N >= 0
seedOnce	type i	Omittable : default value = 0	Parameter range : seedOnce >= 0 && seedOnce <=2

dumpRegion [regionName]

Dump region information.
In case name of a region is not given, all regions will be displayed.

Available Geant4 state(s) : Idle

Parameters

regionName

type s

Omittable : default value = **ALL**

dumpCouples

Dump material-cuts-couple information.
Note that material-cuts-couple information is updated
after BeamOn has started.

Available Geant4 state(s) : Idle

optimizeGeometry [optimizeFlag]

Set the optimization flag for geometry.
If it is set to TRUE, G4GeometryManager will optimize
the geometry definitions.
GEANT4 is initialized with this flag as TRUE.

Available Geant4 state(s) : PreInit Idle

Parameters

optimizeFlag

type b

Omittable : default value = 1

breakAtBeginOfEvent [flag]

Set a break point at the beginning of every event.

Available at all Geant4 states.

Parameters

flag

type b

Omittable : default value = 1

breakAtEndOfEvent [flag]

Set a break point at the end of every event.

Available at all Geant4 states.

Parameters

flag

type b

Omittable : default value = 1

abort [softAbort]

Abort current run processing.
If softAbort is false (default), currently processing event will be immediately aborted,
while softAbort is true, abortion occurs after processing the current event.

Available Geant4 state(s) : GeomClosed EventProc

Parameters

softAbort

type b

Omittable : default value = 0

abortCurrentEvent

Abort currently processing event.

Available Geant4 state(s) : EventProc

geometryModified

Force geometry to be closed (re-voxellized) again.
This command must be applied if geometry has been modified
after the first initialization (or BeamOn).

Available Geant4 state(s) : PreInit Idle

reinitializeGeometry [destroyFirst]

Force geometry to be rebuilt once again.
This command must be applied if the user needs his/her
detector construction to be reinvoked.
/run/geometryModified is automatically issued with this command.

Available Geant4 state(s) : PreInit Idle

Parameters

destroyFirst

type b

Omittable : default value = 0

physicsModified

Force all physics tables recalculated again.
This command must be applied
if physics process has been modified after the
first initialization (or BeamOn).

Available Geant4 state(s) : PreInit Idle

constructScoringWorlds

Construct scoring parallel world(s) if defined.
This command is not mandatory, but automatically called when a run starts.
But the user may use this to visualize the scoring world(s) before a run to start.

Available Geant4 state(s) : Idle

storeRndmStatToEvent [flag]

Flag to store rndm status to G4Event object.
flag = 0 : not store (default)
flag = 1 : status before primary particle generation is stored
flag = 2 : status before event processing (after primary particle generation) is stored
flag = 3 : both are stored
Note: Some performance overhead may be seen by storing rndm status, in particular
for the case of simplest geometry and small number of tracks per event.

Range : flag>=0 && flag<3

Available Geant4 state(s) : PreInit Idle

Parameters

flag

type i

Omittable : default value = 0

workersProcessCmds

Force workers to process current stack of UI commands.
This commands is meaningful only in MT mode.

Available Geant4 state(s) : PreInit Idle GeomClosed

setCut [cut] [Unit]

Set default cut value

Range : cut >=0.0

Available Geant4 state(s) : PreInit Idle

Parameters

cut	type d
Unit	type s	Omittable : default value = mm	Parameter candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

setCutForAGivenParticle [particleName] [cut] [unit]

Set a cut value to a specific particle
Usage: /run/setCutForAGivenParticle gamma 1. mm

Available Geant4 state(s) : PreInit Idle

Parameters

particleName	type s	Parameter candidates : e- e+ gamma proton
cut	type d	Parameter range : cut>=0.0
unit	type s	Parameter candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

getCutForAGivenParticle [particleName]

Get a cut value to a specific particle
Usage: /run/getCutForAGivenParticle gamma

Available Geant4 state(s) : PreInit Idle GeomClosed EventProc

Parameters

particleName

type s

Parameter candidates : e- e+ gamma proton

setCutForRegion [Region] [cut] [Unit]

Set cut value for a region

Available Geant4 state(s) : Idle

Parameters

Region	type s
cut	type d		Parameter range : cut >=0.0
Unit	type s	Omittable : default value = mm	Parameter candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi