source: trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/AllResources/Control/UIcommands/particle.txt @ 904

Last change on this file since 904 was 904, checked in by garnier, 16 years ago

ajout de la doc
File size: 4.1 KB
Line 
1/control/manual /particle
2Command directory path : /particle/
3
4
5Guidance :
6Particle control commands.
7
8 Sub-directories :
9   /particle/property/   Paricle Table control commands.
10   /particle/process/   Process Manager control commands.
11 Commands :
12   select * Select particle
13   list * List name of particles.
14   find * Find particle by encoding
15
16
17Command /particle/select
18Guidance :
19Select particle
20
21Parameter : particle name
22 Parameter type  : s
23 Omittable       : False
24 Default value   : none
25
26
27
28Command /particle/list
29Guidance :
30List name of particles.
31 all(default)/lepton/baryon/meson/nucleus/quarks
32
33Parameter : particle type
34 Parameter type  : s
35 Omittable       : True
36 Default value   : all
37 Candidates      : all lepton baryon meson nucleus quarks
38
39
40
41Command /particle/find
42Guidance :
43Find particle by encoding
44
45Parameter : encoding
46 Parameter type  : i
47 Omittable       : False
48 Default value   : 0
49
50Command directory path : /particle/property/
51
52
53Guidance :
54Paricle Table control commands.
55
56 Sub-directories :
57   /particle/property/decay/   Decay Table control commands.
58 Commands :
59   dump * dump particle properties.
60   stable * Set stable flag.
61   lifetime * Set life time.
62   verbose * Set Verbose level of particle property.
63
64
65Command /particle/property/dump
66Guidance :
67dump particle properties.
68
69
70
71Command /particle/property/stable
72Guidance :
73Set stable flag.
74  false: Unstable   true: Stable
75
76Parameter : stable
77 Parameter type  : b
78 Omittable       : False
79
80
81
82Command /particle/property/lifetime
83Guidance :
84Set life time.
85Unit of the time can be :
86 s, ms, ns (default)
87 Range of parameters : life >0.0
88
89Parameter : life
90 Parameter type  : d
91 Omittable       : False
92 Default value   : 0
93
94Parameter : Unit
95 Parameter type  : s
96 Omittable       : True
97 Default value   : ns
98 Candidates      : s ms mus ns ps second millisecond microsecond nanosecond picosecond
99
100
101
102Command /particle/property/verbose
103Guidance :
104Set Verbose level of particle property.
105 0 : Silent (default)
106 1 : Display warning messages
107 2 : Display more
108 Range of parameters : verbose_level >=0
109
110Parameter : verbose_level
111 Parameter type  : i
112 Omittable       : True
113 Default value   : 0
114
115Command directory path : /particle/property/decay/
116
117
118Guidance :
119Decay Table control commands.
120
121 Sub-directories :
122 Commands :
123   select * Enter index of decay mode.
124   dump * Dump decay mode information.
125   br * Set branching ratio. [0< BR <1.0]
126
127
128Command /particle/property/decay/select
129Guidance :
130Enter index of decay mode.
131 Range of parameters : mode >=0
132
133Parameter : mode
134 Parameter type  : i
135 Omittable       : True
136 Default value   : 0
137
138
139
140Command /particle/property/decay/dump
141Guidance :
142Dump decay mode information.
143
144
145
146Command /particle/property/decay/br
147Guidance :
148Set branching ratio. [0< BR <1.0]
149 Range of parameters : (br >=0.0) && (br <=1.0)
150
151Parameter : br
152 Parameter type  : d
153 Omittable       : False
154
155Command directory path : /particle/process/
156
157
158Guidance :
159Process Manager control commands.
160
161 Sub-directories :
162 Commands :
163   dump * dump process manager or process information
164   verbose * Set Verbose Level for Process or Process Manager
165   activate * Activate process 
166   inactivate * Inactivate process 
167
168
169Command /particle/process/dump
170Guidance :
171dump process manager or process information
172  dump [process index]
173   process index: -1 for process manager
174
175Parameter : index
176 Parameter type  : i
177 Omittable       : True
178 Default value   : -1
179
180
181
182Command /particle/process/verbose
183Guidance :
184Set Verbose Level for Process or Process Manager
185  Verbose [Verbose] [process index]
186   process index: -1 for process manager
187
188Parameter : Verbose
189 Parameter type  : i
190 Omittable       : True
191 Default value   : 1
192
193Parameter : index
194 Parameter type  : i
195 Omittable       : True
196 Default value   : -1
197
198
199
200Command /particle/process/activate
201Guidance :
202Activate process 
203 Activate [process index]
204 Range of parameters : index >=0
205
206Parameter : index
207 Parameter type  : i
208 Omittable       : False
209 Default value   : 0
210
211
212
213Command /particle/process/inactivate
214Guidance :
215Inactivate process 
216 inactivate [process index]
217 Range of parameters : index >=0
218
219Parameter : index
220 Parameter type  : i
221 Omittable       : False
222 Default value   : 0
Note: See TracBrowser for help on using the repository browser.