Command ListΒΆ
Command directory path : /
Sub-directories :
/control/ UI control commands.
/units/ Available units.
/profiler/ Profiler controls.
/particle/ Particle control commands.
/geometry/ Geometry control commands.
/tracking/ TrackingManager and SteppingManager control commands.
/event/ EventManager control commands.
/cuts/ Commands for G4VUserPhysicsList.
/run/ Run control commands.
/random/ Random number status control commands.
/process/ Process Table control commands.
/nonMC/ Run control commands.
/material/ Commands for materials
/phys/ Controls of the physics processes
/analysis/ MULASSIS analysis control.
/gps/ General Particle Source control commands.
Commands :
Command directory path : /control/
Guidance :
UI control commands.
Sub-directories :
/control/cout/ Control cout/cerr for local thread.
/control/matScan/ Material scanner commands.
Commands :
macroPath * Set macro search path with colon-separated list.
execute * Execute a macro file.
loop * Execute a macro file more than once.
foreach * Execute a macro file more than once.
suppressAbortion * Suppress the program abortion caused by G4Exception.
verbose * Applied command will also be shown on screen.
useDoublePrecision * Use double precision for printing out the current parameter value(s).
saveHistory * Store command history to a file.
stopSavingHistory * Stop saving history file.
alias * Set an alias.
unalias * Remove an alias.
listAlias * List aliases.
getEnv * Get a shell environment variable and define it as an alias.
getVal * Get the current value of the UI command and define it as an alias.
echo * Display the aliased value.
shell * Execute a (Unix) SHELL command.
manual * Display all of sub-directories and commands.
createHTML * Generate HTML files for all of sub-directories and commands.
maximumStoredHistory * Set maximum number of stored UI commands.
if * Execute a macro file if the expression is true.
doif * Execute a UI command if the expression is true.
add * Define a new alias as the sum of two values.
subtract * Define a new alias as the subtraction of two values.
multiply * Define a new alias as the multiplication of two values.
divide * Define a new alias as the division of two values.
remainder * Define a new alias as the remainder of two values.
strif * Execute a macro file if the expression is true.
strdoif * Execute a UI command if the expression is true.
ifBatch * Execute a macro file if program is running in batch mode.
ifInteractive * Execute a macro file if program is running in interactive mode.
doifBatch * Execute a UI command if program is running in batch mode.
doifInteractive * Execute a UI command if program is running in interactive mode.
Command /control/macroPath
Guidance :
Set macro search path with colon-separated list.
Parameter : path
Parameter type : s
Omittable : False
Command /control/execute
Guidance :
Execute a macro file.
Parameter : fileName
Parameter type : s
Omittable : False
Command /control/loop
Guidance :
Execute a macro file more than once.
Loop counter can be used as an aliased variable.
Parameter : macroFile
Parameter type : s
Omittable : False
Parameter : counterName
Parameter type : s
Omittable : False
Parameter : initialValue
Parameter type : d
Omittable : False
Parameter : finalValue
Parameter type : d
Omittable : False
Parameter : stepSize
Parameter type : d
Omittable : True
Default value : 1
Command /control/foreach
Guidance :
Execute a macro file more than once.
Loop counter can be used as an aliased variable.
Values must be separated by a space.
Parameter : macroFile
Parameter type : s
Omittable : False
Parameter : counterName
Parameter type : s
Omittable : False
Parameter : valueList
Parameter type : s
Omittable : False
Command /control/suppressAbortion
Guidance :
Suppress the program abortion caused by G4Exception.
Suppression level = 0 : no suppression
= 1 : suppress during EventProc state
= 2 : full suppression, i.e. no abortion by G4Exception
When abortion is suppressed, you will get error messages issued by G4Exception,
and there is NO guarantee for the correct result after the G4Exception error message.
Range of parameters : level >= 0 && level <= 2
Parameter : level
Parameter type : i
Omittable : True
Default value : 0
Command /control/verbose
Guidance :
Applied command will also be shown on screen.
This command is useful with MACRO file.
0 : silent
1 : only the valid commands are shown.
2 : comment lines are also shown (default).
Range of parameters : switch >= 0 && switch <=2
Parameter : switch
Parameter type : i
Omittable : True
Default value : 2
Command /control/useDoublePrecision
Guidance :
Use double precision for printing out the current parameter value(s).
Parameter : useDoublePrecision
Parameter type : b
Omittable : True
Default value : 1
Command /control/saveHistory
Guidance :
Store command history to a file.
Defaul file name is G4history.macro.
Parameter : fileName
Parameter type : s
Omittable : True
Default value : G4History.macro
Command /control/stopSavingHistory
Guidance :
Stop saving history file.
Command /control/alias
Guidance :
Set an alias.
String can be aliased by this command.
The string may contain one or more spaces,
the string must be enclosed by double quotes (").
To use an alias, enclose the alias name with
parenthesis "{" and "}".
Parameter : aliasName
Parameter type : s
Omittable : False
Parameter : aliasValue
Parameter type : s
Omittable : False
Command /control/unalias
Guidance :
Remove an alias.
Parameter : aliasName
Parameter type : s
Omittable : False
Command /control/listAlias
Guidance :
List aliases.
Command /control/getEnv
Guidance :
Get a shell environment variable and define it as an alias.
Parameter :
Parameter type : s
Omittable : False
Command /control/getVal
Guidance :
Get the current value of the UI command and define it as an alias.
Command is ignored if the UI command does not support GetCurrentValue().
Syntax : <alias_name> <UI_command> <iIdx>
Parameter : alias_name
Parameter type : s
Omittable : False
Parameter : UI_command
Parameter type : s
Omittable : False
Parameter : iIdx
Parameter type : i
Omittable : True
Default value : 0
Command /control/echo
Guidance :
Display the aliased value.
Parameter :
Parameter type : s
Omittable : False
Command /control/shell
Guidance :
Execute a (Unix) SHELL command.
Parameter :
Parameter type : s
Omittable : False
Command /control/manual
Guidance :
Display all of sub-directories and commands.
Directory path should be given by FULL-PATH.
Parameter : dirPath
Parameter type : s
Omittable : True
Default value : /
Command /control/createHTML
Guidance :
Generate HTML files for all of sub-directories and commands.
Directory path should be given by FULL-PATH.
Parameter : dirPath
Parameter type : s
Omittable : True
Default value : /
Command /control/maximumStoredHistory
Guidance :
Set maximum number of stored UI commands.
Parameter : max
Parameter type : i
Omittable : True
Default value : 20
Command /control/if
Guidance :
Execute a macro file if the expression is true.
Syntax : <double> <comp> <double> <macro_file>
Parameter : left
Parameter type : d
Omittable : False
Parameter : comp
Parameter type : s
Omittable : False
Candidates : > >= < <= == !=
Parameter : right
Parameter type : d
Omittable : False
Parameter : macroFile
Parameter type : s
Omittable : False
Command /control/doif
Guidance :
Execute a UI command if the expression is true.
Syntax : <double> <comp> <double> <UI_command>
Parameter : left
Parameter type : d
Omittable : False
Parameter : comp
Parameter type : s
Omittable : False
Candidates : > >= < <= == !=
Parameter : right
Parameter type : d
Omittable : False
Parameter : UI_command
Parameter type : s
Omittable : False
Command /control/add
Guidance :
Define a new alias as the sum of two values.
Syntax : <new_alias> <value1> <value2>
<new_alias> may be an already existing alias. If it is the case,
aliased value is alternated.
Parameter : new_alias
Parameter type : s
Omittable : False
Parameter : value1
Parameter type : d
Omittable : False
Parameter : value2
Parameter type : d
Omittable : False
Command /control/subtract
Guidance :
Define a new alias as the subtraction of two values.
Syntax : <new_alias> <value1> <value2>
<new_alias> may be an already existing alias. If it is the case,
aliased value is alternated.
Parameter : new_alias
Parameter type : s
Omittable : False
Parameter : value1
Parameter type : d
Omittable : False
Parameter : value2
Parameter type : d
Omittable : False
Command /control/multiply
Guidance :
Define a new alias as the multiplication of two values.
Syntax : <new_alias> <value1> <value2>
<new_alias> may be an already existing alias. If it is the case,
aliased value is alternated.
Parameter : new_alias
Parameter type : s
Omittable : False
Parameter : value1
Parameter type : d
Omittable : False
Parameter : value2
Parameter type : d
Omittable : False
Command /control/divide
Guidance :
Define a new alias as the division of two values.
Syntax : <new_alias> <value1> <value2>
<new_alias> may be an already existing alias. If it is the case,
aliased value is alternated.
Parameter : new_alias
Parameter type : s
Omittable : False
Parameter : value1
Parameter type : d
Omittable : False
Parameter : value2
Parameter type : d
Omittable : False
Parameter range : value2 != 0
Command /control/remainder
Guidance :
Define a new alias as the remainder of two values.
Syntax : <new_alias> <value1> <value2>
<new_alias> may be an already existing alias. If it is the case,
aliased value is alternated.
Parameter : new_alias
Parameter type : s
Omittable : False
Parameter : value1
Parameter type : i
Omittable : False
Parameter : value2
Parameter type : i
Omittable : False
Command /control/strif
Guidance :
Execute a macro file if the expression is true.
Syntax : <string> <comp> <string> <macro_file>
Parameter : left
Parameter type : s
Omittable : False
Parameter : comp
Parameter type : s
Omittable : False
Candidates : == !=
Parameter : right
Parameter type : s
Omittable : False
Parameter : macroFile
Parameter type : s
Omittable : False
Command /control/strdoif
Guidance :
Execute a UI command if the expression is true.
Syntax : <string> <comp> <string> <UI_command>
Parameter : left
Parameter type : s
Omittable : False
Parameter : comp
Parameter type : s
Omittable : False
Candidates : == !=
Parameter : right
Parameter type : s
Omittable : False
Parameter : UI_command
Parameter type : s
Omittable : False
Command /control/ifBatch
Guidance :
Execute a macro file if program is running in batch mode.
Parameter : macroFile
Parameter type : s
Omittable : False
Command /control/ifInteractive
Guidance :
Execute a macro file if program is running in interactive mode.
Parameter : macroFile
Parameter type : s
Omittable : False
Command /control/doifBatch
Guidance :
Execute a UI command if program is running in batch mode.
Parameter : UIcommand
Parameter type : s
Omittable : False
Command /control/doifInteractive
Guidance :
Execute a UI command if program is running in interactive mode.
Parameter : UIcommand
Parameter type : s
Omittable : False
Command directory path : /control/cout/
Guidance :
Control cout/cerr for local thread.
Sub-directories :
Commands :
setCoutFile * Send G4cout stream to a file dedicated to a thread.
setCerrFile * Send G4cerr stream to a file dedicated to a thread.
useBuffer * Send cout and/or cerr stream to a buffer.
prefixString * Set the prefix string for each cout/cerr line from a thread.
ignoreThreadsExcept * Omit cout from threads except the specified one.
ignoreInitializationCout * Omit cout from threads during initialization, as they should be identical to the master thread.
Command /control/cout/setCoutFile
Guidance :
Send G4cout stream to a file dedicated to a thread.
To have a display output, use special keyword "**Screen**".
If append flag is true output is appended to file,
otherwise file output is overwritten.
Parameter : fileName
Parameter type : s
Omittable : True
Default value : **Screen**
Parameter : append
Parameter type : b
Omittable : True
Default value : 1
Command /control/cout/setCerrFile
Guidance :
Send G4cerr stream to a file dedicated to a thread.
To have a display output, use special keyword "**Screen**".
If append flag is true output is appended to file,
otherwise file output is overwritten.
Parameter : fileName
Parameter type : s
Omittable : True
Default value : **Screen**
Parameter : append
Parameter type : b
Omittable : True
Default value : 1
Command /control/cout/useBuffer
Guidance :
Send cout and/or cerr stream to a buffer.
The buffered text will be printed at the end of the job
for each thread at a time, so that output of each thread is grouped.
This command has no effect if output goes to a file.
Parameter : flag
Parameter type : b
Omittable : True
Default value : 1
Command /control/cout/prefixString
Guidance :
Set the prefix string for each cout/cerr line from a thread.
Parameter : prefix
Parameter type : s
Omittable : True
Default value : G4WT
Command /control/cout/ignoreThreadsExcept
Guidance :
Omit cout from threads except the specified one.
This command takes effect only if cout destination is screen without buffering.
If specified thread ID is greater than the number of threads,
no cout is displayed from worker threads. -1 to reset.
This command does not affect to cerr.
Parameter : threadID
Parameter type : i
Omittable : True
Default value : 0
Command /control/cout/ignoreInitializationCout
Guidance :
Omit cout from threads during initialization, as they should be identical to the master thread.
This command takes effect only if cout destination is screen without buffering.
This command does not affect to cerr.
Parameter : IgnoreInit
Parameter type : b
Omittable : True
Default value : 1
Command directory path : /control/matScan/
Guidance :
Material scanner commands.
Sub-directories :
Commands :
scan * Start material scanning.
theta * Define theta range.
phi * Define phi range.
singleMeasure * Measure thickness for one particular direction.
singleTo * Measure thickness for one direction defined by a unit vector.
eyePosition * Define the eye position.
regionSensitive * Set region sensitivity.
region * Define region name to be scanned.
Command /control/matScan/scan
Guidance :
Start material scanning.
Scanning range should be defined with
/control/matScan/theta and /control/matSca/phi commands.
Command /control/matScan/theta
Guidance :
Define theta range.
Usage : /control/matScan/theta [nbin] [thetaMin] [thetaSpan] [unit]
Notation of angles :
theta --- +Z axis : +90 deg. / X-Y plane : 0 deg. / -Z axis : -90 deg.
Parameter : nbin
Parameter type : i
Omittable : False
Parameter range : nbin>0
Parameter : thetaMin
Parameter type : d
Omittable : False
Parameter : thetaSpan
Parameter type : d
Omittable : True
Default value : 0
Parameter range : thetaSpan>=0.
Parameter : unit
Parameter type : c
Omittable : True
Default value : deg
Candidates : rad mrad deg radian milliradian degree
Command /control/matScan/phi
Guidance :
Define phi range.
Usage : /control/matScan/phi [nbin] [phiMin] [phiSpan] [unit]
Notation of angles :
phi --- +X axis : 0 deg. / +Y axis : 90 deg. / -X axis : 180 deg. / -Y axis : 270 deg.
Parameter : nbin
Parameter type : i
Omittable : False
Parameter range : nbin>0
Parameter : phiMin
Parameter type : d
Omittable : False
Parameter : phiSpan
Parameter type : d
Omittable : True
Default value : 0
Parameter range : phiSpan>=0.
Parameter : unit
Parameter type : c
Omittable : True
Default value : deg
Candidates : rad mrad deg radian milliradian degree
Command /control/matScan/singleMeasure
Guidance :
Measure thickness for one particular direction.
Notation of angles :
theta --- +Z axis : +90 deg. / X-Y plane : 0 deg. / -Z axis : -90 deg.
phi --- +X axis : 0 deg. / +Y axis : 90 deg. / -X axis : 180 deg. / -Y axis : 270 deg.
Parameter : theta
Parameter type : d
Omittable : False
Parameter : phi
Parameter type : d
Omittable : False
Parameter : unit
Parameter type : c
Omittable : True
Default value : deg
Candidates : rad mrad deg radian milliradian degree
Command /control/matScan/singleTo
Guidance :
Measure thickness for one direction defined by a unit vector.
Parameter : X
Parameter type : d
Omittable : False
Parameter : Y
Parameter type : d
Omittable : False
Parameter : Z
Parameter type : d
Omittable : False
Command /control/matScan/eyePosition
Guidance :
Define the eye position.
Parameter : X
Parameter type : d
Omittable : True
Default value : 0
Parameter : Y
Parameter type : d
Omittable : True
Default value : 0
Parameter : Z
Parameter type : d
Omittable : True
Default value : 0
Parameter : Unit
Parameter type : s
Omittable : True
Default value : m
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /control/matScan/regionSensitive
Guidance :
Set region sensitivity.
This command is automatically set to TRUE
if /control/matScan/region command is issued.
Parameter : senseFlag
Parameter type : b
Omittable : True
Default value : 0
Command /control/matScan/region
Guidance :
Define region name to be scanned.
/control/matScan/regionSensitive command is automatically
set to TRUE with this command.
Parameter : region
Parameter type : s
Omittable : True
Default value : DefaultRegionForTheWorld
Command directory path : /units/
Guidance :
Available units.
Sub-directories :
Commands :
list * full list of available units.
Command /units/list
Guidance :
full list of available units.
Command directory path : /profiler/
Guidance :
Profiler controls.
Sub-directories :
/profiler/output/ Control the output modes of the profiler.
/profiler/run/ Profiler controls at the G4Run level
/profiler/event/ Profiler controls at the G4Event level
/profiler/track/ Profiler controls at the G4Track level
/profiler/step/ Profiler controls at the G4Step level
/profiler/user/ Profiler controls within user code
Commands :
tree * Display the results as a call-stack hierarchy.
flat * Display the results as a flat call-stack
timeline * Do not merge duplicate entries at the same call-stack position. May be combined with tree or flat profiles.
per_thread * Display the results for each individual thread (default: aggregation)
per_event * Display the results for each individual G4event (default: aggregation)
Command /profiler/tree
Guidance :
Display the results as a call-stack hierarchy.
Parameter :
Parameter type : b
Omittable : False
Default value : 1
Command /profiler/flat
Guidance :
Display the results as a flat call-stack
Parameter :
Parameter type : b
Omittable : False
Default value : 0
Command /profiler/timeline
Guidance :
Do not merge duplicate entries at the same call-stack position. May be combined with tree or flat profiles.
Parameter :
Parameter type : b
Omittable : False
Default value : 0
Command /profiler/per_thread
Guidance :
Display the results for each individual thread (default: aggregation)
Parameter :
Parameter type : b
Omittable : False
Default value : 0
Command /profiler/per_event
Guidance :
Display the results for each individual G4event (default: aggregation)
Parameter :
Parameter type : b
Omittable : False
Default value : 0
Command directory path : /profiler/output/
Guidance :
Control the output modes of the profiler.
Sub-directories :
Commands :
dart * Enabled Dart output (CTest/CDash data tracking)
json * Enabled JSON output
text * Enabled text output
cout * Enabled output to console
plot * Enabled plotting JSON output
Command /profiler/output/dart
Guidance :
Enabled Dart output (CTest/CDash data tracking)
Parameter :
Parameter type : b
Omittable : False
Default value : 0
Command /profiler/output/json
Guidance :
Enabled JSON output
Parameter :
Parameter type : b
Omittable : False
Default value : 1
Command /profiler/output/text
Guidance :
Enabled text output
Parameter :
Parameter type : b
Omittable : False
Default value : 1
Command /profiler/output/cout
Guidance :
Enabled output to console
Parameter :
Parameter type : b
Omittable : False
Default value : 0
Command /profiler/output/plot
Guidance :
Enabled plotting JSON output
Parameter :
Parameter type : b
Omittable : False
Default value : 0
Command directory path : /profiler/run/
Guidance :
Profiler controls at the G4Run level
Sub-directories :
Commands :
enable * Record metrics for each G4Run
components * Measurment types to record for each G4Run (see `timemory-avail -s`)
Command /profiler/run/enable
Guidance :
Record metrics for each G4Run
Parameter :
Parameter type : b
Omittable : False
Default value : 1
Command /profiler/run/components
Guidance :
Measurment types to record for each G4Run (see `timemory-avail -s`)
Parameter :
Parameter type : s
Omittable : False
Default value : wall_clock, cpu_clock, cpu_util, peak_rss
Command directory path : /profiler/event/
Guidance :
Profiler controls at the G4Event level
Sub-directories :
Commands :
enable * Record metrics for each G4Event
components * Measurment types to record for each G4Event (see `timemory-avail -s`)
Command /profiler/event/enable
Guidance :
Record metrics for each G4Event
Parameter :
Parameter type : b
Omittable : False
Default value : 1
Command /profiler/event/components
Guidance :
Measurment types to record for each G4Event (see `timemory-avail -s`)
Parameter :
Parameter type : s
Omittable : False
Default value : wall_clock, cpu_clock, cpu_util, peak_rss
Command directory path : /profiler/track/
Guidance :
Profiler controls at the G4Track level
Sub-directories :
Commands :
enable * Record metrics for each G4Track
components * Measurment types to record for each G4Track (see `timemory-avail -s`)
Command /profiler/track/enable
Guidance :
Record metrics for each G4Track
Parameter :
Parameter type : b
Omittable : False
Default value : 0
Command /profiler/track/components
Guidance :
Measurment types to record for each G4Track (see `timemory-avail -s`)
Parameter :
Parameter type : s
Omittable : False
Default value : wall_clock, cpu_clock, cpu_util, peak_rss
Command directory path : /profiler/step/
Guidance :
Profiler controls at the G4Step level
Sub-directories :
Commands :
enable * Record metrics for each G4Step
components * Measurment types to record for each G4Step (see `timemory-avail -s`)
Command /profiler/step/enable
Guidance :
Record metrics for each G4Step
Parameter :
Parameter type : b
Omittable : False
Default value : 0
Command /profiler/step/components
Guidance :
Measurment types to record for each G4Step (see `timemory-avail -s`)
Parameter :
Parameter type : s
Omittable : False
Default value : wall_clock, cpu_clock, cpu_util, peak_rss
Command directory path : /profiler/user/
Guidance :
Profiler controls within user code
Sub-directories :
Commands :
enable * Record metrics for user specified profiling instances
components * Measurment types to record for user specified profiling instances (see `timemory-avail -s`)
Command /profiler/user/enable
Guidance :
Record metrics for user specified profiling instances
Parameter :
Parameter type : b
Omittable : False
Default value : 1
Command /profiler/user/components
Guidance :
Measurment types to record for user specified profiling instances (see `timemory-avail -s`)
Parameter :
Parameter type : s
Omittable : False
Default value : wall_clock, cpu_clock, cpu_util, peak_rss
Command directory path : /particle/
Guidance :
Particle control commands.
Sub-directories :
/particle/nuclideTable/ Nuclide table control commands.
/particle/property/ Particle Table control commands.
Commands :
select * Select particle
list * List name of particles.
find * Find particle by encoding
createAllIon * Create All ions (ground state)
createAllIsomer * Create All isomers
verbose * Set Verbose level of particle table.
Command /particle/select
Guidance :
Select particle
Parameter : particle name
Parameter type : s
Omittable : False
Default value : none
Command /particle/list
Guidance :
List name of particles.
all(default)/lepton/baryon/meson/nucleus/quarks
Parameter : particle type
Parameter type : s
Omittable : True
Default value : all
Candidates : all lepton baryon meson nucleus quarks
Command /particle/find
Guidance :
Find particle by encoding
Parameter : encoding
Parameter type : i
Omittable : False
Default value : 0
Command /particle/createAllIon
Guidance :
Create All ions (ground state)
Command /particle/createAllIsomer
Guidance :
Create All isomers
Command /particle/verbose
Guidance :
Set Verbose level of particle table.
0 : Silent (default)
1 : Display warning messages
2 : Display more
Range of parameters : verbose_level >=0
Parameter : verbose_level
Parameter type : i
Omittable : True
Default value : 0
Command directory path : /particle/nuclideTable/
Guidance :
Nuclide table control commands.
Sub-directories :
Commands :
min_halflife * Set threshold of half-life.
level_tolerance * Set tolerance in level searching.
Command /particle/nuclideTable/min_halflife
Guidance :
Set threshold of half-life.
Unit of the time can be :
s, ms, ns (default)
Range of parameters : life >0.0
Parameter : life
Parameter type : d
Omittable : False
Default value : 1000
Parameter : Unit
Parameter type : s
Omittable : True
Default value : ns
Candidates : s ms us ns ps second millisecond microsecond nanosecond picosecond
Command /particle/nuclideTable/level_tolerance
Guidance :
Set tolerance in level searching.
Unit of the energy can be :
MeV, keV, eV (default)
Range of parameters : lTolerance >0.0
Parameter : lTolerance
Parameter type : d
Omittable : False
Default value : 1
Parameter : Unit
Parameter type : s
Omittable : True
Default value : eV
Candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
Command directory path : /particle/property/
Guidance :
Particle Table control commands.
Sub-directories :
/particle/property/decay/ Decay Table control commands.
Commands :
dump * Dump particle properties.
stable * Set stable flag.
lifetime * Set life time.
verbose * Set Verbose level of particle property.
Command /particle/property/dump
Guidance :
Dump particle properties.
Command /particle/property/stable
Guidance :
Set stable flag.
false: Unstable true: Stable
Parameter : stable
Parameter type : b
Omittable : False
Command /particle/property/lifetime
Guidance :
Set life time.
Unit of the time can be :
s, ms, ns (default)
Range of parameters : life >0.0
Parameter : life
Parameter type : d
Omittable : False
Default value : 0
Parameter : Unit
Parameter type : s
Omittable : True
Default value : ns
Candidates : s ms us ns ps second millisecond microsecond nanosecond picosecond
Command /particle/property/verbose
Guidance :
Set Verbose level of particle property.
0 : Silent (default)
1 : Display warning messages
2 : Display more
Range of parameters : verbose_level >=0
Parameter : verbose_level
Parameter type : i
Omittable : True
Default value : 0
Command directory path : /particle/property/decay/
Guidance :
Decay Table control commands.
Sub-directories :
Commands :
select * Enter index of decay mode.
dump * Dump decay mode information.
br * Set branching ratio. [0< BR <1.0]
Command /particle/property/decay/select
Guidance :
Enter index of decay mode.
Range of parameters : mode >=0
Parameter : mode
Parameter type : i
Omittable : True
Default value : 0
Command /particle/property/decay/dump
Guidance :
Dump decay mode information.
Command /particle/property/decay/br
Guidance :
Set branching ratio. [0< BR <1.0]
Range of parameters : (br >=0.0) && (br <=1.0)
Parameter : br
Parameter type : d
Omittable : False
Command directory path : /geometry/
Guidance :
Geometry control commands.
Sub-directories :
/geometry/navigator/ Geometry navigator control setup.
/geometry/test/ Geometry verification control setup.
/geometry/material/ Controls for defining geometry materials
/geometry/colour/ Controls for defining geometry colours.
/geometry/layer/ Controls for defining the layers.
Commands :
xysize * Sets the size of the X-Y sides for a Slab geometry.
default * use default geometry.
update * Update geometry.
setGPSsource * Sets the GPS source location and direction to the position required by Mulassis.
Command /geometry/xysize
Guidance :
Sets the size of the X-Y sides for a Slab geometry.
The default is for Mulassis to set it to 100 times the thickness of the layers.
Parameter : XYSize
Parameter type : d
Omittable : False
Default value : -1
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : um mm cm m km
Command /geometry/default
Guidance :
use default geometry.
Command /geometry/update
Guidance :
Update geometry.
This command MUST be applied before "beamOn"
if you have changed the geometry.
Command /geometry/setGPSsource
Guidance :
Sets the GPS source location and direction to the position required by Mulassis.
Command directory path : /geometry/navigator/
Guidance :
Geometry navigator control setup.
Sub-directories :
Commands :
reset * Reset navigator and navigation history.
verbose * Set run-time verbosity for the navigator.
check_mode * Set navigator in -check_mode- state.
push_notify * Set navigator verbosity push notifications.
Command /geometry/navigator/reset
Guidance :
Reset navigator and navigation history.
NOTE: must be called only after kernel has been
initialized once through the run manager!
Command /geometry/navigator/verbose
Guidance :
Set run-time verbosity for the navigator.
0 : Silent (default)
1 : Display volume positioning and step lengths
2 : Display step/safety info on point location
3 : Display minimal state at -every- step
4 : Maximum verbosity (very detailed!)
NOTE: this command has effect -only- if Geant4 has
been installed with the G4VERBOSE flag set!
Range of parameters : level >=0 && level <=4
Parameter : level
Parameter type : i
Omittable : True
Default value : 0
Command /geometry/navigator/check_mode
Guidance :
Set navigator in -check_mode- state.
This will cause extra checks to be applied during
navigation. More strict and less tolerant conditions
are applied. A run-time performance penalty may be
observed when the -check_mode- state is activated.
NOTE: this command has effect -only- if Geant4 has
been installed with the G4VERBOSE flag set!
Parameter : checkFlag
Parameter type : b
Omittable : True
Default value : 0
Command /geometry/navigator/push_notify
Guidance :
Set navigator verbosity push notifications.
This allows one to disable/re-enable verbosity in
navigation, when tracks may get stuck and require
one artificial push along the direction by the
navigator. Notification is active by default.
NOTE: this command has effect -only- if Geant4 has
been installed with the G4VERBOSE flag set!
Parameter : pushFlag
Parameter type : b
Omittable : True
Default value : 1
Command directory path : /geometry/test/
Guidance :
Geometry verification control setup.
Helps in detecting possible overlapping regions.
Sub-directories :
Commands :
tolerance * Define tolerance (in mm) by which overlaps reports
verbosity * Specify if running in verbosity mode or not.
resolution * Set the number of points on surface to be generated for
recursion_start * Set the initial level in the geometry tree for recursion.
recursion_depth * Set the depth in the geometry tree for recursion.
maximum_errors * Set the maximum number of overlap errors to report
run * Start running the recursive overlap check.
Command /geometry/test/tolerance
Guidance :
Define tolerance (in mm) by which overlaps reports
should be reported. By default, all overlaps are
reported, i.e. tolerance is set to: 0*mm.
Parameter : Tolerance
Parameter type : d
Omittable : True
Default value : taken from the current value
Parameter : Unit
Parameter type : s
Omittable : True
Default value : mm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /geometry/test/verbosity
Guidance :
Specify if running in verbosity mode or not.
By default verbosity is set to ON (TRUE).
Parameter : verbosity
Parameter type : b
Omittable : True
Default value : 1
Command /geometry/test/resolution
Guidance :
Set the number of points on surface to be generated for
checking overlaps.
Parameter : resolution
Parameter type : i
Omittable : True
Default value : 10000
Command /geometry/test/recursion_start
Guidance :
Set the initial level in the geometry tree for recursion.
recursive_test will then start from the specified level.
Parameter : initial_level
Parameter type : i
Omittable : True
Default value : 0
Command /geometry/test/recursion_depth
Guidance :
Set the depth in the geometry tree for recursion.
recursive_test will then stop after reached the specified depth.
By default, recursion will proceed for the whole depth.
Parameter : recursion_depth
Parameter type : i
Omittable : True
Default value : -1
Command /geometry/test/maximum_errors
Guidance :
Set the maximum number of overlap errors to report
for each single volume being checked.
Once reached the maximum number specified, overlaps
affecting that volume further than that are simply ignored.
Parameter : maximum_errors
Parameter type : i
Omittable : True
Default value : 1
Command /geometry/test/run
Guidance :
Start running the recursive overlap check.
Volumes are recursively asked to verify for overlaps
for points generated on the surface against their
respective mother volume and sisters at the same
level, performing for all daughters and daughters of
daughters, etc.
NOTE: it may take a very long time,
depending on the geometry complexity !
Command directory path : /geometry/material/
Guidance :
Controls for defining geometry materials
Sub-directories :
Commands :
add * add a mateial by name, composition formula and density
addNIST * Add a predefined Geant4 NIST material
listNIST * List the predefined Geant4 NIST materials
delete * Delete material by its index
deleteName * Delete material by its name.
list * List the materials defined
Command /geometry/material/add
Guidance :
add a mateial by name, composition formula and density
name: e.g. water
formula (e.g. H2-O for water
density (in units of g/cm3) : den>0.
Parameter : material
material name
Parameter type : s
Omittable : False
Parameter : formula
material formula
Parameter type : s
Omittable : False
Parameter : density
density of the material
Parameter type : d
Omittable : False
Parameter range : density >0.
Parameter : state
state of the material (optional): gas | solid
Parameter type : s
Omittable : True
Parameter : temp
temperature of the material in Kelvin (optional)
Parameter type : d
Omittable : True
Parameter : pres
pressure of the gas material in Pascal (optional)
Parameter type : d
Omittable : True
Command /geometry/material/addNIST
Guidance :
Add a predefined Geant4 NIST material
Parameter : NISTmaterial
Parameter type : s
Omittable : False
Command /geometry/material/listNIST
Guidance :
List the predefined Geant4 NIST materials
Parameter : type
Parameter type : s
Omittable : True
Default value : taken from the current value
Candidates : all simple compound hep
Command /geometry/material/delete
Guidance :
Delete material by its index
Range of parameters : matIdx>=0 && matIdx<100
Parameter : matIdx
Parameter type : i
Omittable : False
Command /geometry/material/deleteName
Guidance :
Delete material by its name.
Parameter : DeleteName
Parameter type : s
Omittable : False
Command /geometry/material/list
Guidance :
List the materials defined
Command directory path : /geometry/colour/
Guidance :
Controls for defining geometry colours.
Sub-directories :
Commands :
add * Add a colour by its name and RGB intensities.
list * List the colours defined.
Command /geometry/colour/add
Guidance :
Add a colour by its name and RGB intensities.
0. <= RGBs <= 1.
Parameter : colour
colour name
Parameter type : s
Omittable : False
Parameter : red
red component
Parameter type : d
Omittable : False
Parameter range : red >= 0. && red <= 1.
Parameter : green
green component
Parameter type : d
Omittable : False
Parameter range : green >= 0. && green <= 1.
Parameter : blue
blue component
Parameter type : d
Omittable : False
Parameter range : blue >= 0. && blue <= 1.
Command /geometry/colour/list
Guidance :
List the colours defined.
Command directory path : /geometry/layer/
Guidance :
Controls for defining the layers.
Sub-directories :
Commands :
shape * Select the geometry shape.
delete * Delete a layer or all layers.
list * List a layer or all layers.
add * Add a layer after layer NL, of material MA, colour index CI and thickness (unit).
Command /geometry/layer/shape
Guidance :
Select the geometry shape.
slab or sphere
Parameter : Shape
Parameter type : s
Omittable : False
Candidates : slab SLAB sphere SPHERE
Command /geometry/layer/delete
Guidance :
Delete a layer or all layers.
(If Nb = 0 : all layers are deleted)
Range of parameters : Delete >= 0
Parameter : Delete
Parameter type : i
Omittable : False
Command /geometry/layer/list
Guidance :
List a layer or all layers.
(If Nb = 0: all layers are listed
Range of parameters : List >= 0
Parameter : List
Parameter type : i
Omittable : True
Default value : 0
Command /geometry/layer/add
Guidance :
Add a layer after layer NL, of material MA, colour index CI and thickness (unit).
position is after layer NL: (NL>=0 && NL <= NbOfLayers)
material: name
colour index: ci >0 && <= 12
thickness (with unit) : t>0.
Parameter : AddNb
position number : from 0 to NbOfLayers
Parameter type : i
Omittable : False
Parameter range : AddNb >= 0
Parameter : material
material name : from the material list
Parameter type : s
Omittable : False
Parameter : colour
colour index : from 1 to 12 (default max)
Parameter type : i
Omittable : False
Parameter range : colour>0
Parameter : thickness
thickness of absorber
Parameter type : d
Omittable : False
Parameter range : thickness>0.
Parameter : unit
unit of thickness
Parameter type : s
Omittable : False
Candidates : um mm cm m km mg/cm2 g/cm2 kg/m2 mil
Command directory path : /tracking/
Guidance :
TrackingManager and SteppingManager control commands.
Sub-directories :
Commands :
abort * Abort current G4Track processing.
resume * Resume current G4Track processing.
storeTrajectory * Store trajectories or not.
verbose * Set Verbose level of tracking category.
Command /tracking/abort
Guidance :
Abort current G4Track processing.
Command /tracking/resume
Guidance :
Resume current G4Track processing.
Command /tracking/storeTrajectory
Guidance :
Store trajectories or not.
0 : Don't Store trajectories.
!=0 : Store trajectories.
1 : Choose G4Trajectory as default.
2 : Choose G4SmoothTrajectory as default.
3 : Choose G4RichTrajectory as default.
4 : Choose G4RichTrajectory with auxiliary points as default.
Range of parameters : Store >=0 && Store <= 4
Parameter : Store
Parameter type : i
Omittable : True
Default value : 0
Command /tracking/verbose
Guidance :
Set Verbose level of tracking category.
-1 : Silent.
0 : Silent.
1 : Minimum information of each Step.
2 : Addition to Level=1, info of secondary particles.
3 : Addition to Level=1, pre/postStepoint information
after all AlongStep/PostStep process executions.
4 : Addition to Level=3, pre/postStepoint information
at each AlongStepPostStep process execution.
5 : Addition to Level=4, proposed Step length information
from each AlongStepPostStep process.
Range of parameters : verbose_level >=-1
Parameter : verbose_level
Parameter type : i
Omittable : True
Default value : 0
Command directory path : /event/
Guidance :
EventManager control commands.
Sub-directories :
/event/stack/ Stack control commands.
Commands :
abort * Abort current event.
verbose * Set Verbose level of event management category.
keepCurrentEvent * Store the current event to G4Run object instead of deleting it at the end of event.
drawTracks * Draw the tracks in the event
printModulo * Print events modulo n
Command /event/abort
Guidance :
Abort current event.
Command /event/verbose
Guidance :
Set Verbose level of event management category.
0 : Silent
1 : Stacking information
2 : More...
Range of parameters : level>=0
Parameter : level
Parameter type : i
Omittable : False
Command /event/keepCurrentEvent
Guidance :
Store the current event to G4Run object instead of deleting it at the end of event.
Stored event is available through G4Run until the beginning of next run.
Given the potential large memory size of G4Event and its data-member objects stored in G4Event,
the user must be careful and responsible for not to store too many G4Event objects.
Command /event/drawTracks
Guidance :
Draw the tracks in the event
Choice : none, charged(default), all
Parameter : choice
Parameter type : s
Omittable : True
Default value : charged
Candidates : none charged all
Command /event/printModulo
Guidance :
Print events modulo n
Range of parameters : EventNb>0
Parameter : EventNb
Parameter type : i
Omittable : False
Command directory path : /event/stack/
Guidance :
Stack control commands.
Sub-directories :
Commands :
status * List current status of the stack.
clear * Clear stacked tracks.
verbose * Set verbose level for G4StackManager
Command /event/stack/status
Guidance :
List current status of the stack.
Command /event/stack/clear
Guidance :
Clear stacked tracks.
2 : clear all tracks in all stacks
1 : clear tracks in the urgent and waiting stacks
0 : clear tracks in the waiting stack (default)
-1 : clear tracks in the urgent stack
-2 : clear tracks in the postponed stack
Range of parameters : level>=-2&&level<=2
Parameter : level
Parameter type : i
Omittable : True
Default value : 0
Command /event/stack/verbose
Guidance :
Set verbose level for G4StackManager
0 : Silence (default)
1 : Minimum statistics
2 : Detailed reports
Note - this value is overwritten by /event/verbose command.
Parameter :
Parameter type : i
Omittable : False
Command directory path : /cuts/
Guidance :
Commands for G4VUserPhysicsList.
Sub-directories :
Commands :
verbose * Set the Verbose level of G4ProductionCutsTable.
setLowEdge * Set low edge energy value
setHighEdge * Set high edge energy value
setMaxCutEnergy * Set maximum of cut energy value
dump * Dump couples in G4ProductionCutsTable.
Command /cuts/verbose
Guidance :
Set the Verbose level of G4ProductionCutsTable.
0 : Silent (default)
1 : Display warning messages
2 : Display more info
2 : Display debug info
Range of parameters : level >=0 && level <=3
Parameter : level
Parameter type : i
Omittable : True
Default value : 0
Command /cuts/setLowEdge
Guidance :
Set low edge energy value
Range of parameters : edge >0.0
Parameter : edge
Parameter type : d
Omittable : False
Default value : 0.99
Parameter : Unit
Parameter type : s
Omittable : True
Default value : keV
Candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
Command /cuts/setHighEdge
Guidance :
Set high edge energy value
Range of parameters : edge >0.0
Parameter : edge
Parameter type : d
Omittable : False
Default value : 100
Parameter : Unit
Parameter type : s
Omittable : True
Default value : TeV
Candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
Command /cuts/setMaxCutEnergy
Guidance :
Set maximum of cut energy value
Range of parameters : cut >0.0
Parameter : cut
Parameter type : d
Omittable : False
Default value : 10
Parameter : Unit
Parameter type : s
Omittable : True
Default value : GeV
Candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
Command /cuts/dump
Guidance :
Dump couples in G4ProductionCutsTable.
Command directory path : /run/
Guidance :
Run control commands.
Sub-directories :
/run/progressControl/ Application run progress controls
/run/particle/ Commands for G4VUserPhysicsList.
Commands :
initialize * Initialize G4 kernel.
beamOn * Start a Run.
verbose * Set the Verbose level of G4RunManager.
printProgress * Display begin_of_event information at given frequency.
numberOfThreads * Set the number of threads to be used.
useMaximumLogicalCores * Set the number of threads to be the number of available logical cores.
pinAffinity * Locks each thread to a specific logical core. Workers are locked in round robin to logical cores.
eventModulo * Set the event modulo for dispatching events to worker threads
dumpRegion * Dump region information.
dumpCouples * Dump material-cuts-couple information.
optimizeGeometry * Set the optimization flag for geometry.
breakAtBeginOfEvent * Set a break point at the beginning 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 (re-voxellized) again.
reinitializeGeometry * Force geometry to be rebuilt once again.
physicsModified * Force all physics tables recalculated again.
constructScoringWorlds * Construct scoring parallel world(s) if defined.
storeRndmStatToEvent * Flag to store rndm status to G4Event object.
workersProcessCmds * Force workers to process current stack of UI commands.
setCut * Set default cut value
setCutForAGivenParticle * Set a cut value to a specific particle
getCutForAGivenParticle * Get a cut value to a specific particle
setCutForRegion * Set cut value for a region
cputime * Set the cputime limit (in seconds) for the run
randseed * Set the seed for random engine to one of the predefined values (0-214)
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/printProgress
Guidance :
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 of parameters : mod>=-1
Parameter : mod
Parameter type : i
Omittable : True
Default value : -1
Command /run/numberOfThreads
Guidance :
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 of parameters : nThreads >0
Parameter : nThreads
Parameter type : i
Omittable : True
Default value : 2
Command /run/useMaximumLogicalCores
Guidance :
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.
Command /run/pinAffinity
Guidance :
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 of parameters : pinAffinity > 0 || pinAffinity < 0
Parameter : pinAffinity
Parameter type : i
Omittable : True
Default value : 1
Command /run/eventModulo
Guidance :
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.
Parameter : N
Parameter type : i
Omittable : True
Default value : 0
Parameter range : N >= 0
Parameter : seedOnce
Parameter type : i
Omittable : True
Default value : 0
Parameter range : seedOnce >= 0 && seedOnce <=2
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 beginning 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 (re-voxellized) again.
This command must be applied if geometry has been modified
after the first initialization (or BeamOn).
Command /run/reinitializeGeometry
Guidance :
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.
Parameter : destroyFirst
Parameter type : b
Omittable : True
Default value : 0
Command /run/physicsModified
Guidance :
Force all physics tables recalculated again.
This command must be applied
if physics process has been modified after the
first initialization (or BeamOn).
Command /run/constructScoringWorlds
Guidance :
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.
Command /run/storeRndmStatToEvent
Guidance :
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 of parameters : flag>=0 && flag<=3
Parameter : flag
Parameter type : i
Omittable : True
Default value : 0
Command /run/workersProcessCmds
Guidance :
Force workers to process current stack of UI commands.
This commands is meaningful only in MT mode.
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 um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /run/setCutForAGivenParticle
Guidance :
Set a cut value to a specific particle
Usage: /run/setCutForAGivenParticle gamma 1. mm
Parameter : particleName
Parameter type : s
Omittable : False
Candidates : e- e+ gamma proton
Parameter : cut
Parameter type : d
Omittable : False
Default value : 1.
Parameter range : cut>=0.0
Parameter : unit
Parameter type : s
Omittable : False
Default value : mm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /run/getCutForAGivenParticle
Guidance :
Get a cut value to a specific particle
Usage: /run/getCutForAGivenParticle gamma
Parameter : particleName
Parameter type : s
Omittable : False
Candidates : e- e+ gamma proton
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 um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /run/cputime
Guidance :
Set the cputime limit (in seconds) for the run
Range of parameters : cpu>0
Parameter : cpu
Parameter type : d
Omittable : False
Command /run/randseed
Guidance :
Set the seed for random engine to one of the predefined values (0-214)
Range of parameters : seed>=0 && seed<215
Parameter : seed
Parameter type : i
Omittable : False
Command directory path : /run/progressControl/
Guidance :
Application run progress controls
Sub-directories :
Commands :
commFreq * Set frequency of providing output and reading input.
targetEvents * One or a space-separated list of integers representing the maximum number of events
targetRuns * Set the number of non-MC runs to be performed
fileType * Set progress file type (input and output)
filePrefix * Set progress file prefix
resetRunNumber * Reset the run number to zero
Command /run/progressControl/commFreq
Guidance :
Set frequency of providing output and reading input.
Parameter : outputFrequency
Frequency output progress file is updated
Parameter type : i
Omittable : True
Default value : 1
Parameter range : outputFrequency > 0
Parameter : unit
Frequency units: either batch or event
Parameter type : s
Omittable : True
Default value : BATCH
Candidates : batches Batches BATCHES batch Batch BATCH b B events Events EVENTS event Event EVENT e E
Command /run/progressControl/targetEvents
Guidance :
One or a space-separated list of integers representing the maximum number of events
Parameter : Vector of event numbers
Parameter type : s
Omittable : False
Command /run/progressControl/targetRuns
Guidance :
Set the number of non-MC runs to be performed
Range of parameters : targetRuns >= 1
Parameter : targetRuns
Parameter type : i
Omittable : True
Default value : 1
Command /run/progressControl/fileType
Guidance :
Set progress file type (input and output)
Parameter : fileType
Parameter type : s
Omittable : True
Default value : JSON;
Candidates : JSON json Json TEXT text Text TXT txt Txt
Command /run/progressControl/filePrefix
Guidance :
Set progress file prefix
Parameter : filePrefix
Parameter type : s
Omittable : True
Default value : MULASSIS
Command /run/progressControl/resetRunNumber
Guidance :
Reset the run number to zero
Command directory path : /run/particle/
Guidance :
Commands for G4VUserPhysicsList.
Sub-directories :
Commands :
verbose * Set the Verbose level of G4VUserPhysicsList.
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/retrieve Physics Table
applyCuts * Set applyCuts flag for a particle.
dumpCutValues * Dump a list of production threshold values in range and energy
dumpOrderingParam * Dump a list of ordering parameter
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/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/retrieve 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 range 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
Command /run/particle/dumpOrderingParam
Guidance :
Dump a list of ordering parameter
Parameter : subtype
Parameter type : i
Omittable : True
Default value : -1
Command directory path : /random/
Guidance :
Random number status control commands.
Sub-directories :
Commands :
setSeeds * Initialize the random number generator with integer seed stream.
setDirectoryName * Define the directory name of the rndm status files.
setSavingFlag * The randomNumberStatus will be saved at :
saveThisRun * copy currentRun.rndm to runXXX.rndm
saveThisEvent * copy currentEvent.rndm to runXXXevtYYY.rndm
resetEngineFrom * Reset the status of the rndm engine from a file.
resetEngineFromEachEvent * Reset the status of the rndm engine from a file at each event.
saveEachEventFlag * Save random number status at beginning of each event.
Command /random/setSeeds
Guidance :
Initialize the random number generator with integer seed stream.
Number of integers should be more than 1.
Actual number of integers to be used depends on the individual random number engine.
This command sets the seeds for the master thread.
Parameter : IntArray
Parameter type : s
Omittable : False
Command /random/setDirectoryName
Guidance :
Define the directory name of the rndm status files.
Directory will be created if it does not exist.
Parameter : fileName
Parameter type : s
Omittable : True
Default value : ./
Command /random/setSavingFlag
Guidance :
The randomNumberStatus will be saved at :
beginning of run (currentRun.rndm) and beginning of event (currentEvent.rndm)
Parameter : flag
Parameter type : b
Omittable : True
Default value : 1
Command /random/saveThisRun
Guidance :
copy currentRun.rndm to runXXX.rndm
Command /random/saveThisEvent
Guidance :
copy currentEvent.rndm to runXXXevtYYY.rndm
Command /random/resetEngineFrom
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 /random/resetEngineFromEachEvent
Guidance :
Reset the status of the rndm engine from a file at each event.
Note that the file must follow the following naming convention:
run{#1}evt{#2}.rndm ; where #1 is the run number and #2 is the event number.
For example to re-seed the first event of the first run the file should be called run0evt0.rndm.
If for a specific run/event the file is not found, the standard re-seeding strategy is used.
This command has meaning only in MT mode for strong reproducibility studies.
Directory of the status file should be set by /random/setDirectoryName.
Parameter :
Parameter type : b
Omittable : False
Default value : 0
Command /random/saveEachEventFlag
Guidance :
Save random number status at beginning of each event.
File name contains run and event numbers: runXXXevtYYY.rndm
Parameter : flag
Parameter type : b
Omittable : True
Default value : 1
Command directory path : /process/
Guidance :
Process Table control commands.
Sub-directories :
/process/had/ Control of general hadronic physics parameters and choices.
Commands :
list * List up process names
verbose * Set Verbose Level for Process Table
setVerbose * Set verbose level for processes
dump * Dump process information
activate * Activate processes
inactivate * Inactivate process
Command /process/list
Guidance :
List up process names
list [type]
type: process type [all:for all processes]
Parameter : type
Parameter type : s
Omittable : True
Default value : all
Candidates : all NotDefined Transportation Electromagnetic Optical Hadronic Photolepton_hadron Decay General Parameterisation UserDefined
Command /process/verbose
Guidance :
Set Verbose Level for Process Table
verbose [level]
level: verbose level
Range of parameters : verbose >=0
Parameter : verbose
Parameter type : i
Omittable : True
Default value : 1
Command /process/setVerbose
Guidance :
Set verbose level for processes
setVerbose level [type or name]
level: verbose level
name : process name
type : process type
[all] for all processes
Parameter : verbose
Parameter type : i
Omittable : False
Parameter : type
Parameter type : s
Omittable : True
Default value : all
Command /process/dump
Guidance :
Dump process information
dump name [particle]
name: process name or type name
particle: particle name [all: for all particles]
Parameter : procName
Parameter type : s
Omittable : False
Parameter : particle
Parameter type : s
Omittable : True
Default value : all
Command /process/activate
Guidance :
Activate processes
Activate name [particle]
name: process name or type name
particle: particle name [all: for all particles]
Parameter : procName
Parameter type : s
Omittable : False
Parameter : particle
Parameter type : s
Omittable : True
Default value : all
Command /process/inactivate
Guidance :
Inactivate process
Inactivate processes
Inactivate name [particle]
name: process name or type name
particle: particle name [all: for all particles]
Parameter : procName
Parameter type : s
Omittable : False
Parameter : particle
Parameter type : s
Omittable : True
Default value : all
Command directory path : /process/had/
Guidance :
Control of general hadronic physics parameters and choices.
Sub-directories :
Commands :
verbose * Set verbose level: 0 (minimum), 1 (default), 2 (higher), ... (even higher)
maxEnergy * Max energy for hadronics (default: 100 TeV)
enableCRCoalescence * Enable Cosmic Ray (CR) coalescence.
Command /process/had/verbose
Guidance :
Set verbose level: 0 (minimum), 1 (default), 2 (higher), ... (even higher)
Range of parameters : VerboseLevel>=0
Parameter : VerboseLevel
Parameter type : i
Omittable : True
Default value : 1
Command /process/had/maxEnergy
Guidance :
Max energy for hadronics (default: 100 TeV)
Range of parameters : MaxEnergy>0.0
Parameter : MaxEnergy
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
Command /process/had/enableCRCoalescence
Guidance :
Enable Cosmic Ray (CR) coalescence.
Parameter : EnableCRCoalescence
Parameter type : b
Omittable : False
Default value : 0
Command directory path : /nonMC/
Guidance :
Run control commands.
Sub-directories :
/nonMC/error/ Control MULASSIS non-MC mode definition of errors in output.
/nonMC/integration/ Control MULASSIS non-MC integration calculation fidelity.
/nonMC/niel/ Control inclusion of user NIEL values for primary ion
/nonMC/doseModelThreshold/ Control threshold at which dose (TID) calculation
Commands :
beamOn * Execute run in non-Monte-Carlo results.
Command /nonMC/beamOn
Guidance :
Execute run in non-Monte-Carlo results.
Command directory path : /nonMC/error/
Guidance :
Control MULASSIS non-MC mode definition of errors in output.
Sub-directories :
Commands :
setGlobalPercent * Set percentage error to be applied to spectrum.
getGlobalPercent * Prints current settings of MULASSIS non-MC error calculation
Command /nonMC/error/setGlobalPercent
Guidance :
Set percentage error to be applied to spectrum.
Range of parameters : errorPC >=0 && errorPC <=1e+10
Parameter : errorPC
Parameter type : d
Omittable : True
Default value : taken from the current value
Command /nonMC/error/getGlobalPercent
Guidance :
Prints current settings of MULASSIS non-MC error calculation
Command directory path : /nonMC/integration/
Guidance :
Control MULASSIS non-MC integration calculation fidelity.
Sub-directories :
Commands :
setMaxTIntv * Set the maximum theta angle interval for
setMaxTLimit * Set the maximum theta angle for incident
setNMinTIntv * Set the minimum number of angle intervals for
minEpn * Set lowest energy per nucleon for spectrum to
nEpd * Set number of energies per decade to be used
nEpts * Set total number of energies to be used
nEint * Set total number of energies within each of the
rombergTolerance * Set Romberg integration tolerance / error.
listParameters * Prints current settings of MULASSIS non-MC
Command /nonMC/integration/setMaxTIntv
Guidance :
Set the maximum theta angle interval for
Simpson integration within each fluenc eangle bin.
***** WARNING - PLEASE DO NOT CHANGE THIS PARAMETER UNLESS *****
***** YOU ARE CERTAIN YOU UNDERSTAND THE CONSEQUENCES OF THE *****
***** CHANGE ON THE MULASSIS NON-MC INTEGRATION PROCESSES. *****
Range of parameters : maxTIntv >=0.01 && maxTIntv <=5
Parameter : maxTIntv
Parameter type : d
Omittable : True
Default value : taken from the current value
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : deg
Command /nonMC/integration/setMaxTLimit
Guidance :
Set the maximum theta angle for incident
particles in the planar shield.
***** WARNING - PLEASE DO NOT CHANGE THIS PARAMETER UNLESS *****
***** YOU ARE CERTAIN YOU UNDERSTAND THE CONSEQUENCES OF THE *****
***** CHANGE ON THE MULASSIS NON-MC INTEGRATION PROCESSES. *****
Range of parameters : maxTLimit >=85 && maxTLimit <=89.999
Parameter : maxTLimit
Parameter type : d
Omittable : True
Default value : taken from the current value
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : deg
Command /nonMC/integration/setNMinTIntv
Guidance :
Set the minimum number of angle intervals for
Simpson integration within each fluence angle bin.
***** WARNING - PLEASE DO NOT CHANGE THIS PARAMETER UNLESS *****
***** YOU ARE CERTAIN YOU UNDERSTAND THE CONSEQUENCES OF THE *****
***** CHANGE ON THE MULASSIS NON-MC INTEGRATION PROCESSES. *****
Range of parameters : nminTIntv >=1 && nminTIntv <=100
Parameter : nminTIntv
Parameter type : i
Omittable : True
Default value : taken from the current value
Command /nonMC/integration/minEpn
Guidance :
Set lowest energy per nucleon for spectrum to
be treated for numerical integration.
NOTE: State units as MeV for MeV/nuc, keV for
keV/nuc, etc.
***** WARNING - PLEASE DO NOT CHANGE THIS PARAMETER UNLESS *****
***** YOU ARE CERTAIN YOU UNDERSTAND THE CONSEQUENCES OF THE *****
***** CHANGE ON THE MULASSIS NON-MC INTEGRATION PROCESSES. *****
Range of parameters : minEpn >=0.01 && minEpn <=10000
Parameter : minEpn
Parameter type : d
Omittable : True
Default value : taken from the current value
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV
Command /nonMC/integration/nEpd
Guidance :
Set number of energies per decade to be used
for numerical integration of spectrum.
***** WARNING - PLEASE DO NOT CHANGE THIS PARAMETER UNLESS *****
***** YOU ARE CERTAIN YOU UNDERSTAND THE CONSEQUENCES OF THE *****
***** CHANGE ON THE MULASSIS NON-MC INTEGRATION PROCESSES. *****
Range of parameters : nEpd >=1 && nEpd <=100
Parameter : nEpd
Parameter type : i
Omittable : True
Default value : taken from the current value
Command /nonMC/integration/nEpts
Guidance :
Set total number of energies to be used
for numerical integration of spectrum.
***** WARNING - PLEASE DO NOT CHANGE THIS PARAMETER UNLESS *****
***** YOU ARE CERTAIN YOU UNDERSTAND THE CONSEQUENCES OF THE *****
***** CHANGE ON THE MULASSIS NON-MC INTEGRATION PROCESSES. *****
Range of parameters : nEpts >=20 && nEpts <=600
Parameter : nEpts
Parameter type : i
Omittable : True
Default value : taken from the current value
Command /nonMC/integration/nEint
Guidance :
Set total number of energies within each of the
nEpts intervals to perform integration of
attenuation from nucleus-nucleus collisions.
***** WARNING - PLEASE DO NOT CHANGE THIS PARAMETER UNLESS *****
***** YOU ARE CERTAIN YOU UNDERSTAND THE CONSEQUENCES OF THE *****
***** CHANGE ON THE MULASSIS NON-MC INTEGRATION PROCESSES. *****
Range of parameters : nEint >=4 && nEint <=100
Parameter : nEint
Parameter type : i
Omittable : True
Default value : taken from the current value
Command /nonMC/integration/rombergTolerance
Guidance :
Set Romberg integration tolerance / error.
For standard shield geometries, a value of 1.0E-4 should be sufficient.
For thin layers <<1mm lower values are recommended, e.g., 1.0E-7 for 10 micron Si layers.
Range of parameters : rombergTol >=1e-10 && rombergTol <=0.001
Parameter : rombergTol
Parameter type : d
Omittable : False
Command /nonMC/integration/listParameters
Guidance :
Prints current settings of MULASSIS non-MC
integration parameters (over energy and angle.
Command directory path : /nonMC/niel/
Guidance :
Control inclusion of user NIEL values for primary ion
Sub-directories :
Commands :
name * Defines the name of the NIEL function to be used
datapoint * Defines the energy [MeV] and NIEL [MeVcm2/mg] for a point
clear * Clears the user-defined NIEL function
list * Lists the current user-defined NIEL data
Command /nonMC/niel/name
Guidance :
Defines the name of the NIEL function to be used
This function is only applicable to the primary.
Parameter : userNIELName
Parameter type : s
Omittable : True
Default value : taken from the current value
Command /nonMC/niel/datapoint
Guidance :
Defines the energy [MeV] and NIEL [MeVcm2/mg] for a point
Range of parameters : userEnergy > 0.0 && userNIEL >= 0.0
Parameter : userEnergy
Parameter type : d
Omittable : True
Default value : taken from the current value
Parameter : userNIEL
Parameter type : d
Omittable : True
Default value : taken from the current value
Parameter : Junk
Parameter type : d
Omittable : True
Default value : taken from the current value
Command /nonMC/niel/clear
Guidance :
Clears the user-defined NIEL function
Command /nonMC/niel/list
Guidance :
Lists the current user-defined NIEL data
Command directory path : /nonMC/doseModelThreshold/
Guidance :
Control threshold at which dose (TID) calculation
mode changes.
Sub-directories :
Commands :
setThreshold * Set the lowest threshold for the ratio of the
getThreshold * Prints current settings of dose model threshold.
Command /nonMC/doseModelThreshold/setThreshold
Guidance :
Set the lowest threshold for the ratio of the
energy deposition over the incident energy flux.
Above this threshold, dose is calculated from the
difference in the incident and exiting energy flux.
At and below this threshold, the layer is considered
sufficiently transparent to the radiation field
and the dose is calculated from the integration of
the incident spectrum, dE/dx and the mean thickness
of the layer.
***** WARNING - PLEASE DO NOT CHANGE THIS PARAMETER UNLESS *****
***** YOU ARE CERTAIN YOU UNDERSTAND THE CONSEQUENCES OF THE *****
***** CHANGE ON THE MULASSIS NON-MC INTEGRATION PROCESSES. *****
Range of parameters : dDOverDLimit >=1e-08 && dDOverDLimit <=0.01
Parameter : dDOverDLimit
Parameter type : d
Omittable : True
Default value : 1e-06
Command /nonMC/doseModelThreshold/getThreshold
Guidance :
Prints current settings of dose model threshold.
Command directory path : /material/
Guidance :
Commands for materials
Sub-directories :
/material/nist/ Commands for the nist dataBase
/material/g4/ Commands for G4MaterialTable
Commands :
verbose * Set verbose level.
Command /material/verbose
Guidance :
Set verbose level.
Parameter :
Parameter type : i
Omittable : False
Command directory path : /material/nist/
Guidance :
Commands for the nist dataBase
Sub-directories :
Commands :
printElement * print element(s) in dataBase.
printElementZ * print element Z in dataBase.
listMaterials * Materials in Geant4 dataBase.
Command /material/nist/printElement
Guidance :
print element(s) in dataBase.
symbol = element.
all = all elements.
Parameter : symbol
Parameter type : s
Omittable : True
Default value : all
Command /material/nist/printElementZ
Guidance :
print element Z in dataBase.
0 = all elements.
Range of parameters : 0<=Z && Z<108
Parameter : Z
Parameter type : i
Omittable : True
Default value : 0
Command /material/nist/listMaterials
Guidance :
Materials in Geant4 dataBase.
simple - simple NIST materials.
compound - compound NIST materials.
hep - HEP materials.
bio - biomedical materials.
all - list of all Geant4 materials.
Parameter : matlist
Parameter type : s
Omittable : True
Default value : all
Command directory path : /material/g4/
Guidance :
Commands for G4MaterialTable
Sub-directories :
Commands :
printElement * print Element from G4ElementTable.
printMaterial * print Material from G4MaterialTable.
printDensityEffParam * print Material from G4DensityEffectData.
enableDensityEffOnFly * enable accurate computation of density effect.
disableDensityEffOnFly * disable accurate computation of density effect.
Command /material/g4/printElement
Guidance :
print Element from G4ElementTable.
all - all elements.
Parameter : elm
Parameter type : s
Omittable : True
Default value : all
Command /material/g4/printMaterial
Guidance :
print Material from G4MaterialTable.
all - all materials
Parameter : pmat
Parameter type : s
Omittable : True
Default value : all
Command /material/g4/printDensityEffParam
Guidance :
print Material from G4DensityEffectData.
all - all materials
Parameter : dmat
Parameter type : s
Omittable : True
Default value : all
Command /material/g4/enableDensityEffOnFly
Guidance :
enable accurate computation of density effect.
all - all materials.
Parameter : dens
Parameter type : s
Omittable : True
Default value : all
Command /material/g4/disableDensityEffOnFly
Guidance :
disable accurate computation of density effect.
all - all materials.
Parameter : dens
Parameter type : s
Omittable : True
Default value : all
Command directory path : /phys/
Guidance :
Controls of the physics processes
Sub-directories :
/phys/region/ Define the regions for cuts.
/phys/cuts/ Controls to set the cuts.
Commands :
scenario * select the simulation scenario
printDEDXTable * material energy particle
dEdXtoCSV * CSVFileName material particle Energy_Lo Energy_Hi N_Energies lin/log
showscen * Show the selected simulation scenario.
verboseLevel * Set the verbosity level for physics list.
Command /phys/scenario
Guidance :
select the simulation scenario
em: EM interactions using standard G4EM
em_opt3: EM interactions using standard G4EM_opt3 & DecayPhysics
em_liv: EM interactions using the G4EM Livermore physics
leem: " " " " "
em_pen: EM interactions using the G4EM Penelope physics
hadron-em-ln: hadronic + std-ionisation
hadron-em_liv-ln: hadronic + livermore ionisation
hadron-leem-ln: " " "
hadron-em_pen-ln: hadronic + penelope-ionisation
hadron+em-ln: hadronic + std EM interactions
hadron-em+ln: hadronic + std-ionisation + l.e. neutron
hadron-em_liv+ln: hadronic livermore-ionisation + l.e. neutron
hadron-leem+ln: " " " "
hadron-em_pen+ln: hadronic + penelope-ionisation + l.e. neutron
hadron+em+ln: hadronic + std EM + l.e. neutron interactions
hadron+em_liv-ln: hadronic + G4EM Livermore interactions
hadron+leem-ln: " " " "
hadron+em_liv+ln: hadronic + G4EM Livermore + l.e. neutron interactions
hadron+leem+ln: " " " "
hadron+em_pen-ln: hadronic + G4 EM Penelope interactions
hadron+em_pen+ln: hadronic + G4 EM Penelope + l.e. neutron interactions
bertini: G4 EM and Bertini hadron physics
binary: G4 EM and Binary hadron physics
QBBC: G4EM + QBBC
radioactivedecay: G4EM livermore physics + binary + Radioactive Decay
Parameter :
Parameter type : s
Omittable : False
Candidates : em em_opt3 leem em_liv em_pen hadron+em+ln hadron+em_liv+ln hadron+em_pen+ln hadron+leem+ln hadron+em-ln hadron+em_liv-ln hadron+em_pen-ln hadron+leem-ln hadron-em+ln hadron-em_liv+ln hadron-em_pen+ln hadron-leem+ln hadron-em-ln hadron-em_liv-ln hadron-em_pen-ln hadron-leem-ln bertini binary QBBC radioactivedecay EM EM_OPT3 LEEM EM_LIV EM_PEN HADRON+EM+LN HADRON+EM_LIV+LN HADRON+EM_PEN+LN HADRON+LEEM+LN HADRON+EM-LN HADRON+EM_LIV-LN HADRON+EM_PEN-LN HADRON+LEEM-LN HADRON-EM+LN HADRON-EM_LIV+LN HADRON-EM_PEN+LN HADRON-LEEM+LN HADRON-EM-LN HADRON-EM_LIV-LN HADRON-EM_PEN-LN HADRON-LEEM-LN BERTINI BINARY
Command /phys/printDEDXTable
Guidance :
material energy particle
Parameter : material
Parameter type : s
Omittable : False
Parameter : energy
Parameter type : d
Omittable : False
Parameter : particle
Parameter type : s
Omittable : False
Parameter : region
Parameter type : s
Omittable : True
Default value : DefaultRegionForTheWorld
Command /phys/dEdXtoCSV
Guidance :
CSVFileName material particle Energy_Lo Energy_Hi N_Energies lin/log
Parameter : csvFile
Parameter type : s
Omittable : False
Parameter : material
Parameter type : s
Omittable : False
Parameter : particle
Parameter type : s
Omittable : False
Parameter : Energy_lo
Parameter type : d
Omittable : False
Parameter : Energy_hi
Parameter type : d
Omittable : False
Parameter : N_Energies
Parameter type : i
Omittable : False
Parameter : lin_log
Parameter type : s
Omittable : False
Candidates : lin log
Parameter : region
Parameter type : s
Omittable : True
Default value : DefaultRegionForTheWorld
Command /phys/showscen
Guidance :
Show the selected simulation scenario.
Command /phys/verboseLevel
Guidance :
Set the verbosity level for physics list.
Parameter :
Parameter type : i
Omittable : False
Command directory path : /phys/region/
Guidance :
Define the regions for cuts.
Sub-directories :
Commands :
add * Create a new region
delete * Delete a region
list * List the regions defined
addalayer * Add a shield layer to a region.
delalayer * Remove a shield layer from a region.
listlayers * list the shield layers in a region
Command /phys/region/add
Guidance :
Create a new region
Parameter :
Parameter type : s
Omittable : False
Command /phys/region/delete
Guidance :
Delete a region
Parameter :
Parameter type : s
Omittable : False
Command /phys/region/list
Guidance :
List the regions defined
Command /phys/region/addalayer
Guidance :
Add a shield layer to a region.
region-name layer-number
Parameter : regname
Parameter type : s
Omittable : False
Parameter : layer
Parameter type : i
Omittable : False
Parameter range : layer > 0
Command /phys/region/delalayer
Guidance :
Remove a shield layer from a region.
region-name layer-number
Parameter : regname
Parameter type : s
Omittable : False
Parameter : layer
Parameter type : i
Omittable : False
Parameter range : layer > 0
Command /phys/region/listlayers
Guidance :
list the shield layers in a region
Parameter :
Parameter type : s
Omittable : False
Command directory path : /phys/cuts/
Guidance :
Controls to set the cuts.
Sub-directories :
/phys/cuts/global/ Set the global cuts
/phys/cuts/region/ Set the cuts in a defined region.
Commands :
Command directory path : /phys/cuts/global/
Guidance :
Set the global cuts
Sub-directories :
Commands :
default * Set default cut in range.
gamma * Set cut for gamma in range.
electron * Set cut for electron in range.
positron * Set cut for positron in range.
Command /phys/cuts/global/default
Guidance :
Set default cut in range.
defaultCut unit
Range of parameters : defaultCut > 0.0
Parameter : defaultCut
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : um mm cm m
Command /phys/cuts/global/gamma
Guidance :
Set cut for gamma in range.
gammaCut unit
Range of parameters : gammaCut > 0.0
Parameter : gammaCut
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : um mm cm m
Command /phys/cuts/global/electron
Guidance :
Set cut for electron in range.
electronCut unit
Range of parameters : electronCut > 0.0
Parameter : electronCut
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : um mm cm m
Command /phys/cuts/global/positron
Guidance :
Set cut for positron in range.
positronCut unit
Range of parameters : positronCut > 0.0
Parameter : positronCut
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : um mm cm m
Command directory path : /phys/cuts/region/
Guidance :
Set the cuts in a defined region.
Sub-directories :
Commands :
setcut * Set cut-in-range in a region.
cutperparticle * Set cut-in-range in a region for a particle type.
Command /phys/cuts/region/setcut
Guidance :
Set cut-in-range in a region.
region-name value unit
Parameter : matname
Parameter type : s
Omittable : False
Parameter : cut
Parameter type : d
Omittable : False
Parameter range : cut > 0.0
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : um mm cm m
Command /phys/cuts/region/cutperparticle
Guidance :
Set cut-in-range in a region for a particle type.
region-name particle-type value unit
Parameter : matname
Parameter type : s
Omittable : False
Parameter : Particle
Parameter type : s
Omittable : False
Candidates : gamma e- e+
Parameter : cut
Parameter type : d
Omittable : False
Parameter range : cut > 0.0
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : um mm cm m
Command directory path : /analysis/
Guidance :
MULASSIS analysis control.
Sub-directories :
/analysis/fluence/ Controls for fluence analysis.
/analysis/dose/ Controls for dose analysis.
/analysis/doseEq/ Controls for dose analysis.
/analysis/niel/ Controls for niel analysis.
/analysis/solarCell/ Controls for niel analysis.
/analysis/phs/ Controls energy deposition PHS analysis.
Commands :
file * Input the filename prefix for CVS and report file.
normalise * Set the incident particle fluence.
Command /analysis/file
Guidance :
Input the filename prefix for CVS and report file.
Parameter : filename
Parameter type : s
Omittable : True
Default value : taken from the current value
Command /analysis/normalise
Guidance :
Set the incident particle fluence.
Range of parameters : normal > 0.
Parameter : normal
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : cm2 m2
Command directory path : /analysis/fluence/
Guidance :
Controls for fluence analysis.
Sub-directories :
/analysis/fluence/energy/ Control fluence energy spectra.
/analysis/fluence/angle/ Control fluence angle spectra.
/analysis/fluence/particle/ Controls for fluence particle selection.
Commands :
type * Selects whether the standard (omnidirectional) fluence or planar fluence is measured
unit * Set the area units for fluence calculation:
add * Select a layer as fluence detector
delete * Delete a fluence detector
list * List the layers selected as fluence detectors
Command /analysis/fluence/type
Guidance :
Selects whether the standard (omnidirectional) fluence or planar fluence is measured
Candidates are: OMNI or PLANAR
Parameter : fluenceType
Parameter type : s
Omittable : False
Candidates : OMNI omni OMNIDIRECTIONAL omnidirectional PLANAR planar BOUNDARY boundary
Command /analysis/fluence/unit
Guidance :
Set the area units for fluence calculation:
Candidates are: cm2 or m2
Parameter : fluenceunit
Parameter type : s
Omittable : False
Candidates : cm2 m2 cm2s m2s
Command /analysis/fluence/add
Guidance :
Select a layer as fluence detector
0 =< Nb <= NbofLayers+1
Range of parameters : AddFLayer >= 0
Parameter : AddFLayer
Parameter type : i
Omittable : False
Command /analysis/fluence/delete
Guidance :
Delete a fluence detector
Nb <= Num of layers
if Nb=0 do not perform any fluence analysis
Range of parameters : DeleteFLayer >= 0
Parameter : DeleteFLayer
Parameter type : i
Omittable : False
Command /analysis/fluence/list
Guidance :
List the layers selected as fluence detectors
Command directory path : /analysis/fluence/energy/
Guidance :
Control fluence energy spectra.
Sub-directories :
Commands :
mode * Set the histogram energy binning scheme.
max * Sets the maximum energy of fluence histogram.
min * Sets the minimum energy of fluence histogram.
nbin * Sets the number of bins in fluence histogram.
add * Add an energy bin edge (arbitrary bin scheme).
delete * Delete an energy bin edge (arbitrary bin scheme).
list * List the energy binning scheme.
clear * Clear the arbitrary binning scheme.
default * Use the default energy binning scheme.
Command /analysis/fluence/energy/mode
Guidance :
Set the histogram energy binning scheme.
Candidates are: lin, log or arb
Parameter : modeeng
Parameter type : s
Omittable : False
Candidates : lin LIN linear LINEAR log LOG logarithmic LOGARITHMIC arb ARB arbitrary ARBITRARY
Command /analysis/fluence/energy/max
Guidance :
Sets the maximum energy of fluence histogram.
Range of parameters : maxeng > 0.
Parameter : maxeng
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV TeV PeV
Command /analysis/fluence/energy/min
Guidance :
Sets the minimum energy of fluence histogram.
Range of parameters : mineng >= 0.
Parameter : mineng
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV TeV PeV
Command /analysis/fluence/energy/nbin
Guidance :
Sets the number of bins in fluence histogram.
Range of parameters : nbineng > 0
Parameter : nbineng
Parameter type : i
Omittable : True
Default value : taken from the current value
Command /analysis/fluence/energy/add
Guidance :
Add an energy bin edge (arbitrary bin scheme).
Range of parameters : addeng > 0.
Parameter : addeng
Parameter type : d
Omittable : True
Default value : taken from the current value
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV TeV PeV
Command /analysis/fluence/energy/delete
Guidance :
Delete an energy bin edge (arbitrary bin scheme).
Range of parameters : deleteeng > 0.
Parameter : deleteeng
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV TeV PeV
Command /analysis/fluence/energy/list
Guidance :
List the energy binning scheme.
Command /analysis/fluence/energy/clear
Guidance :
Clear the arbitrary binning scheme.
Command /analysis/fluence/energy/default
Guidance :
Use the default energy binning scheme.
Command directory path : /analysis/fluence/angle/
Guidance :
Control fluence angle spectra.
Sub-directories :
Commands :
mode * Set the histogram angle binning scheme.
max * Sets the maximum angle of fluence histograms.
min * Sets the minimum angle of fluence histograms.
nbin * Sets the number of bins in fluence histograms.
add * Add an angle bin edge (arbitrary bin scheme).
delete * Delete an angle bin edge (arbitrary bin scheme).
list * List the angle binning scheme.
clear * Clear the arbitrary binning scheme.
default * Use the default angle binning scheme.
Command /analysis/fluence/angle/mode
Guidance :
Set the histogram angle binning scheme.
Candidates are: lin, arb
Parameter : modeang
Parameter type : s
Omittable : False
Candidates : lin LIN linear LINEAR arb ARB arbitrary ARBITRARY
Command /analysis/fluence/angle/max
Guidance :
Sets the maximum angle of fluence histograms.
Parameter : maxang
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : deg rad
Command /analysis/fluence/angle/min
Guidance :
Sets the minimum angle of fluence histograms.
Parameter : minang
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : deg rad
Command /analysis/fluence/angle/nbin
Guidance :
Sets the number of bins in fluence histograms.
Range of parameters : nbinang > 0
Parameter : nbinang
Parameter type : i
Omittable : True
Default value : taken from the current value
Command /analysis/fluence/angle/add
Guidance :
Add an angle bin edge (arbitrary bin scheme).
Parameter : addang
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : deg rad
Command /analysis/fluence/angle/delete
Guidance :
Delete an angle bin edge (arbitrary bin scheme).
Parameter : deleteang
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : deg rad
Command /analysis/fluence/angle/list
Guidance :
List the angle binning scheme.
Command /analysis/fluence/angle/clear
Guidance :
Clear the arbitrary binning scheme.
Command /analysis/fluence/angle/default
Guidance :
Use the default angle binning scheme.
Command directory path : /analysis/fluence/particle/
Guidance :
Controls for fluence particle selection.
Sub-directories :
Commands :
add * Add a particle to the list.
adduser * Add a User specified particle to the list.
delete * Remove a particle from fluence analysis list.
deleteuser * Remove a user specified particle from fluence analysis list.
list * List the particles selected for fluence analysis.
Command /analysis/fluence/particle/add
Guidance :
Add a particle to the list.
Parameter : addpart
Parameter type : s
Omittable : False
Candidates : proton neutron gamma e- muon pion primary
Command /analysis/fluence/particle/adduser
Guidance :
Add a User specified particle to the list.
Parameter : adduserpart
Parameter type : s
Omittable : False
Command /analysis/fluence/particle/delete
Guidance :
Remove a particle from fluence analysis list.
Parameter : deletpart
Parameter type : s
Omittable : False
Candidates : proton neutron gamma e- muon pion primary
Command /analysis/fluence/particle/deleteuser
Guidance :
Remove a user specified particle from fluence analysis list.
Parameter : deleteuserpart
Parameter type : s
Omittable : False
Command /analysis/fluence/particle/list
Guidance :
List the particles selected for fluence analysis.
Command directory path : /analysis/dose/
Guidance :
Controls for dose analysis.
Sub-directories :
Commands :
add * Add a layer to the dose analysis list.
delete * Remove a layer from dose analysis list.
list * List the layers selected for dose analysis.
unit * Set the dose unit. Candidates are:
Command /analysis/dose/add
Guidance :
Add a layer to the dose analysis list.
The layer has to be already specified as a PHS detector
Range of parameters : adddose >= 0
Parameter : adddose
Parameter type : i
Omittable : False
Command /analysis/dose/delete
Guidance :
Remove a layer from dose analysis list.
Range of parameters : deletedose >= 0
Parameter : deletedose
Parameter type : i
Omittable : False
Command /analysis/dose/list
Guidance :
List the layers selected for dose analysis.
Command /analysis/dose/unit
Guidance :
Set the dose unit. Candidates are:
eV keV MeV GeV TeV PeV rad Gy
Parameter : doseunit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV TeV PeV rad Gy
Command directory path : /analysis/doseEq/
Guidance :
Controls for dose analysis.
Sub-directories :
/analysis/doseEq/add/ Add a layer to the dose analysis list.
Commands :
add * Add a layer to the dose analysis list.
delete * Remove a layer from dose analysis list.
list * List the layers selected for dose analysis.
unit * Set the dose unit. Candidates are:
Command /analysis/doseEq/add
Guidance :
Add a layer to the dose analysis list.
The layer has to be already specified as a PHS detector
Range of parameters : adddose >= 0
Parameter : adddose
Parameter type : i
Omittable : False
Command /analysis/doseEq/delete
Guidance :
Remove a layer from dose analysis list.
Range of parameters : deletedose >= 0
Parameter : deletedose
Parameter type : i
Omittable : False
Command /analysis/doseEq/list
Guidance :
List the layers selected for dose analysis.
Command /analysis/doseEq/unit
Guidance :
Set the dose unit. Candidates are:
eV keV MeV GeV TeV PeV rad Gy
Parameter : doseunit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV TeV PeV rad Gy
Command directory path : /analysis/doseEq/add/
Guidance :
Add a layer to the dose analysis list.
The layer has to be already specified as a PHS detector
Range of parameters : adddoseEq >= 0
Parameter : adddoseEq
Parameter type : i
Omittable : False
Sub-directories :
Commands :
Command directory path : /analysis/niel/
Guidance :
Controls for niel analysis.
Sub-directories :
Commands :
add * Add a layer to the niel analysis list.
delete * Remove a layer from niel analysis list.
list * List the layers selected for niel analysis.
unit * Set the dose unit. Candidates are:
references * List the references for the NIEL curves
function * Select the global niel function to be used.
functionByLayer * Select the niel function to be used by the layer number.
Command /analysis/niel/add
Guidance :
Add a layer to the niel analysis list.
Range of parameters : addniel >= 0
Parameter : addniel
Parameter type : i
Omittable : False
Command /analysis/niel/delete
Guidance :
Remove a layer from niel analysis list.
Range of parameters : deleteniel >= 0
Parameter : deleteniel
Parameter type : i
Omittable : False
Command /analysis/niel/list
Guidance :
List the layers selected for niel analysis.
Command /analysis/niel/unit
Guidance :
Set the dose unit. Candidates are:
rad Gy MeV/g
Parameter : doseunit
Parameter type : s
Omittable : False
Candidates : rad Gy MeV/g
Command /analysis/niel/references
Guidance :
List the references for the NIEL curves
Command /analysis/niel/function
Guidance :
Select the global niel function to be used.
Candidates are:
cern CERN jpl JPL JPL_NRL_NASA_2003_Si JPL_NRL_NASA_2003_GaAs JPL_NRL_NASA_2003_InP INFN_ESA_2014_10eV_GaAs INFN_ESA_2014_21eV_GaAs INFN_ESA_2014_25eV_GaAs global
Parameter : nielfunc
Parameter type : s
Omittable : False
Candidates : cern CERN jpl JPL JPL_NRL_NASA_2003_Si JPL_NRL_NASA_2003_GaAs JPL_NRL_NASA_2003_InP INFN_ESA_2014_10eV_GaAs INFN_ESA_2014_21eV_GaAs INFN_ESA_2014_25eV_GaAs global
Command /analysis/niel/functionByLayer
Guidance :
Select the niel function to be used by the layer number.
Parameter : NIELLayerNo
position number: from 0 to NbOfLayers
Parameter type : i
Omittable : False
Parameter range : NIELLayerNo >= 0
Parameter : NIELcurve
NIEL curve to use for the layer.
Parameter type : s
Omittable : False
Candidates : cern CERN jpl JPL JPL_NRL_NASA_2003_Si JPL_NRL_NASA_2003_GaAs JPL_NRL_NASA_2003_InP INFN_ESA_2014_10eV_GaAs INFN_ESA_2014_21eV_GaAs INFN_ESA_2014_25eV_GaAs global
Command directory path : /analysis/solarCell/
Guidance :
Controls for niel analysis.
Sub-directories :
Commands :
add * Add a layer to the niel analysis list.
delete * Remove a layer from niel analysis list.
list * List the layers selected for niel analysis.
unit * Set the dose unit. Candidates are:
references * List the references for the NIEL curves
function * Select the global niel function to be used.
functionByLayer * Select the niel function to be used by the layer number.
setParameters * Set the solar cell damage parameters: name, n, Cp, Ce, Dxp, Dxe.
ListParameters * Lists the solar cell damage parameters (name, n, Cp, Ce, Dxp, Dxe).
delParameter * Deletes a set of solar cell damage parameters
Command /analysis/solarCell/add
Guidance :
Add a layer to the niel analysis list.
Range of parameters : addniel >= 0
Parameter : addniel
Parameter type : i
Omittable : False
Command /analysis/solarCell/delete
Guidance :
Remove a layer from niel analysis list.
Range of parameters : deleteniel >= 0
Parameter : deleteniel
Parameter type : i
Omittable : False
Command /analysis/solarCell/list
Guidance :
List the layers selected for niel analysis.
Command /analysis/solarCell/unit
Guidance :
Set the dose unit. Candidates are:
rad Gy MeV/g
Parameter : doseunit
Parameter type : s
Omittable : False
Candidates : rad Gy MeV/g
Command /analysis/solarCell/references
Guidance :
List the references for the NIEL curves
Command /analysis/solarCell/function
Guidance :
Select the global niel function to be used.
Candidates are:
cern CERN jpl JPL JPL_NRL_NASA_2003_Si JPL_NRL_NASA_2003_GaAs JPL_NRL_NASA_2003_InP INFN_ESA_2014_10eV_GaAs INFN_ESA_2014_21eV_GaAs INFN_ESA_2014_25eV_GaAs global
Parameter : nielfunc
Parameter type : s
Omittable : False
Candidates : cern CERN jpl JPL JPL_NRL_NASA_2003_Si JPL_NRL_NASA_2003_GaAs JPL_NRL_NASA_2003_InP INFN_ESA_2014_10eV_GaAs INFN_ESA_2014_21eV_GaAs INFN_ESA_2014_25eV_GaAs global
Command /analysis/solarCell/functionByLayer
Guidance :
Select the niel function to be used by the layer number.
Parameter : NIELLayerNo
position number: from 0 to NbOfLayers
Parameter type : i
Omittable : False
Parameter range : NIELLayerNo >= 0
Parameter : NIELcurve
NIEL curve to use for the layer.
Parameter type : s
Omittable : False
Candidates : cern CERN jpl JPL JPL_NRL_NASA_2003_Si JPL_NRL_NASA_2003_GaAs JPL_NRL_NASA_2003_InP INFN_ESA_2014_10eV_GaAs INFN_ESA_2014_21eV_GaAs INFN_ESA_2014_25eV_GaAs global
Command /analysis/solarCell/setParameters
Guidance :
Set the solar cell damage parameters: name, n, Cp, Ce, Dxp, Dxe.
Parameter : name
name
Parameter type : s
Omittable : False
Parameter : n
Dxe
Parameter type : d
Omittable : False
Parameter : Cp
Parameter type : d
Omittable : False
Parameter : Ce
Parameter type : d
Omittable : False
Parameter : Dxp
Parameter type : d
Omittable : False
Parameter : Dxe
Parameter type : d
Omittable : False
Command /analysis/solarCell/ListParameters
Guidance :
Lists the solar cell damage parameters (name, n, Cp, Ce, Dxp, Dxe).
Command /analysis/solarCell/delParameter
Guidance :
Deletes a set of solar cell damage parameters
Parameter :
Parameter type : s
Omittable : False
Command directory path : /analysis/phs/
Guidance :
Controls energy deposition PHS analysis.
Sub-directories :
/analysis/phs/energy/ Controls for pulse height spectra.
Commands :
add * Specify a layer as energy deposition detector
delete * Delete a PHS detector
list * List the PHS detectors
Command /analysis/phs/add
Guidance :
Specify a layer as energy deposition detector
0 <= Nb <= NbofLayers
Range of parameters : AddELayer >= 0
Parameter : AddELayer
Parameter type : i
Omittable : False
Command /analysis/phs/delete
Guidance :
Delete a PHS detector
Nb <= Number of layers
If Nb=0 do not perform any PHS analysis
Range of parameters : DeleteELayer >= 0
Parameter : DeleteELayer
Parameter type : i
Omittable : False
Command /analysis/phs/list
Guidance :
List the PHS detectors
Command directory path : /analysis/phs/energy/
Guidance :
Controls for pulse height spectra.
Sub-directories :
Commands :
mode * Set the histogram binning scheme.
max * Sets the maximum energy of PHS histograms.
min * Sets the minimum energy of PHS histograms.
nbin * Sets the number of bins in the PHS histograms.
add * Add an energy bin edge (arbitrary bin scheme).
delete * Delete an energy bin edge (arbitrary bin scheme).
list * List the binning scheme.
clear * Clear the arbitrary binning scheme.
default * Use the default binning scheme.
Command /analysis/phs/energy/mode
Guidance :
Set the histogram binning scheme.
Candidates are: lin, log, arb
Parameter : modephs
Parameter type : s
Omittable : False
Candidates : lin LIN linear LINEAR log LOG logarithmic LOGARITHMIC arb ARB arbitrary ARBITRARY
Command /analysis/phs/energy/max
Guidance :
Sets the maximum energy of PHS histograms.
Range of parameters : maxphs > 0.
Parameter : maxphs
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV TeV PeV
Command /analysis/phs/energy/min
Guidance :
Sets the minimum energy of PHS histograms.
Range of parameters : minphs >= 0.
Parameter : minphs
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV TeV PeV
Command /analysis/phs/energy/nbin
Guidance :
Sets the number of bins in the PHS histograms.
Range of parameters : nbinphs > 0
Parameter : nbinphs
Parameter type : i
Omittable : True
Default value : taken from the current value
Command /analysis/phs/energy/add
Guidance :
Add an energy bin edge (arbitrary bin scheme).
Range of parameters : addphs > 0.
Parameter : addphs
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV TeV PeV
Command /analysis/phs/energy/delete
Guidance :
Delete an energy bin edge (arbitrary bin scheme).
Range of parameters : deletephs > 0.
Parameter : deletephs
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : False
Candidates : eV keV MeV GeV TeV PeV
Command /analysis/phs/energy/list
Guidance :
List the binning scheme.
Command /analysis/phs/energy/clear
Guidance :
Clear the arbitrary binning scheme.
Command /analysis/phs/energy/default
Guidance :
Use the default binning scheme.
Command directory path : /gps/
Guidance :
General Particle Source control commands.
Sub-directories :
/gps/source/ Multiple source control sub-directory
/gps/pos/ Positional commands sub-directory
/gps/ang/ Angular commands sub-directory
/gps/ene/ Spectral commands sub-directory
/gps/hist/ Histogram, biasing commands sub-directory
Commands :
List * List available particles.
particle * Set particle to be generated.
direction * Set momentum direction.
energy * Set kinetic energy.
position * Set starting position of the particle for a Point like source.
ion * Set properties of ion to be generated.
ionLvl * Set properties of ion to be generated.
time * Set initial time of the particle.
polarization * Set polarization.
number * Set number of particles to be generated per vertex.
verbose * Set Verbose level for GPS
Command /gps/List
Guidance :
List available particles.
Invoke G4ParticleTable.
Command /gps/particle
Guidance :
Set particle to be generated.
(geantino is default)
(ion can be specified for shooting ions)
Parameter : particleName
Parameter type : s
Omittable : True
Default value : geantino
Candidates : B+ B- B0 Bc+ Bc- Bs0 D+ D- D0 Ds+ Ds- GenericIon He3 J/psi N(1440)+ N(1440)0 N(1520)+ N(1520)0 N(1535)+ N(1535)0 N(1650)+ N(1650)0 N(1675)+ N(1675)0 N(1680)+ N(1680)0 N(1700)+ N(1700)0 N(1710)+ N(1710)0 N(1720)+ N(1720)0 N(1900)+ N(1900)0 N(1990)+ N(1990)0 N(2090)+ N(2090)0 N(2190)+ N(2190)0 N(2220)+ N(2220)0 N(2250)+ N(2250)0 Upsilon a0(1450)+ a0(1450)- a0(1450)0 a0(980)+ a0(980)- a0(980)0 a1(1260)+ a1(1260)- a1(1260)0 a2(1320)+ a2(1320)- a2(1320)0 alpha anti_B0 anti_Bs0 anti_D0 anti_He3 anti_N(1440)+ anti_N(1440)0 anti_N(1520)+ anti_N(1520)0 anti_N(1535)+ anti_N(1535)0 anti_N(1650)+ anti_N(1650)0 anti_N(1675)+ anti_N(1675)0 anti_N(1680)+ anti_N(1680)0 anti_N(1700)+ anti_N(1700)0 anti_N(1710)+ anti_N(1710)0 anti_N(1720)+ anti_N(1720)0 anti_N(1900)+ anti_N(1900)0 anti_N(1990)+ anti_N(1990)0 anti_N(2090)+ anti_N(2090)0 anti_N(2190)+ anti_N(2190)0 anti_N(2220)+ anti_N(2220)0 anti_N(2250)+ anti_N(2250)0 anti_alpha anti_b_quark anti_bb1_diquark anti_bc0_diquark anti_bc1_diquark anti_bd0_diquark anti_bd1_diquark anti_bs0_diquark anti_bs1_diquark anti_bu0_diquark anti_bu1_diquark anti_c_quark anti_cc1_diquark anti_cd0_diquark anti_cd1_diquark anti_cs0_diquark anti_cs1_diquark anti_cu0_diquark anti_cu1_diquark anti_d_quark anti_dd1_diquark anti_delta(1600)+ anti_delta(1600)++ anti_delta(1600)- anti_delta(1600)0 anti_delta(1620)+ anti_delta(1620)++ anti_delta(1620)- anti_delta(1620)0 anti_delta(1700)+ anti_delta(1700)++ anti_delta(1700)- anti_delta(1700)0 anti_delta(1900)+ anti_delta(1900)++ anti_delta(1900)- anti_delta(1900)0 anti_delta(1905)+ anti_delta(1905)++ anti_delta(1905)- anti_delta(1905)0 anti_delta(1910)+ anti_delta(1910)++ anti_delta(1910)- anti_delta(1910)0 anti_delta(1920)+ anti_delta(1920)++ anti_delta(1920)- anti_delta(1920)0 anti_delta(1930)+ anti_delta(1930)++ anti_delta(1930)- anti_delta(1930)0 anti_delta(1950)+ anti_delta(1950)++ anti_delta(1950)- anti_delta(1950)0 anti_delta+ anti_delta++ anti_delta- anti_delta0 anti_deuteron anti_k(1460)0 anti_k0_star(1430)0 anti_k1(1270)0 anti_k1(1400)0 anti_k2(1770)0 anti_k2_star(1430)0 anti_k2_star(1980)0 anti_k3_star(1780)0 anti_k_star(1410)0 anti_k_star(1680)0 anti_k_star0 anti_kaon0 anti_lambda anti_lambda(1405) anti_lambda(1520) anti_lambda(1600) anti_lambda(1670) anti_lambda(1690) anti_lambda(1800) anti_lambda(1810) anti_lambda(1820) anti_lambda(1830) anti_lambda(1890) anti_lambda(2100) anti_lambda(2110) anti_lambda_b anti_lambda_c+ anti_neutron anti_nu_e anti_nu_mu anti_nu_tau anti_omega- anti_omega_b- anti_omega_c0 anti_proton anti_s_quark anti_sd0_diquark anti_sd1_diquark anti_sigma(1385)+ anti_sigma(1385)- anti_sigma(1385)0 anti_sigma(1660)+ anti_sigma(1660)- anti_sigma(1660)0 anti_sigma(1670)+ anti_sigma(1670)- anti_sigma(1670)0 anti_sigma(1750)+ anti_sigma(1750)- anti_sigma(1750)0 anti_sigma(1775)+ anti_sigma(1775)- anti_sigma(1775)0 anti_sigma(1915)+ anti_sigma(1915)- anti_sigma(1915)0 anti_sigma(1940)+ anti_sigma(1940)- anti_sigma(1940)0 anti_sigma(2030)+ anti_sigma(2030)- anti_sigma(2030)0 anti_sigma+ anti_sigma- anti_sigma0 anti_sigma_b+ anti_sigma_b- anti_sigma_b0 anti_sigma_c+ anti_sigma_c++ anti_sigma_c0 anti_ss1_diquark anti_su0_diquark anti_su1_diquark anti_t_quark anti_triton anti_u_quark anti_ud0_diquark anti_ud1_diquark anti_uu1_diquark anti_xi(1530)- anti_xi(1530)0 anti_xi(1690)- anti_xi(1690)0 anti_xi(1820)- anti_xi(1820)0 anti_xi(1950)- anti_xi(1950)0 anti_xi(2030)- anti_xi(2030)0 anti_xi- anti_xi0 anti_xi_b- anti_xi_b0 anti_xi_c+ anti_xi_c0 b1(1235)+ b1(1235)- b1(1235)0 b_quark bb1_diquark bc0_diquark bc1_diquark bd0_diquark bd1_diquark bs0_diquark bs1_diquark bu0_diquark bu1_diquark c_quark cc1_diquark cd0_diquark cd1_diquark chargedgeantino cs0_diquark cs1_diquark cu0_diquark cu1_diquark d_quark dd1_diquark delta(1600)+ delta(1600)++ delta(1600)- delta(1600)0 delta(1620)+ delta(1620)++ delta(1620)- delta(1620)0 delta(1700)+ delta(1700)++ delta(1700)- delta(1700)0 delta(1900)+ delta(1900)++ delta(1900)- delta(1900)0 delta(1905)+ delta(1905)++ delta(1905)- delta(1905)0 delta(1910)+ delta(1910)++ delta(1910)- delta(1910)0 delta(1920)+ delta(1920)++ delta(1920)- delta(1920)0 delta(1930)+ delta(1930)++ delta(1930)- delta(1930)0 delta(1950)+ delta(1950)++ delta(1950)- delta(1950)0 delta+ delta++ delta- delta0 deuteron e+ e- eta eta(1295) eta(1405) eta(1475) eta2(1645) eta2(1870) eta_prime etac f0(1370) f0(1500) f0(1710) f0(500) f0(980) f1(1285) f1(1420) f2(1270) f2(1810) f2(2010) f2_prime(1525) gamma geantino gluon h1(1170) h1(1380) k(1460)+ k(1460)- k(1460)0 k0_star(1430)+ k0_star(1430)- k0_star(1430)0 k1(1270)+ k1(1270)- k1(1270)0 k1(1400)+ k1(1400)- k1(1400)0 k2(1770)+ k2(1770)- k2(1770)0 k2_star(1430)+ k2_star(1430)- k2_star(1430)0 k2_star(1980)+ k2_star(1980)- k2_star(1980)0 k3_star(1780)+ k3_star(1780)- k3_star(1780)0 k_star(1410)+ k_star(1410)- k_star(1410)0 k_star(1680)+ k_star(1680)- k_star(1680)0 k_star+ k_star- k_star0 kaon+ kaon- kaon0 kaon0L kaon0S lambda lambda(1405) lambda(1520) lambda(1600) lambda(1670) lambda(1690) lambda(1800) lambda(1810) lambda(1820) lambda(1830) lambda(1890) lambda(2100) lambda(2110) lambda_b lambda_c+ mu+ mu- neutron nu_e nu_mu nu_tau omega omega(1420) omega(1650) omega- omega3(1670) omega_b- omega_c0 opticalphoton phi phi(1680) phi3(1850) pi(1300)+ pi(1300)- pi(1300)0 pi+ pi- pi0 pi2(1670)+ pi2(1670)- pi2(1670)0 proton rho(1450)+ rho(1450)- rho(1450)0 rho(1700)+ rho(1700)- rho(1700)0 rho+ rho- rho0 rho3(1690)+ rho3(1690)- rho3(1690)0 s_quark sd0_diquark sd1_diquark sigma(1385)+ sigma(1385)- sigma(1385)0 sigma(1660)+ sigma(1660)- sigma(1660)0 sigma(1670)+ sigma(1670)- sigma(1670)0 sigma(1750)+ sigma(1750)- sigma(1750)0 sigma(1775)+ sigma(1775)- sigma(1775)0 sigma(1915)+ sigma(1915)- sigma(1915)0 sigma(1940)+ sigma(1940)- sigma(1940)0 sigma(2030)+ sigma(2030)- sigma(2030)0 sigma+ sigma- sigma0 sigma_b+ sigma_b- sigma_b0 sigma_c+ sigma_c++ sigma_c0 ss1_diquark su0_diquark su1_diquark t_quark tau+ tau- triton u_quark ud0_diquark ud1_diquark uu1_diquark xi(1530)- xi(1530)0 xi(1690)- xi(1690)0 xi(1820)- xi(1820)0 xi(1950)- xi(1950)0 xi(2030)- xi(2030)0 xi- xi0 xi_b- xi_b0 xi_c+ xi_c0 ion
Command /gps/direction
Guidance :
Set momentum direction.
Direction needs not to be a unit vector.
Angular distribution type is set to planar.
Range of parameters : Px != 0 || Py != 0 || Pz != 0
Parameter : Px
Parameter type : d
Omittable : False
Parameter : Py
Parameter type : d
Omittable : False
Parameter : Pz
Parameter type : d
Omittable : False
Command /gps/energy
Guidance :
Set kinetic energy.
Parameter : Energy
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : GeV
Candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
Command /gps/position
Guidance :
Set starting position of the particle for a Point like source.
Same effect as the two /gps/pos/type Point /gps/pos/centre commands.
Parameter : X
Parameter type : d
Omittable : False
Parameter : Y
Parameter type : d
Omittable : False
Parameter : Z
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : cm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /gps/ion
Guidance :
Set properties of ion to be generated.
[usage] /gps/ion Z A Q E
Z:(int) AtomicNumber
A:(int) AtomicMass
Q:(int) Charge of Ion (in unit of e)
E:(double) Excitation energy (in keV)
Parameter : Z
Parameter type : i
Omittable : False
Default value : 1
Parameter : A
Parameter type : i
Omittable : False
Default value : 1
Parameter : Q
Parameter type : i
Omittable : True
Default value : 0
Parameter : E
Parameter type : d
Omittable : True
Default value : 0.0
Command /gps/ionLvl
Guidance :
Set properties of ion to be generated.
[usage] /gps/ion Z A Q Lvl
Z:(int) AtomicNumber
A:(int) AtomicMass
Q:(int) Charge of Ion (in unit of e)
Lvl:(int) Number of metastable state excitation level (0-9)
Parameter : Z
Parameter type : i
Omittable : False
Default value : 1
Parameter : A
Parameter type : i
Omittable : False
Default value : 1
Parameter : Q
Parameter type : i
Omittable : True
Default value : 0
Parameter : Lvl
Parameter type : i
Omittable : True
Default value : 0.0
Command /gps/time
Guidance :
Set initial time of the particle.
Parameter : t0
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : ns
Candidates : s ms us ns ps second millisecond microsecond nanosecond picosecond
Command /gps/polarization
Guidance :
Set polarization.
Range of parameters : Px>=-1.&&Px<=1.&&Py>=-1.&&Py<=1.&&Pz>=-1.&&Pz<=1.
Parameter : Px
Parameter type : d
Omittable : False
Parameter : Py
Parameter type : d
Omittable : False
Parameter : Pz
Parameter type : d
Omittable : False
Command /gps/number
Guidance :
Set number of particles to be generated per vertex.
Range of parameters : N>0
Parameter : N
Parameter type : i
Omittable : False
Command /gps/verbose
Guidance :
Set Verbose level for GPS
0 : Silent
1 : Limited information
2 : Detailed information
Range of parameters : level>=0 && level <=2
Parameter : level
Parameter type : i
Omittable : False
Command directory path : /gps/source/
Guidance :
Multiple source control sub-directory
Sub-directories :
Commands :
add * Add a new source definition to the particle gun
list * List the defined particle sources
clear * Remove all the defined particle sources
show * Show the current source index and intensity
set * Set the indexed source as the current one
delete * Delete the indexed source from the list
intensity * Reset the current source to the specified intensity
multiplevertex * True for simultaneous generation multiple vertex
flatsampling * True for applying flat (biased) sampling among the sources
Command /gps/source/add
Guidance :
Add a new source definition to the particle gun
with the specified intensity
Range of parameters : addsource > 0.
Parameter : addsource
Parameter type : d
Omittable : False
Command /gps/source/list
Guidance :
List the defined particle sources
Command /gps/source/clear
Guidance :
Remove all the defined particle sources
Command /gps/source/show
Guidance :
Show the current source index and intensity
Command /gps/source/set
Guidance :
Set the indexed source as the current one
so one can change its source definition
Range of parameters : setsource >= 0
Parameter : setsource
Parameter type : i
Omittable : False
Command /gps/source/delete
Guidance :
Delete the indexed source from the list
Range of parameters : deletesource > 0
Parameter : deletesource
Parameter type : i
Omittable : False
Command /gps/source/intensity
Guidance :
Reset the current source to the specified intensity
Range of parameters : setintensity > 0.
Parameter : setintensity
Parameter type : d
Omittable : False
Command /gps/source/multiplevertex
Guidance :
True for simultaneous generation multiple vertex
Default is false
Parameter : multiplevertex
Parameter type : b
Omittable : True
Default value : 0
Command /gps/source/flatsampling
Guidance :
True for applying flat (biased) sampling among the sources
Default is false
Parameter : flatsampling
Parameter type : b
Omittable : True
Default value : 0
Command directory path : /gps/pos/
Guidance :
Positional commands sub-directory
Sub-directories :
Commands :
type * Sets source distribution type.
shape * Sets source shape for Plan, Surface or Volume type source.
centre * Set centre coordinates of source.
rot1 * Set the 1st vector defining the rotation matrix'.
rot2 * Set the 2nd vector defining the rotation matrix'.
halfx * Set x half length of source.
halfy * Set y half length of source.
halfz * Set z half length of source.
radius * Set radius of source.
inner_radius * Set inner radius of source when required.
sigma_r * Set standard deviation in radial of the beam positional profile
sigma_x * Set standard deviation of beam positional profile in x-dir
sigma_y * Set standard deviation of beam positional profile in y-dir
paralp * Angle from y-axis of y' in Para
parthe * Polar angle through centres of z faces
parphi * Azimuth angle through centres of z faces
confine * Confine source to volume (NULL to unset).
Command /gps/pos/type
Guidance :
Sets source distribution type.
Either Point, Beam, Plane, Surface or Volume
Parameter : DisType
Parameter type : s
Omittable : False
Default value : Point
Candidates : Point Beam Plane Surface Volume
Command /gps/pos/shape
Guidance :
Sets source shape for Plan, Surface or Volume type source.
Parameter : Shape
Parameter type : s
Omittable : False
Default value : NULL
Candidates : Circle Annulus Ellipse Square Rectangle Sphere Ellipsoid Cylinder EllipticCylinder Para
Command /gps/pos/centre
Guidance :
Set centre coordinates of source.
Parameter : X
Parameter type : d
Omittable : False
Parameter : Y
Parameter type : d
Omittable : False
Parameter : Z
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : cm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /gps/pos/rot1
Guidance :
Set the 1st vector defining the rotation matrix'.
It does not need to be a unit vector.
Range of parameters : R1x != 0 || R1y != 0 || R1z != 0
Parameter : R1x
Parameter type : d
Omittable : False
Parameter : R1y
Parameter type : d
Omittable : False
Parameter : R1z
Parameter type : d
Omittable : False
Command /gps/pos/rot2
Guidance :
Set the 2nd vector defining the rotation matrix'.
It does not need to be a unit vector.
Range of parameters : R2x != 0 || R2y != 0 || R2z != 0
Parameter : R2x
Parameter type : d
Omittable : False
Parameter : R2y
Parameter type : d
Omittable : False
Parameter : R2z
Parameter type : d
Omittable : False
Command /gps/pos/halfx
Guidance :
Set x half length of source.
Parameter : Halfx
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : cm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /gps/pos/halfy
Guidance :
Set y half length of source.
Parameter : Halfy
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : cm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /gps/pos/halfz
Guidance :
Set z half length of source.
Parameter : Halfz
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : cm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /gps/pos/radius
Guidance :
Set radius of source.
Parameter : Radius
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : cm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /gps/pos/inner_radius
Guidance :
Set inner radius of source when required.
Parameter : Radius0
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : cm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /gps/pos/sigma_r
Guidance :
Set standard deviation in radial of the beam positional profile
applicable to Beam type source only
Parameter : Sigmar
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : cm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /gps/pos/sigma_x
Guidance :
Set standard deviation of beam positional profile in x-dir
applicable to Beam type source only
Parameter : Sigmax
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : cm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /gps/pos/sigma_y
Guidance :
Set standard deviation of beam positional profile in y-dir
applicable to Beam type source only
Parameter : Sigmay
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : cm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /gps/pos/paralp
Guidance :
Angle from y-axis of y' in Para
Parameter : paralp
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : rad
Candidates : rad mrad deg radian milliradian degree
Command /gps/pos/parthe
Guidance :
Polar angle through centres of z faces
Parameter : parthe
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : rad
Candidates : rad mrad deg radian milliradian degree
Command /gps/pos/parphi
Guidance :
Azimuth angle through centres of z faces
Parameter : parphi
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : rad
Candidates : rad mrad deg radian milliradian degree
Command /gps/pos/confine
Guidance :
Confine source to volume (NULL to unset).
Usage: confine VolName
Parameter : VolName
Parameter type : s
Omittable : False
Default value : NULL
Command directory path : /gps/ang/
Guidance :
Angular commands sub-directory
Sub-directories :
Commands :
type * Sets angular source distribution type
rot1 * Sets the 1st vector for angular distribution rotation matrix
rot2 * Sets the 2nd vector for angular distribution rotation matrix
mintheta * Set minimum theta
maxtheta * Set maximum theta
minphi * Set minimum phi
maxphi * Set maximum phi
sigma_r * Set standard deviation in direction for 1D beam.
sigma_x * Set standard deviation in direction in x-direc. for 2D beam
sigma_y * Set standard deviation in direction in y-direc. for 2D beam
focuspoint * Set the focusing point for the beam
user_coor * True for using user defined angular co-ordinates
surfnorm * Makes a user-defined distribution with respect to surface normals rather than x,y,z axes.
Command /gps/ang/type
Guidance :
Sets angular source distribution type
Possible variables are: iso, cos, planar, beam1d, beam2d, focused or user
Parameter : AngDis
Parameter type : s
Omittable : False
Default value : iso
Candidates : iso cos planar beam1d beam2d focused user
Command /gps/ang/rot1
Guidance :
Sets the 1st vector for angular distribution rotation matrix
Need not be a unit vector
Range of parameters : AR1x != 0 || AR1y != 0 || AR1z != 0
Parameter : AR1x
Parameter type : d
Omittable : False
Parameter : AR1y
Parameter type : d
Omittable : False
Parameter : AR1z
Parameter type : d
Omittable : False
Command /gps/ang/rot2
Guidance :
Sets the 2nd vector for angular distribution rotation matrix
Need not be a unit vector
Range of parameters : AR2x != 0 || AR2y != 0 || AR2z != 0
Parameter : AR2x
Parameter type : d
Omittable : False
Parameter : AR2y
Parameter type : d
Omittable : False
Parameter : AR2z
Parameter type : d
Omittable : False
Command /gps/ang/mintheta
Guidance :
Set minimum theta
Parameter : MinTheta
Parameter type : d
Omittable : True
Default value : 0
Parameter : Unit
Parameter type : s
Omittable : True
Default value : rad
Candidates : rad mrad deg radian milliradian degree
Command /gps/ang/maxtheta
Guidance :
Set maximum theta
Parameter : MaxTheta
Parameter type : d
Omittable : True
Default value : 3.14159
Parameter : Unit
Parameter type : s
Omittable : True
Default value : rad
Candidates : rad mrad deg radian milliradian degree
Command /gps/ang/minphi
Guidance :
Set minimum phi
Parameter : MinPhi
Parameter type : d
Omittable : True
Parameter : Unit
Parameter type : s
Omittable : True
Default value : rad
Candidates : rad mrad deg radian milliradian degree
Command /gps/ang/maxphi
Guidance :
Set maximum phi
Parameter : MaxPhi
Parameter type : d
Omittable : True
Default value : 6.28319
Parameter : Unit
Parameter type : s
Omittable : True
Default value : rad
Candidates : rad mrad deg radian milliradian degree
Command /gps/ang/sigma_r
Guidance :
Set standard deviation in direction for 1D beam.
Parameter : Sigmara
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : rad
Candidates : rad mrad deg radian milliradian degree
Command /gps/ang/sigma_x
Guidance :
Set standard deviation in direction in x-direc. for 2D beam
Parameter : Sigmaxa
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : rad
Candidates : rad mrad deg radian milliradian degree
Command /gps/ang/sigma_y
Guidance :
Set standard deviation in direction in y-direc. for 2D beam
Parameter : Sigmaya
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : rad
Candidates : rad mrad deg radian milliradian degree
Command /gps/ang/focuspoint
Guidance :
Set the focusing point for the beam
Parameter : x
Parameter type : d
Omittable : False
Parameter : y
Parameter type : d
Omittable : False
Parameter : z
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : cm
Candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
Command /gps/ang/user_coor
Guidance :
True for using user defined angular co-ordinates
Default is false
Parameter : useuserangaxis
Parameter type : b
Omittable : True
Default value : 0
Command /gps/ang/surfnorm
Guidance :
Makes a user-defined distribution with respect to surface normals rather than x,y,z axes.
Default is false
Parameter : surfnorm
Parameter type : b
Omittable : True
Default value : 0
Command directory path : /gps/ene/
Guidance :
Spectral commands sub-directory
Sub-directories :
Commands :
type * Sets energy distribution type
min * Sets minimum energy
max * Sets maximum energy
mono * Sets a monocromatic energy (same as gps/energy)
sigma * Sets the standard deviation for Gaussian energy dist.
alpha * Sets Alpha (index) for power-law energy dist.
temp * Sets the temperature for Brem and BBody distributions (in Kelvin)
ezero * Sets E_0 for exponential distribution (in MeV)
gradient * Sets the gradient for Lin distribution (in 1/MeV)
intercept * Sets the intercept for Lin distributions (in MeV)
biasAlpha * Sets the power-law index for the energy sampling distri. )
calculate * Calculates the distributions for Cdg and BBody
emspec * True for energy and false for momentum spectra
diffspec * True for differential and flase for integral spectra
applyEneWeight * Apply energy weight.
Command /gps/ene/type
Guidance :
Sets energy distribution type
Parameter : EnergyDis
Parameter type : s
Omittable : False
Default value : Mono
Candidates : Mono Lin Pow Exp CPow Gauss Brem Bbody Cdg User Arb Epn LW
Command /gps/ene/min
Guidance :
Sets minimum energy
Parameter : emin
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : keV
Candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
Command /gps/ene/max
Guidance :
Sets maximum energy
Parameter : emax
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : keV
Candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
Command /gps/ene/mono
Guidance :
Sets a monocromatic energy (same as gps/energy)
Parameter : monoenergy
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : keV
Candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
Command /gps/ene/sigma
Guidance :
Sets the standard deviation for Gaussian energy dist.
Parameter : Sigmae
Parameter type : d
Omittable : False
Parameter : Unit
Parameter type : s
Omittable : True
Default value : keV
Candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
Command /gps/ene/alpha
Guidance :
Sets Alpha (index) for power-law energy dist.
Parameter : alpha
Parameter type : d
Omittable : False
Command /gps/ene/temp
Guidance :
Sets the temperature for Brem and BBody distributions (in Kelvin)
Parameter : temp
Parameter type : d
Omittable : False
Command /gps/ene/ezero
Guidance :
Sets E_0 for exponential distribution (in MeV)
Parameter : ezero
Parameter type : d
Omittable : False
Command /gps/ene/gradient
Guidance :
Sets the gradient for Lin distribution (in 1/MeV)
Parameter : gradient
Parameter type : d
Omittable : False
Command /gps/ene/intercept
Guidance :
Sets the intercept for Lin distributions (in MeV)
Parameter : intercept
Parameter type : d
Omittable : False
Command /gps/ene/biasAlpha
Guidance :
Sets the power-law index for the energy sampling distri. )
Parameter : arbeint
Parameter type : d
Omittable : False
Command /gps/ene/calculate
Guidance :
Calculates the distributions for Cdg and BBody
Command /gps/ene/emspec
Guidance :
True for energy and false for momentum spectra
Parameter : energyspec
Parameter type : b
Omittable : True
Default value : 1
Command /gps/ene/diffspec
Guidance :
True for differential and flase for integral spectra
Parameter : diffspec
Parameter type : b
Omittable : True
Default value : 1
Command /gps/ene/applyEneWeight
Guidance :
Apply energy weight.
- Instead of using the Arb type histogram for sampling the energy spectrum,
energy is sampled by Linear distribution, and the Arb type histogram is
used for the weight of the generated particle.
- "/gps/ene/type LW" automatically applies this command.
- If this command has to be explicitly used, "/gps/ene/type" distribution mush be Lin.
Parameter : flag
Parameter type : b
Omittable : True
Default value : 1
Command directory path : /gps/hist/
Guidance :
Histogram, biasing commands sub-directory
Sub-directories :
Commands :
type * Sets histogram type
reset * Reset (clean) the histogram
point * Allows user to define a histogram
file * Imports the arb energy hist in an ASCII file
inter * Sets the interpolation method for arbitrary distribution.
Command /gps/hist/type
Guidance :
Sets histogram type
Parameter : HistType
Parameter type : s
Omittable : False
Default value : biasx
Candidates : biasx biasy biasz biast biasp biase biaspt biaspp theta phi energy arb epn
Command /gps/hist/reset
Guidance :
Reset (clean) the histogram
Parameter : HistType
Parameter type : s
Omittable : False
Default value : energy
Candidates : biasx biasy biasz biast biasp biase biaspt biaspp theta phi energy arb epn
Command /gps/hist/point
Guidance :
Allows user to define a histogram
Enter: Ehi Weight
Range of parameters : Ehi >= 0. && Weight >= 0.
Parameter : Ehi
Parameter type : d
Omittable : True
Default value : taken from the current value
Parameter : Weight
Parameter type : d
Omittable : True
Default value : taken from the current value
Parameter : Junk
Parameter type : d
Omittable : True
Default value : taken from the current value
Command /gps/hist/file
Guidance :
Imports the arb energy hist in an ASCII file
Parameter : HistFile
Parameter type : s
Omittable : False
Command /gps/hist/inter
Guidance :
Sets the interpolation method for arbitrary distribution.
Spline interpolation may not be applicable for some distributions.
Parameter : int
Parameter type : s
Omittable : False
Default value : Lin
Candidates : Lin Log Exp Spline
Mulassis/ml-v02-00/r342
