source: trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/AllResources/Control/UIcommands/_adjoint_.html @ 1222

Last change on this file since 1222 was 1222, checked in by garnier, 15 years ago

CVS update
File size: 5.0 KB
Line 
1<html><head><title>Commands in /adjoint/</title></head>
2<body bgcolor="#ffffff"><h2>/adjoint/</h2><p>
3Control of the adjoint or reverse monte carlo simulation<br>
4<p><hr><p>
5<h2>Sub-directories : </h2><dl>
6</dl><p><hr><p>
7<h2>Commands : </h2><dl>
8<p><br><p><dt><b>start_run [<i>numberOfEvent</i>]</b>
9<p><dd>
10Start an adjoint Run.<br>
11Default number of events to be processed is 1.<br>
12<p><dd>Available Geant4 state(s) : PreInit
13Idle
14<p><dd>Parameters<table border=1>
15<tr><td>numberOfEvent
16<td>type i
17<td>Omittable : default value = 1
18<td>Parameter range : numberOfEvent &gt;= 0
19</table>
20<p><br><p><dt><b>DefineSphericalExtSource [<i>X</i>] [<i>Y</i>] [<i>Z</i>] [<i>R</i>] [<i>unit</i>]</b>
21<p><dd>
22Define a spherical external source.<br>
23<p><dd>Available at all Geant4 states.
24<p><dd>Parameters<table border=1>
25<tr><td>X
26<td>type d
27<td>Omittable : default value =
28<td><tr><td>Y
29<td>type d
30<td>Omittable : default value =
31<td><tr><td>Z
32<td>type d
33<td>Omittable : default value =
34<td><tr><td>R
35<td>type d
36<td>Omittable : default value =
37<td>Parameter range : R &gt;= 0
38<tr><td>unit
39<td>type s
40<td>Omittable : default value =
41<td></table>
42<p><br><p><dt><b>DefineSphericalExtSourceCenteredOnAVolume [<i>phys_vol_name</i>] [<i>R</i>] [<i>unit</i>]</b>
43<p><dd>
44Define a spherical external source with the center located at the center of a physical volume<br>
45<p><dd>Available at all Geant4 states.
46<p><dd>Parameters<table border=1>
47<tr><td>phys_vol_name
48<td>type s
49<td>Omittable : default value =
50<td><tr><td>R
51<td>type d
52<td>Omittable : default value =
53<td>Parameter range : R &gt;= 0
54<tr><td>unit
55<td>type s
56<td>Omittable : default value =
57<td></table>
58<p><br><p><dt><b>DefineExtSourceOnExtSurfaceOfAVolume [<i>phys_vol_name</i>]</b>
59<p><dd>
60Set the external source on the external surface of a physical volume<br>
61<p><dd>Available at all Geant4 states.
62<p><dd>Parameters<table border=1>
63<tr><td>phys_vol_name
64<td>type s
65<td><td></table>
66<p><br><p><dt><b>SetExtSourceEmax [<i>Emax</i>] [<i>Unit</i>]</b>
67<p><dd>
68Set the maximum  energy of the external source<br>
69<p><dd>Available Geant4 state(s) : PreInit
70Idle
71<p><dd>Parameters<table border=1>
72<tr><td>Emax
73<td>type d
74<td><td><tr><td>Unit
75<td>type s
76<td><td>Parameter candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
77</table>
78<p><br><p><dt><b>DefineSphericalAdjSource [<i>X</i>] [<i>Y</i>] [<i>Z</i>] [<i>R</i>] [<i>unit</i>]</b>
79<p><dd>
80Define a spherical adjoint source.<br>
81<p><dd>Available at all Geant4 states.
82<p><dd>Parameters<table border=1>
83<tr><td>X
84<td>type d
85<td>Omittable : default value =
86<td><tr><td>Y
87<td>type d
88<td>Omittable : default value =
89<td><tr><td>Z
90<td>type d
91<td>Omittable : default value =
92<td><tr><td>R
93<td>type d
94<td>Omittable : default value =
95<td>Parameter range : R &gt;= 0
96<tr><td>unit
97<td>type s
98<td>Omittable : default value =
99<td></table>
100<p><br><p><dt><b>DefineSphericalAdjSourceCenteredOnAVolume [<i>phys_vol_name</i>] [<i>R</i>] [<i>unit</i>]</b>
101<p><dd>
102Define a spherical adjoint source with the center located at the center of a physical volume<br>
103<p><dd>Available at all Geant4 states.
104<p><dd>Parameters<table border=1>
105<tr><td>phys_vol_name
106<td>type s
107<td>Omittable : default value =
108<td><tr><td>R
109<td>type d
110<td>Omittable : default value =
111<td>Parameter range : R &gt;= 0
112<tr><td>unit
113<td>type s
114<td>Omittable : default value =
115<td></table>
116<p><br><p><dt><b>DefineAdjSourceOnExtSurfaceOfAVolume [<i>phys_vol_name</i>]</b>
117<p><dd>
118Set the adjoint source on the external surface of physical volume<br>
119<p><dd>Available at all Geant4 states.
120<p><dd>Parameters<table border=1>
121<tr><td>phys_vol_name
122<td>type s
123<td><td></table>
124<p><br><p><dt><b>SetAdjSourceEmin [<i>Emin</i>] [<i>Unit</i>]</b>
125<p><dd>
126Set the minimum energy  of the adjoint source<br>
127<p><dd>Available Geant4 state(s) : PreInit
128Idle
129<p><dd>Parameters<table border=1>
130<tr><td>Emin
131<td>type d
132<td><td><tr><td>Unit
133<td>type s
134<td><td>Parameter candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
135</table>
136<p><br><p><dt><b>SetAdjSourceEmax [<i>Emax</i>] [<i>Unit</i>]</b>
137<p><dd>
138Set the maximum energy of the adjoint source<br>
139<p><dd>Available Geant4 state(s) : PreInit
140Idle
141<p><dd>Parameters<table border=1>
142<tr><td>Emax
143<td>type d
144<td><td><tr><td>Unit
145<td>type s
146<td><td>Parameter candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
147</table>
148<p><br><p><dt><b>ConsiderAsPrimary [<i>particle</i>]</b>
149<p><dd>
150Set the selected particle as primary<br>
151<p><dd>Available at all Geant4 states.
152<p><dd>Parameters<table border=1>
153<tr><td>particle
154<td>type s
155<td><td>Parameter candidates : e- gamma proton ion
156</table>
157<p><br><p><dt><b>NeglectAsPrimary [<i>particle</i>]</b>
158<p><dd>
159Remove the selected particle from the lits of primaries<br>
160<p><dd>Available at all Geant4 states.
161<p><dd>Parameters<table border=1>
162<tr><td>particle
163<td>type s
164<td><td>Parameter candidates : e- gamma proton ion
165</table>
166</dl></body></html>
Note: See TracBrowser for help on using the repository browser.