[1208] | 1 | <html><head><title>Commands in /run/</title></head> |
---|
| 2 | <body bgcolor="#ffffff"><h2>/run/</h2><p> |
---|
| 3 | Run control commands.<br> |
---|
| 4 | <p><hr><p> |
---|
| 5 | <h2>Sub-directories : </h2><dl> |
---|
| 6 | <p><br><p><dt><a href="_run_particle_.html">/run/particle/</a> |
---|
| 7 | <p><dd>Commands for G4VUserPhysicsList. |
---|
| 8 | </dl><p><hr><p> |
---|
| 9 | <h2>Commands : </h2><dl> |
---|
| 10 | <p><br><p><dt><b>initialize</b> |
---|
| 11 | <p><dd> |
---|
| 12 | Initialize G4 kernel.<br> |
---|
| 13 | <p><dd>Available Geant4 state(s) : PreInit |
---|
| 14 | Idle |
---|
| 15 | <p><br><p><dt><b>beamOn [<i>numberOfEvent</i>] [<i>macroFile</i>] [<i>nSelect</i>]</b> |
---|
| 16 | <p><dd> |
---|
| 17 | Start a Run.<br> |
---|
| 18 | If G4 kernel is not initialized, it will be initialized.<br> |
---|
| 19 | Default number of events to be processed is 1.<br> |
---|
| 20 | The second and third arguments can be used for<br> |
---|
| 21 | executing a macro file at the end of each event.<br> |
---|
| 22 | If the second argument, i.e. name of the macro<br> |
---|
| 23 | file, is given but the third argument is not,<br> |
---|
| 24 | the macro file will be executed for all of the<br> |
---|
| 25 | event.<br> |
---|
| 26 | If the third argument (nSelect) is given, the<br> |
---|
| 27 | macro file will be executed only for the first<br> |
---|
| 28 | nSelect events.<br> |
---|
| 29 | <p><dd>Available Geant4 state(s) : PreInit |
---|
| 30 | Idle |
---|
| 31 | <p><dd>Parameters<table border=1> |
---|
| 32 | <tr><td>numberOfEvent |
---|
| 33 | <td>type i |
---|
| 34 | <td>Omittable : default value = 1 |
---|
| 35 | <td>Parameter range : numberOfEvent >= 0 |
---|
| 36 | <tr><td>macroFile |
---|
| 37 | <td>type s |
---|
| 38 | <td>Omittable : default value = ***NULL*** |
---|
| 39 | <td><tr><td>nSelect |
---|
| 40 | <td>type i |
---|
| 41 | <td>Omittable : default value = -1 |
---|
| 42 | <td>Parameter range : nSelect>=-1 |
---|
| 43 | </table> |
---|
| 44 | <p><br><p><dt><b>verbose [<i>level</i>]</b> |
---|
| 45 | <p><dd> |
---|
| 46 | Set the Verbose level of G4RunManager.<br> |
---|
| 47 | 0 : Silent (default)<br> |
---|
| 48 | 1 : Display main topics<br> |
---|
| 49 | 2 : Display main topics and run summary<br> |
---|
| 50 | <p><dd>Range : level >=0 && level <=2 |
---|
| 51 | <p><dd>Available at all Geant4 states. |
---|
| 52 | <p><dd>Parameters<table border=1> |
---|
| 53 | <tr><td>level |
---|
| 54 | <td>type i |
---|
| 55 | <td>Omittable : default value = 0 |
---|
| 56 | <td></table> |
---|
| 57 | <p><br><p><dt><b>dumpRegion [<i>regionName</i>]</b> |
---|
| 58 | <p><dd> |
---|
| 59 | Dump region information.<br> |
---|
| 60 | In case name of a region is not given, all regions will be displayed.<br> |
---|
| 61 | <p><dd>Available Geant4 state(s) : Idle |
---|
| 62 | <p><dd>Parameters<table border=1> |
---|
| 63 | <tr><td>regionName |
---|
| 64 | <td>type s |
---|
| 65 | <td>Omittable : default value = **ALL** |
---|
| 66 | <td></table> |
---|
| 67 | <p><br><p><dt><b>dumpCouples</b> |
---|
| 68 | <p><dd> |
---|
| 69 | Dump material-cuts-couple information.<br> |
---|
| 70 | Note that material-cuts-couple information is updated<br> |
---|
| 71 | after BeamOn has started.<br> |
---|
| 72 | <p><dd>Available Geant4 state(s) : Idle |
---|
| 73 | <p><br><p><dt><b>optimizeGeometry [<i>optimizeFlag</i>]</b> |
---|
| 74 | <p><dd> |
---|
| 75 | Set the optimization flag for geometry.<br> |
---|
| 76 | If it is set to TRUE, G4GeometryManager will optimize<br> |
---|
| 77 | the geometry definitions.<br> |
---|
| 78 | GEANT4 is initialized with this flag as TRUE.<br> |
---|
| 79 | <p><dd>Available Geant4 state(s) : PreInit |
---|
| 80 | Idle |
---|
| 81 | <p><dd>Parameters<table border=1> |
---|
| 82 | <tr><td>optimizeFlag |
---|
| 83 | <td>type b |
---|
| 84 | <td>Omittable : default value = 1 |
---|
| 85 | <td></table> |
---|
| 86 | <p><br><p><dt><b>breakAtBeginOfEvent [<i>flag</i>]</b> |
---|
| 87 | <p><dd> |
---|
| 88 | Set a break point at the begining of every event.<br> |
---|
| 89 | <p><dd>Available at all Geant4 states. |
---|
| 90 | <p><dd>Parameters<table border=1> |
---|
| 91 | <tr><td>flag |
---|
| 92 | <td>type b |
---|
| 93 | <td>Omittable : default value = 1 |
---|
| 94 | <td></table> |
---|
| 95 | <p><br><p><dt><b>breakAtEndOfEvent [<i>flag</i>]</b> |
---|
| 96 | <p><dd> |
---|
| 97 | Set a break point at the end of every event.<br> |
---|
| 98 | <p><dd>Available at all Geant4 states. |
---|
| 99 | <p><dd>Parameters<table border=1> |
---|
| 100 | <tr><td>flag |
---|
| 101 | <td>type b |
---|
| 102 | <td>Omittable : default value = 1 |
---|
| 103 | <td></table> |
---|
| 104 | <p><br><p><dt><b>abort [<i>softAbort</i>]</b> |
---|
| 105 | <p><dd> |
---|
| 106 | Abort current run processing.<br> |
---|
| 107 | If softAbort is false (default), currently processing event will be immediately aborted,<br> |
---|
| 108 | while softAbort is true, abortion occurs after processing the current event.<br> |
---|
| 109 | <p><dd>Available Geant4 state(s) : GeomClosed |
---|
| 110 | EventProc |
---|
| 111 | <p><dd>Parameters<table border=1> |
---|
| 112 | <tr><td>softAbort |
---|
| 113 | <td>type b |
---|
| 114 | <td>Omittable : default value = 0 |
---|
| 115 | <td></table> |
---|
| 116 | <p><br><p><dt><b>abortCurrentEvent</b> |
---|
| 117 | <p><dd> |
---|
| 118 | Abort currently processing event.<br> |
---|
| 119 | <p><dd>Available Geant4 state(s) : EventProc |
---|
| 120 | <p><br><p><dt><b>geometryModified</b> |
---|
| 121 | <p><dd> |
---|
| 122 | Force geometry to be closed again.<br> |
---|
| 123 | This command must be applied<br> |
---|
| 124 | if geometry has been modified after the<br> |
---|
| 125 | first initialization (or BeamOn).<br> |
---|
| 126 | <p><dd>Available Geant4 state(s) : PreInit |
---|
| 127 | Idle |
---|
| 128 | <p><br><p><dt><b>physicsModified</b> |
---|
| 129 | <p><dd> |
---|
| 130 | Force all physics tables recalculated again.<br> |
---|
| 131 | This command must be applied<br> |
---|
| 132 | if physics process has been modified after the<br> |
---|
| 133 | first initialization (or BeamOn).<br> |
---|
| 134 | <p><dd>Available Geant4 state(s) : PreInit |
---|
| 135 | Idle |
---|
| 136 | <p><br><p><dt><b>cutoffModified</b> |
---|
| 137 | <p><dd> |
---|
| 138 | /run/cutoffModified becomes obsolete.<br> |
---|
| 139 | It is safe to remove invoking this command.<br> |
---|
| 140 | <p><dd>Available at all Geant4 states. |
---|
| 141 | <p><br><p><dt><b>constructScoringWorlds</b> |
---|
| 142 | <p><dd> |
---|
| 143 | Constrct scoring parallel world(s) if defined.<br> |
---|
| 144 | This command is not mandatory, but automatically called when a run starts.<br> |
---|
| 145 | But the user may use this to visualize the scoring world(s) before a run to start.<br> |
---|
| 146 | <p><dd>Available Geant4 state(s) : Idle |
---|
| 147 | <p><br><p><dt><b>storeRndmStatToEvent [<i>flag</i>]</b> |
---|
| 148 | <p><dd> |
---|
| 149 | Flag to store rndm status to G4Event object.<br> |
---|
| 150 | flag = 0 : not store (default)<br> |
---|
| 151 | flag = 1 : status before primary particle generation is stored<br> |
---|
| 152 | flag = 2 : status before event processing (after primary particle generation) is stored<br> |
---|
| 153 | flag = 3 : both are stored<br> |
---|
| 154 | Note: Some performance overhead may be seen by storing rndm status, in particular<br> |
---|
| 155 | for the case of simplest geometry and small number of tracks per event.<br> |
---|
| 156 | <p><dd>Range : flag>=0 && flag<3 |
---|
| 157 | <p><dd>Available Geant4 state(s) : PreInit |
---|
| 158 | Idle |
---|
| 159 | <p><dd>Parameters<table border=1> |
---|
| 160 | <tr><td>flag |
---|
| 161 | <td>type i |
---|
| 162 | <td>Omittable : default value = 0 |
---|
| 163 | <td></table> |
---|
| 164 | <p><br><p><dt><b>randomNumberStatusDirectory [<i>fileName</i>]</b> |
---|
| 165 | <p><dd> |
---|
| 166 | Define the directory name of the rndm status files.<br> |
---|
| 167 | Directory must be creates before storing the files.<br> |
---|
| 168 | OBSOLETE --- Please use commands in /random/ directory<br> |
---|
| 169 | <p><dd>Available Geant4 state(s) : PreInit |
---|
| 170 | Idle |
---|
| 171 | GeomClosed |
---|
| 172 | <p><dd>Parameters<table border=1> |
---|
| 173 | <tr><td>fileName |
---|
| 174 | <td>type s |
---|
| 175 | <td>Omittable : default value = ./ |
---|
| 176 | <td></table> |
---|
| 177 | <p><br><p><dt><b>storeRandomNumberStatus [<i>flag</i>]</b> |
---|
| 178 | <p><dd> |
---|
| 179 | The randomNumberStatus will be saved at :<br> |
---|
| 180 | begining of run (currentRun.rndm) and begining of event (currentEvent.rndm) <br> |
---|
| 181 | OBSOLETE --- Please use commands in /random/ directory<br> |
---|
| 182 | <p><dd>Available at all Geant4 states. |
---|
| 183 | <p><dd>Parameters<table border=1> |
---|
| 184 | <tr><td>flag |
---|
| 185 | <td>type i |
---|
| 186 | <td>Omittable : default value = 1 |
---|
| 187 | <td></table> |
---|
| 188 | <p><br><p><dt><b>restoreRandomNumberStatus [<i>fileName</i>]</b> |
---|
| 189 | <p><dd> |
---|
| 190 | Reset the status of the rndm engine from a file.<br> |
---|
| 191 | See CLHEP manual for detail.<br> |
---|
| 192 | The engine status must be stored beforehand.<br> |
---|
| 193 | Directory of the status file should be set by /random/setDirectoryName.<br> |
---|
| 194 | OBSOLETE --- Please use commands in /random/ directory<br> |
---|
| 195 | <p><dd>Available Geant4 state(s) : PreInit |
---|
| 196 | Idle |
---|
| 197 | GeomClosed |
---|
| 198 | <p><dd>Parameters<table border=1> |
---|
| 199 | <tr><td>fileName |
---|
| 200 | <td>type s |
---|
| 201 | <td>Omittable : default value = currentRun.rndm |
---|
| 202 | <td></table> |
---|
| 203 | <p><br><p><dt><b>setCut [<i>cut</i>] [<i>Unit</i>]</b> |
---|
| 204 | <p><dd> |
---|
| 205 | Set default cut value <br> |
---|
| 206 | <p><dd>Range : cut >0.0 |
---|
| 207 | <p><dd>Available Geant4 state(s) : PreInit |
---|
| 208 | Idle |
---|
| 209 | <p><dd>Parameters<table border=1> |
---|
| 210 | <tr><td>cut |
---|
| 211 | <td>type d |
---|
| 212 | <td><td><tr><td>Unit |
---|
| 213 | <td>type s |
---|
| 214 | <td>Omittable : default value = mm |
---|
| 215 | <td>Parameter candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi |
---|
| 216 | </table> |
---|
| 217 | <p><br><p><dt><b>setCutForRegion [<i>Region</i>] [<i>cut</i>] [<i>Unit</i>]</b> |
---|
| 218 | <p><dd> |
---|
| 219 | Set cut value for a region<br> |
---|
| 220 | <p><dd>Available Geant4 state(s) : Idle |
---|
| 221 | <p><dd>Parameters<table border=1> |
---|
| 222 | <tr><td>Region |
---|
| 223 | <td>type s |
---|
| 224 | <td><td><tr><td>cut |
---|
| 225 | <td>type d |
---|
| 226 | <td><td>Parameter range : cut >0.0 |
---|
| 227 | <tr><td>Unit |
---|
| 228 | <td>type s |
---|
| 229 | <td>Omittable : default value = mm |
---|
| 230 | <td>Parameter candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi |
---|
| 231 | </table> |
---|
| 232 | </dl></body></html> |
---|