source: trunk/documents/UserDoc/DocBookUsersGuides/IntroductionToGeant4/xml/AllResources/.ls/run.txt @ 1222

/control/manual /run
Command directory path : /run/


Guidance :
Run control commands.

 Sub-directories : 
   /run/particle/   Commands for G4VUserPhysicsList.
 Commands : 
   initialize * Initialize G4 kernel.
   beamOn * Start a Run.
   verbose * Set the Verbose level of G4RunManager.
   dumpRegion * Dump region information.
   dumpCouples * Dump material-cuts-couple information.
   optimizeGeometry * Set the optimization flag for geometry.
   breakAtBeginOfEvent * Set a break point at the begining of every event.
   breakAtEndOfEvent * Set a break point at the end of every event.
   abort * Abort current run processing.
   abortCurrentEvent * Abort currently processing event.
   geometryModified * Force geometry to be closed again.
   cutoffModified * Force closssection tables to be calculated again.
   randomNumberStatusDirectory * Define the directory name of the rndm status files.
   storeRandomNumberStatus * The randomNumberStatus will be saved at :
   restoreRandomNumberStatus * Reset the status of the rndm engine from a file.
   setCut * Set default cut value 
   setCutForRegion * Set cut value for a region


Command /run/initialize
Guidance :
Initialize G4 kernel.



Command /run/beamOn
Guidance :
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.

Parameter : numberOfEvent
 Parameter type  : i
 Omittable       : True
 Default value   : 1
 Parameter range : numberOfEvent >= 0

Parameter : macroFile
 Parameter type  : s
 Omittable       : True
 Default value   : ***NULL***

Parameter : nSelect
 Parameter type  : i
 Omittable       : True
 Default value   : -1
 Parameter range : nSelect>=-1



Command /run/verbose
Guidance :
Set the Verbose level of G4RunManager.
 0 : Silent (default)
 1 : Display main topics
 2 : Display main topics and run summary
 Range of parameters : level >=0 && level <=2

Parameter : level
 Parameter type  : i
 Omittable       : True
 Default value   : 0



Command /run/dumpRegion
Guidance :
Dump region information.
In case name of a region is not given, all regions will be displayed.

Parameter : regionName
 Parameter type  : s
 Omittable       : True
 Default value   : **ALL**



Command /run/dumpCouples
Guidance :
Dump material-cuts-couple information.
Note that material-cuts-couple information is updated
after BeamOn has started.



Command /run/optimizeGeometry
Guidance :
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.

Parameter : optimizeFlag
 Parameter type  : b
 Omittable       : True
 Default value   : 1



Command /run/breakAtBeginOfEvent
Guidance :
Set a break point at the begining of every event.

Parameter : flag
 Parameter type  : b
 Omittable       : True
 Default value   : 1



Command /run/breakAtEndOfEvent
Guidance :
Set a break point at the end of every event.

Parameter : flag
 Parameter type  : b
 Omittable       : True
 Default value   : 1



Command /run/abort
Guidance :
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.

Parameter : softAbort
 Parameter type  : b
 Omittable       : True
 Default value   : 0



Command /run/abortCurrentEvent
Guidance :
Abort currently processing event.



Command /run/geometryModified
Guidance :
Force geometry to be closed again.
This command must be applied
 if geometry has been modified after the
 first initialization (or BeamOn).



Command /run/cutoffModified
Guidance :
Force closssection tables to be calculated again.
This command must be applied
 if cutoff value(s) have been modified after the
 first initialization (or BeamOn).



Command /run/randomNumberStatusDirectory
Guidance :
Define the directory name of the rndm status files.
Directory must be creates before storing the files.

Parameter : fileName
 Parameter type  : s
 Omittable       : True
 Default value   : ./



Command /run/storeRandomNumberStatus
Guidance :
The randomNumberStatus will be saved at :
begining of run (currentRun.rndm) and begining of event (currentEvent.rndm) 

Parameter : flag
 Parameter type  : i
 Omittable       : True
 Default value   : 1



Command /run/restoreRandomNumberStatus
Guidance :
Reset the status of the rndm engine from a file.
See CLHEP manual for detail.
The engine status must be stored beforehand.
Directory of the status file should be set by /random/setDirectoryName.

Parameter : fileName
 Parameter type  : s
 Omittable       : True
 Default value   : currentRun.rndm



Command /run/setCut
Guidance :
Set default cut value 
 Range of parameters : cut >0.0

Parameter : cut
 Parameter type  : d
 Omittable       : False
 Default value   : 1

Parameter : Unit
 Parameter type  : s
 Omittable       : True
 Default value   : mm
 Candidates      : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi



Command /run/setCutForRegion
Guidance :
Set cut value for a region

Parameter : Region
 Parameter type  : s
 Omittable       : False

Parameter : cut
 Parameter type  : d
 Omittable       : False
 Parameter range : cut >0.0

Parameter : Unit
 Parameter type  : s
 Omittable       : True
 Default value   : mm
 Candidates      : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi

Command directory path : /run/particle/


Guidance :
Commands for G4VUserPhysicsList.

 Sub-directories : 
 Commands : 
   verbose * Set the Verbose level of G4VUserPhysicsList.
   setCut * Set default cut value 
   dumpList * Dump List of particles in G4VUserPhysicsList. 
   addProcManager * add process manager to specified particle type
   buildPhysicsTable * build physics table of specified particle type
   storePhysicsTable * Store Physics Table
   retrievePhysicsTable * Retrieve Physics Table
   setStoredInAscii * Switch on/off ascii mode in store/retreive Physics Table
   applyCuts * Set applyCuts flag for a particle.
   dumpCutValues * Dump a list of production threshold values in range and energy


Command /run/particle/verbose
Guidance :
Set the Verbose level of G4VUserPhysicsList.
 0 : Silent (default)
 1 : Display warning messages
 2 : Display more
 Range of parameters : level >=0 && level <=3

Parameter : level
 Parameter type  : i
 Omittable       : True
 Default value   : 0



Command /run/particle/setCut
Guidance :
Set default cut value 
This command is equivallent to /run/setCut command.
This command is kept for backward compatibility.
 Range of parameters : cut >0.0

Parameter : cut
 Parameter type  : d
 Omittable       : False
 Default value   : 1

Parameter : Unit
 Parameter type  : s
 Omittable       : True
 Default value   : mm
 Candidates      : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi



Command /run/particle/dumpList
Guidance :
Dump List of particles in G4VUserPhysicsList. 



Command /run/particle/addProcManager
Guidance :
add process manager to specified particle type

Parameter : particleType
 Parameter type  : s
 Omittable       : True



Command /run/particle/buildPhysicsTable
Guidance :
build physics table of specified particle type

Parameter : particleType
 Parameter type  : s
 Omittable       : True



Command /run/particle/storePhysicsTable
Guidance :
Store Physics Table
  Enter directory name

Parameter : dirName
 Parameter type  : s
 Omittable       : True



Command /run/particle/retrievePhysicsTable
Guidance :
Retrieve Physics Table
  Enter directory name or OFF to switch off

Parameter : dirName
 Parameter type  : s
 Omittable       : True



Command /run/particle/setStoredInAscii
Guidance :
Switch on/off ascii mode in store/retreive Physics Table
  Enter 0(binary) or 1(ascii)
 Range of parameters : ascii ==0 || ascii ==1

Parameter : ascii
 Parameter type  : i
 Omittable       : True
 Default value   : 0



Command /run/particle/applyCuts
Guidance :
Set applyCuts flag for a particle.
 Some EM processes which do not have infrared divergence
may generate gamma, e- and/or e+ with kinetic energies
below the production threshold. By setting this flag,
such secondaries below threshold are eliminated and
kinetic energies of such secondaries are accumulated
to the energy deposition of their mother.
 Note that 'applyCuts' makes sense only for gamma,
e- and e+. If this command is issued for other particle,
a warning message is displayed and the command is
ignored.
 If particle name is 'all', this command affects on
gamma, e- and e+.

Parameter : Flag
 Parameter type  : s
 Omittable       : True
 Default value   : true

Parameter : Particle
 Parameter type  : s
 Omittable       : True
 Default value   : all



Command /run/particle/dumpCutValues
Guidance :
Dump a list of production threshold values in range and energy
for all registered material-cuts-couples.
Dumping a list takes place when you issue 'beamOn' and
actual conversion tables from range to energy are available.
If you want a list 'immediately', use '/run/dumpRegion' for threshold
list given in gange only. Also, '/run/dumpCouples' gives you the
current list if you have already issued 'run/beamOn' at least once.

Parameter : particle
 Parameter type  : s
 Omittable       : True
 Default value   : all