- Update to pythia8140
[u/mrichter/AliRoot.git] / PYTHIA8 / pythia8140 / xmldoc / SettingsScheme.xml
1 <chapter name="The Settings Scheme">
2
3 <h2>The Settings Scheme</h2>
4
5 The <code>Settings</code> class keeps track of all the flags, modes, 
6 parameters and words used during the event generation. As such, it 
7 serves all the <code>Pythia</code> program elements from one central 
8 repository. Accessing it allows the user to modify the generator 
9 behaviour. 
10
11 <p/>
12 Each <code>Pythia</code> object has a public member <code>settings</code> 
13 of the <code>Settings</code> class. Therefore you access the 
14 settings methods as <code>pythia.settings.command(argument)</code>,
15 assuming that <code>pythia</code> is an instance of the <code>Pythia</code> 
16 class. Further, for the most frequent user tasks, <code>Pythia</code> 
17 methods have been defined, so that <code>pythia.command(argument)</code> 
18 would work, see further below.
19
20 <p/>
21 The central section on this page is the Operation one. The preceding 
22 concepts section is there mainly to introduce the basic structure and 
23 the set of properties that can be accessed. The subsequent sections 
24 provide a complete listing of the existing public methods, which most 
25 users probably will have little interaction with.
26
27 <h3>Concepts</h3>
28
29 We distinguish four kinds of user-modifiable variables, by the way
30 they have to be stored:
31 <ol>
32 <li>Flags are on/off switches, and are stored as <code>bool</code>.</li>
33 <li>Modes corresponds to a finite enumeration of separate options,
34    and are stored as <code>int</code>.</li>
35 <li>Parameters take a continuum of values, and are stored as 
36 <code>double</code>. The shorthand notation parm is used in the C++ 
37 code and XML tags, so that all four kinds are represented by
38 four-letter type names.</li>
39 <li>Words are simple character strings and are stored as 
40 <code>string</code>. No blanks or double quotation marks (&quot;) may 
41 appear inside a word, the former to simplify parsing of an input file
42 and the latter not to cause conflicts with XML attribute delimiters.
43 Currently the main application is to store file names.</li>
44 </ol>
45
46 <p/>
47 In general, each variable stored in <code>Settings</code> is associated 
48 with four kinds of information:
49 <ul>
50 <li>The variable name, of the form <code>class:name</code> 
51 (or <code>file:name</code>, usually these agree), e.g. 
52 <code>TimeShower:pTmin</code>. The class/file part usually identifies 
53 the <code>.xml</code> file where the variable is defined, and the part of 
54 the program where it is used, but such a connection cannot be strictly
55 upheld, since e.g. the same variable may be used in a few different
56 cases (even if most of them are not).</li> 
57 <li>The default value, set in the original declaration, and intended
58 to represent a reasonable choice.</li> 
59 <li>The current value, which differs from the default when the user so 
60 requests.</li>
61 <li>An allowed range of values, represented by meaningful
62 minimum and maximum values. This has no sense for a <code>flag</code> 
63 or a <code>word</code> (and is not used there), is usually rather 
64 well-defined for a <code>mode</code>, but less so for a <code>parm</code>. 
65 Often the allowed range exaggerates the degree of our current knowledge, 
66 so as not to restrict too much what the user can do. One may choose 
67 not to set the lower or upper limit, in which case the range is 
68 open-ended.</li>   
69 </ul>
70
71 <p/>
72 Technically, the <code>Settings</code> class is implemented with the 
73 help of four separate maps, one for each kind of variable, with the 
74 variable <code>name</code> used as key. 
75
76 <h3>Operation</h3>
77     
78 The normal flow of setting values is:
79
80 <ol>
81
82 <p/> <li>
83 When a <code>Pythia</code> object <code>pythia </code>is created, 
84 the member <code>pythia.settings</code> is asked to scan the files
85 listed in the <code>Index.xml</code> file in the <code>xmldoc</code> 
86 subdirectory.
87
88 <p/>
89 In all of the files scanned, lines beginning with 
90 <code>&lt;flag</code>, <code>&lt;mode</code>, <code>&lt;parm</code> 
91 or <code>&lt;word</code> are identified, and the information on 
92 such a line is used to define a new flag, mode, parameter or word. 
93 To exemplify, consider a line
94 <pre>
95 &lt;parm name="TimeShower:pTmin" default="0.5" min="0.1" max="2.0">
96 </pre> 
97 which appears in the <code>TimeShower.xml</code> file, and there
98 defines a parameter <code>TimeShower:pTmin</code> with default value 
99 0.5 GeV and allowed variation in the range 0.1 - 2.0 GeV. The min 
100 and max values are optional.
101 <note>Important:</note> the values in the <code>.xml</code> files should 
102 not be changed, except by the PYTHIA authors. Any changes should be 
103 done with the help of the methods described below.
104 </li>
105
106 <p/> <li>
107 Between the creation of the <code>Pythia</code> object and the 
108 <code>init</code> call for it, you may use several alternative 
109 methods to modify some of the default values. 
110
111 <p/> 
112 a) Inside your main program you can directly set values with
113 <pre>
114     pythia.readString(string) 
115 </pre>
116 where both the variable name and the value are contained inside
117 the character string, separated by blanks and/or a =, e.g. 
118 <pre>
119     pythia.readString("TimeShower:pTmin = 1.0"); 
120 </pre>
121 The match of the name to the database is case-insensitive. Names 
122 that do not match an existing variable are ignored. A warning is
123 printed, however. Strings beginning with a non-alphanumeric character, 
124 like # or !, are assumed to be comments and are not processed at all. 
125 Values below the minimum or above the maximum are set at 
126 the respective border. For <code>bool</code> values, the following 
127 notation may be used interchangeably: 
128 <code>true = on = yes = ok = 1</code>, while everything else gives 
129 <code>false</code> (including but not limited to 
130 <code>false</code>, <code>off</code>, <code>no</code> and 0).<br/> 
131
132 <p/> 
133 b) The <code>Pythia</code> <code>readString(string)</code> method 
134 actually does not do changes itself, but sends on the string either 
135 to the <code>Settings</code> class or to <code>ParticleData</code>. 
136 The former holds if the string begins with a letter, the latter
137 if it begins with a digit. If desired, it is possible to communicate
138 directly with the corresponding <code>Settings</code> method:
139 <pre>
140     pythia.settings.readString("TimeShower:pTmin = 1.0"); 
141 </pre>
142 In this case, changes intended for <code>ParticleData</code> 
143 would not be understood.
144
145 <p/> 
146 c) Underlying the <code>settings.readString(string)</code> method are 
147 the settings-type-sensitive commands in the <code>Settings</code>, that 
148 are split by names containing <code>flag</code>, <code>mode</code>, 
149 <code>parm</code> or <code>word</code>. Thus, the example now reads
150 <pre>
151     pythia.settings.parm("TimeShower:pTmin", 1.0); 
152 </pre>
153 Such a form could be convenient e.g. if a parameter is calculated
154 at the beginning of the main program, and thus is available as a 
155 variable rather than as a character string.
156 Note that Boolean values must here be given as <code>true</code> or 
157 <code>false</code> i.e. there is less flexibility than with the 
158 previous methods.
159
160 <p/> 
161 At the same level, there are several different methods available.
162 These are included in the full description below, but normally the user 
163 should have no need for them. 
164
165 <p/>
166 d) A simpler and more useful way is to collect all your changes
167 in a separate file, with one line per change, e.g. 
168 <pre>
169     TimeShower:pTmin = 1.0
170 </pre>
171 Each line is read in as a string and processed with the methods already
172 introduced.
173
174 The file can be read by the 
175 <pre>
176     pythia.readFile(fileName); 
177 </pre>
178 method (or an <code>istream</code> instead of a <code>fileName</code>). 
179 The file can freely mix commands to the <code>Settings</code> and 
180 <code>ParticleData</code> classes, and so is preferable. Lines with 
181 settings are handled by calls to the 
182 <code>pythia.settings.readString(string)</code> method.
183 </li>
184
185 <p/> <li>
186 In the <code>pythia.init(...)</code> call, many of the various other program  
187 elements are initialized, making use of the current values in the database. 
188 Once initialized, the common <code>Settings</code> database is likely not 
189 consulted again by these routines. It is therefore not productive to do 
190 further changes in mid-run: at best nothing changes, at worst you may 
191 set up inconsistencies. 
192
193 <p/>
194 A routine <code>reInit(fileName)</code> is provided, and can be used to 
195 zero all the maps and reinitialize them from scratch. Such a call might be 
196 useful if several subruns are to be made with widely different parameter 
197 sets - normally the maps are only built from scratch once, namely when the 
198 <code>Pythia()</code> object is created. A more economical alternative is 
199 offered by <code>resetAll()</code>, however, which sets all variables back 
200 to their default values.
201 </li> 
202
203 <p/> <li>
204 You may at any time obtain a listing of all variables in the 
205 database by calling  
206 <pre>
207     pythia.settings.listAll();
208 </pre>
209 The listing is strictly alphabetical, which at least means that names
210 from the same file are kept together, but otherwise may not be so 
211 well-structured: important and unimportant ones will appear mixed.
212 A more relevant alternative is 
213 <pre>
214     pythia.settings.listChanged();
215 </pre>
216 where you will only get those variables that differ from their 
217 defaults. Or you can use 
218 <pre>
219     pythia.settings.list("string");
220 </pre>
221 where only those variables with names that contain the string 
222 (case-insensitive match) are listed. Thus, with a string 
223 <code>shower</code>, the shower-related variables would be shown.
224 </li>
225
226 <p/> <li>
227 The above listings are in a tabular form that cannot be read
228 back in. Assuming you want to save all changed settings (maybe because
229 you read in changes from several files), you can do that by calling
230 <pre>
231     pythia.settings.writeFile(fileName);
232 </pre>
233 This file could then directly be read in by 
234 <code>readFile(fileName)</code> in a subsequent (identical) run.
235 Some variants of this command are listed below. 
236 </li>
237 </ol>
238
239 <h3>Methods</h3>
240
241 The complete list of methods and arguments is as follows. Most of the 
242 ones of interest to the user have already been mentioned above. 
243 Others can be used, but the same functionality is better achieved
244 by higher-level routines. Some are part of the internal machinery,
245 and should not be touched by user. 
246
247 <p/>
248 Note that there is no <code>Settings::readFile(...)</code> method. 
249 The intention is that you should use <code>Pythia::readFile(...)</code>.
250 It parses and decides which individual lines should be sent on to 
251 <code>Settings::readString(...)</code>.
252
253 <method name="Settings::Settings()"> 
254 the constructor, which takes no arguments. Internal.
255 </method>
256
257 <method name="bool Settings::initPtr(Info* infoPtrIn)"> 
258 initialize pointer to error-message database. Internal.
259 </method>
260
261 <method name="bool Settings::init(string 
262 startFile = &quot;../xmldoc/Index.xml&quot;, bool append = false, 
263 ostream& os = cout)"> 
264 read in the settings database.
265 <argument name="startFile" default="&quot;../xmldoc/Index.xml&quot;">  
266 read in the settings from all the files listed in this file, and 
267 assumed to be located in the same subdirectory.
268 </argument>
269 <argument name="append" default="false">  
270 By default nothing is done if the method has already been called once.
271 If true the further settings read in are added to the current database.
272 </argument>
273 <argument name="os" default="cout">
274 stream for error printout.  
275 </argument>
276 <note>Note:</note> The method returns false if it fails.
277 </method>
278
279 <method name="bool Settings::reInit(string 
280 startFile = &quot;../xmldoc/Index.xml&quot;, ostream& os = cout)"> 
281 overwrite the existing database.
282 <argument name="startFile" default="&quot;../xmldoc/Index.xml&quot;">  
283 read in the settings from all the files listed in this file, and 
284 assumed to be located in the same subdirectory.
285 </argument>
286 <argument name="os" default="cout">
287 stream for error printout.  
288 </argument>
289 <note>Note:</note> The method returns false if it fails.
290 </method>
291
292 <method name="bool Settings::readString(string line, 
293 bool warn = true, ostream& os = cout)"> 
294 read in a string, and change the relevant quantity in the database.
295 It is normally used indirectly, via 
296 <code>Pythia::readString(...)</code> and
297 <code>Pythia::readFile(...)</code>.
298 <argument name="line">
299 the string to be interpreted as an instruction.
300 </argument>
301 <argument name="warn" default="true">
302 write a warning message or not whenever the instruction does not make
303 sense, e.g. if the variable does not exist in the databases.
304 </argument>
305 <argument name="os" default="cout">
306 stream for error printout.  
307 </argument>
308 <note>Note:</note> the method returns false if it fails to 
309 make sense out of the input string.
310 </method>
311
312 <method name="bool Settings::writeFile(string toFile, 
313 bool writeAll = false)"> 
314 </method>
315 <methodmore name="bool Settings::writeFile(ostream& os = cout, 
316 bool writeAll = false)"> 
317 write current settings to a file or to an <code>ostream</code>.
318 <argument name="toFile, os">
319 file or stream on which settings are written.  
320 </argument>
321 <argument name="writeAll" default="false">
322 normally only settings that have been changed are written, 
323 but if true then all settings are output.
324 </argument>
325 <note>Note:</note> the method returns false if it fails.
326 </methodmore>
327
328 <method name="void Settings::listAll(ostream& os = cout)"> 
329 </method>
330 <methodmore name="void Settings::listChanged(ostream& os = cout)"> 
331 </methodmore>
332 <methodmore name="void Settings::list(string match, 
333 ostream& os = cout)">
334 list all or changed settings, or a group of them.
335 <argument name="match">
336 list all those settings where the name contains
337 the <code>match</code> (sub)string (case-insensitive).
338 </argument>
339 <argument name="os" default="cout">
340 output stream for the listing.
341 </argument>
342 </methodmore>
343
344 <method name="void Settings::resetAll()"> 
345 reset all current values to their defaults.
346 </method>
347
348 <method name="bool Settings::isFlag(string key)"> 
349 </method>
350 <methodmore name="bool Settings::isMode(string key)"> 
351 </methodmore>
352 <methodmore name="bool Settings::isParm(string key)"> 
353 </methodmore>
354 <methodmore name="bool Settings::isWord(string key)">
355 return true if an entry of the given name and kind 
356 exists, else false.
357 </methodmore>
358
359 <method name="void Settings::addFlag(string key, bool default)"> 
360 </method>
361 <methodmore name="void Settings::addMode(string key, 
362 int default, bool hasMin, bool hasMax, int min, int max)"> 
363 </methodmore>
364 <methodmore name="void Settings::addParm(string key, 
365 double default, bool hasMin, bool hasMax, double min, double max)"> 
366 </methodmore>
367 <methodmore name="void Settings::addWord(string key, 
368 string default)"> 
369 add an entry of the respective kind to the database. The name and default
370 value always has to be supplied, for <code>Mode</code> and 
371 <code>Word</code> additionally if lower and/or upper limits are to be 
372 imposed and, if so, what those limit are.
373 </methodmore>
374
375 <method name="bool Settings::flag(string key)"> 
376 </method>
377 <methodmore name="int Settings::mode(string key)"> 
378 </methodmore>
379 <methodmore name="double Settings::parm(string key)"> 
380 </methodmore>
381 <methodmore name="string Settings::word(string key)">
382 return the current value of the respective setting. If the name 
383 does not exist in the database, a value <code>false</code>,
384 <code>0</code>, <code>0.</code> and <code>&quot; &quot;</code> 
385 is returned, respectively.
386 </methodmore>
387
388 <method name="void Settings::flag(string key, bool now)"> 
389 </method>
390 <methodmore name="void Settings::mode(string key, int now)"> 
391 </methodmore>
392 <methodmore name="void Settings::parm(string key, double now)"> 
393 </methodmore>
394 <methodmore name="void Settings::word(string key, string now)">
395 change the current value of the respective setting to the provided 
396 new value. If lower or upper limits have been set, input values 
397 outside the allowed range are reinterpreted as being a the nearest 
398 limit.
399 </methodmore>
400
401 <method name="void Settings::forceMode(string key, int now)"> 
402 </method>
403 <methodmore name="void Settings::forceParm(string key, double now)"> 
404 as above, but do not check lower and upper limits, so that the current 
405 value can be put outside the intended borders.
406 </methodmore>
407
408 <method name="void Settings::resetFlag(string key)"> 
409 </method>
410 <methodmore name="void Settings::resetMode(string key)"> 
411 </methodmore>
412 <methodmore name="void Settings::resetParm(string key)"> 
413 </methodmore>
414 <methodmore name="void Settings::resetWord(string key)">
415 reset the current value to the default one.
416 </methodmore>
417
418 </chapter>
419
420 <!-- Copyright (C) 2010 Torbjorn Sjostrand -->