<html>
<head>
<title>The Settings Scheme</title>
<link rel="stylesheet" type="text/css" href="pythia.css"/>
<link rel="shortcut icon" href="pythia32.gif"/>
</head>
<body>
<h2>The Settings Scheme</h2>
The <code>Settings</code> class keeps track of all the flags, modes,
parameters and words used during the event generation. As such, it
serves all the <code>Pythia</code> program elements from one central
repository. Accessing it allows the user to modify the generator
behaviour.
<p/>
Each <code>Pythia</code> object has a public member <code>settings</code>
of the <code>Settings</code> class. Therefore you access the
settings methods as <code>pythia.settings.command(argument)</code>,
assuming that <code>pythia</code> is an instance of the <code>Pythia</code>
class. Further, for the most frequent user tasks, <code>Pythia</code>
methods have been defined, so that <code>pythia.command(argument)</code>
would work, see further below.
<p/>
The central section on this page is the Operation one. The preceding
concepts section is there mainly to introduce the basic structure and
the set of properties that can be accessed. The subsequent sections
provide a complete listing of the existing public methods, which most
users probably will have little interaction with.
<h3>Concepts</h3>
We distinguish seven kinds of user-modifiable variables, by the way
they have to be stored:
<ol>
<li>Flags are on/off switches, and are stored as <code>bool</code>.</li>
<li>Modes corresponds to a finite enumeration of separate options,
and are stored as <code>int</code>.</li>
<li>Parameters take a continuum of values, and are stored as
<code>double</code>. The shorthand notation parm is used in the C++
code and XML tags.</li>
<li>Words are simple character strings and are stored as
<code>string</code>. No blanks or double quotation marks (") may
appear inside a word, the former to simplify parsing of an input file
and the latter not to cause conflicts with XML attribute delimiters.
Currently the main application is to store file names.</li>
<li>Vectors of flags take a variable length, and are stored as
<code>vector<bool></code>. The shorthand notation fvec is used
in the C++ code and XML tags. When the vector is input as a string,
all the values have to be given as a comma-separated list with no blanks,
to simplify parsing.</li>
<li>Vectors of modes take a variable length, and are stored as
<code>vector<int></code>. The shorthand notation mvec is used
in the C++ code and XML tags. When the vector is input as a string,
all the values have to be given as a comma-separated list with no blanks,
to simplify parsing.</li>
<li>Vectors of parameters take a variable length and for each element
a continuum of values, and are stored as <code>vector<double></code>.
The shorthand notation pvec is used in the C++ code and XML tag.
When the vector is input as a string, all the values have to be given
as a comma-separated list with no blanks, to simplify parsing.</li>
</ol>
Note that all shorthands have been chosen four letters long.
<p/>
In general, each variable stored in <code>Settings</code> is associated
with four kinds of information:
<ul>
<li>The variable name, of the form <code>class:name</code>
(or <code>file:name</code>, usually these agree), e.g.
<code>TimeShower:pTmin</code>. The class/file part usually identifies
the <code>.xml</code> file where the variable is defined, and the part of
the program where it is used, but such a connection cannot be strictly
upheld, since e.g. the same variable may be used in a few different
cases (even if most of them are not).</li>
<li>The default value, set in the original declaration, and intended
to represent a reasonable choice.</li>
<li>The current value, which differs from the default when the user so
requests.</li>
<li>An allowed range of values, represented by meaningful
minimum and maximum values. This has no sense for a <code>flag</code>,
an <code>fvec</code> or a <code>word</code> (and is not used there), is
usually rather well-defined for a <code>mode</code> or <code>mvec</code>,
but less so for a <code>parm</code> or <code>pvec</code>. Often the allowed
range exaggerates the degree of our current knowledge, so as not to restrict
too much what the user can do. One may choose not to set the lower or
upper limit, in which case the range is open-ended.</li>
</ul>
<p/>
Technically, the <code>Settings</code> class is implemented with the
help of seven separate maps, one for each kind of variable, with the
variable <code>name</code> used as key.
<h3>Operation</h3>
The normal flow of setting values is:
<ol>
<p/> <li>
When a <code>Pythia</code> object <code>pythia </code>is created,
the member <code>pythia.settings</code> is asked to scan the files
listed in the <code>Index.xml</code> file in the <code>xmldoc</code>
subdirectory.
<p/>
In all of the files scanned, lines beginning with
<code><flag</code>, <code><mode</code>, <code><parm</code>,
<code><word</code>, <code><fvec</code>, <code><mvec</code> or
<code><pvec</code> are identified, and the information on such a line
is used to define a new flag, mode, parameter, word, or vector of flags,
modes or parameters. To exemplify, consider a line
<pre>
<parm name="TimeShower:pTmin" default="0.5" min="0.1" max="2.0">
</pre>
which appears in the <code>TimeShower.xml</code> file, and there
defines a parameter <code>TimeShower:pTmin</code> with default value
0.5 GeV and allowed variation in the range 0.1 - 2.0 GeV. The min
and max values are optional.
<br/><b>Important:</b> the values in the <code>.xml</code> files should
not be changed, except by the PYTHIA authors. Any changes should be
done with the help of the methods described below.
</li>
<p/> <li>
Between the creation of the <code>Pythia</code> object and the
<code>init</code> call for it, you may use several alternative
methods to modify some of the default values. The same variable
can be changed several times. If so, it is the last read value
that counts. The two special
<code><a href="Tunes.html" target="page">Tune:ee</a></code> and
<code><a href="Tunes.html" target="page">Tune:pp</a></code> modes and the
<code><a href="MainProgramSettings.html" target="page">Print:quiet</a></code> flag
are expanded to change several settings in one go, but these obey
the same ordering rules.
<p/>
a) Inside your main program you can directly set values with
<pre>
pythia.readString(string)
</pre>
where both the variable name and the value are contained inside
the character string, separated by blanks and/or a =, e.g.
<pre>
pythia.readString("TimeShower:pTmin = 1.0");
</pre>
The match of the name to the database is case-insensitive. Names
that do not match an existing variable are ignored. A warning is
printed, however. Strings beginning with a non-alphanumeric character,
like # or !, are assumed to be comments and are not processed at all.
Values below the minimum or above the maximum are set at
the respective border. For <code>bool</code> values, the following
notation may be used interchangeably:
<code>true = on = yes = ok = 1</code>, while everything else gives
<code>false</code> (including but not limited to
<code>false</code>, <code>off</code>, <code>no</code> and 0).<br/>
<p/>
b) The <code>Pythia</code> <code>readString(string)</code> method
actually does not do changes itself, but sends on the string either
to the <code>Settings</code> class or to <code>ParticleData</code>.
The former holds if the string begins with a letter, the latter
if it begins with a digit. If desired, it is possible to communicate
directly with the corresponding <code>Settings</code> method:
<pre>
pythia.settings.readString("TimeShower:pTmin = 1.0");
</pre>
In this case, changes intended for <code>ParticleData</code>
would not be understood.
<p/>
c) Underlying the <code>settings.readString(string)</code> method are
the settings-type-sensitive commands in the <code>Settings</code>, that
are split by names containing <code>flag</code>, <code>mode</code>,
<code>parm</code> or <code>word</code>. Thus, the example now reads
<pre>
pythia.settings.parm("TimeShower:pTmin", 1.0);
</pre>
Such a form could be convenient e.g. if a parameter is calculated
at the beginning of the main program, and thus is available as a
variable rather than as a character string.
Note that Boolean values must here be given as <code>true</code> or
<code>false</code> i.e. there is less flexibility than with the
previous methods.
<p/>
At the same level, there are several different methods available.
These are included in the full description below, but normally the user
should have no need for them.
<p/>
d) A simpler and more useful way is to collect all your changes
in a separate file, with one line per change, e.g.
<pre>
TimeShower:pTmin = 1.0
</pre>
Each line is read in as a string and processed with the methods already
introduced.
The file can be read by the
<pre>
pythia.readFile(fileName);
</pre>
method (or an <code>istream</code> instead of a <code>fileName</code>).
The file can freely mix commands to the <code>Settings</code> and
<code>ParticleData</code> classes, and so is preferable. Lines with
settings are handled by calls to the
<code>pythia.settings.readString(string)</code> method.
<p/>
A file can make use of two extra features that are not available with the
<code>readString(...)</code> method. One is the possibility to provide
information for several distinct <a href="ProgramFlow.html" target="page">subruns</a>.
The other is the possibility to comment out a section of lines in the file.
The first line of the commented section should then begin by <code>/*</code>
and the last begin by <code>*/</code>. This is reminiscent of the convention
used in C++ and other languages, but is not as powerful, in that it is not
possible to comment in or out parts of lines. It is only the first two
non-blank characters of a line that are checked for a match, and a line
beginning with <code>*/</code> is counted as part of the commented section.
To avoid mistakes it is best to keep <code>/*</code> and <code>*/</code>
on lines of their own, optionally followed by comments, but not by commands.
</li>
<p/> <li>
In the <code>pythia.init(...)</code> call, many of the various other program
elements are initialized, making use of the current values in the database.
Once initialized, the common <code>Settings</code> database is likely not
consulted again by these routines. It is therefore not productive to do
further changes in mid-run: at best nothing changes, at worst you may
set up inconsistencies.
<p/>
A routine <code>reInit(fileName)</code> is provided, and can be used to
zero all the maps and reinitialize them from scratch. Such a call might be
useful if several subruns are to be made with widely different parameter
sets - normally the maps are only built from scratch once, namely when the
<code>Pythia()</code> object is created. A more economical alternative is
offered by <code>resetAll()</code>, however, which sets all variables back
to their default values.
</li>
<p/> <li>
You may at any time obtain a listing of all variables in the
database by calling
<pre>
pythia.settings.listAll();
</pre>
The listing is strictly alphabetical, which at least means that names
from the same file are kept together, but otherwise may not be so
well-structured: important and unimportant ones will appear mixed.
A more relevant alternative is
<pre>
pythia.settings.listChanged();
</pre>
where you will only get those variables that differ from their
defaults. Or you can use
<pre>
pythia.settings.list("string");
</pre>
where only those variables with names that contain the string
(case-insensitive match) are listed. Thus, with a string
<code>shower</code>, the shower-related variables would be shown.
</li>
<p/> <li>
The above listings are in a tabular form that cannot be read
back in. Assuming you want to save all changed settings (maybe because
you read in changes from several files), you can do that by calling
<pre>
pythia.settings.writeFile(fileName);
</pre>
This file could then directly be read in by
<code>readFile(fileName)</code> in a subsequent (identical) run.
Some variants of this command are listed below.
</li>
</ol>
<h3>Methods</h3>
The complete list of methods and arguments is as follows. Most of the
ones of interest to the user have already been mentioned above.
Others can be used, but the same functionality is better achieved
by higher-level routines. Some are part of the internal machinery,
and should not be touched by user.
<p/>
Note that there is no <code>Settings::readFile(...)</code> method.
The intention is that you should use <code>Pythia::readFile(...)</code>.
It parses and decides which individual lines should be sent on to
<code>Settings::readString(...)</code>.
<a name="method1"></a>
<p/><strong>Settings::Settings() </strong> <br/>
the constructor, which takes no arguments. Internal.
<a name="method2"></a>
<p/><strong>bool Settings::initPtr(Info* infoPtrIn) </strong> <br/>
initialize pointer to error-message database. Internal.
<a name="method3"></a>
<p/><strong>bool Settings::init(string startFile = "../xmldoc/Index.xml", bool append = false, ostream& os = cout) </strong> <br/>
read in the settings database.
<br/><code>argument</code><strong> startFile </strong> (<code>default = <strong>"../xmldoc/Index.xml"</strong></code>) :
read in the settings from all the files listed in this file, and
assumed to be located in the same subdirectory.
<br/><code>argument</code><strong> append </strong> (<code>default = <strong>false</strong></code>) :
By default nothing is done if the method has already been called once.
If true the further settings read in are added to the current database.
<br/><code>argument</code><strong> os </strong> (<code>default = <strong>cout</strong></code>) :
stream for error printout.
<br/><b>Note:</b> The method returns false if it fails.
<a name="method4"></a>
<p/><strong>bool Settings::reInit(string startFile = "../xmldoc/Index.xml", ostream& os = cout) </strong> <br/>
overwrite the existing database.
<br/><code>argument</code><strong> startFile </strong> (<code>default = <strong>"../xmldoc/Index.xml"</strong></code>) :
read in the settings from all the files listed in this file, and
assumed to be located in the same subdirectory.
<br/><code>argument</code><strong> os </strong> (<code>default = <strong>cout</strong></code>) :
stream for error printout.
<br/><b>Note:</b> The method returns false if it fails.
<a name="method5"></a>
<p/><strong>bool Settings::readString(string line, bool warn = true, ostream& os = cout) </strong> <br/>
read in a string, and change the relevant quantity in the database.
It is normally used indirectly, via
<code>Pythia::readString(...)</code> and
<code>Pythia::readFile(...)</code>.
<br/><code>argument</code><strong> line </strong> :
the string to be interpreted as an instruction.
<br/><code>argument</code><strong> warn </strong> (<code>default = <strong>true</strong></code>) :
write a warning message or not whenever the instruction does not make
sense, e.g. if the variable does not exist in the databases.
<br/><code>argument</code><strong> os </strong> (<code>default = <strong>cout</strong></code>) :
stream for error printout.
<br/><b>Note:</b> the method returns false if it fails to
make sense out of the input string.
<a name="method6"></a>
<p/><strong>bool Settings::writeFile(string toFile, bool writeAll = false) </strong> <br/>
<strong>bool Settings::writeFile(ostream& os = cout, bool writeAll = false) </strong> <br/>
write current settings to a file or to an <code>ostream</code>.
<br/><code>argument</code><strong> toFile, os </strong> :
file or stream on which settings are written.
<br/><code>argument</code><strong> writeAll </strong> (<code>default = <strong>false</strong></code>) :
normally only settings that have been changed are written,
but if true then all settings are output.
<br/><b>Note:</b> the method returns false if it fails.
<a name="method7"></a>
<p/><strong>void Settings::listAll(ostream& os = cout) </strong> <br/>
<strong>void Settings::listChanged(ostream& os = cout) </strong> <br/>
<strong>void Settings::list(string match, ostream& os = cout) </strong> <br/>
list all or changed settings, or a group of them.
<br/><code>argument</code><strong> match </strong> :
list all those settings where the name contains
the <code>match</code> (sub)string (case-insensitive).
<br/><code>argument</code><strong> os </strong> (<code>default = <strong>cout</strong></code>) :
output stream for the listing.
<a name="method8"></a>
<p/><strong>void Settings::resetAll() </strong> <br/>
reset all current values to their defaults.
<a name="method9"></a>
<p/><strong>bool Settings::isFlag(string key) </strong> <br/>
<strong>bool Settings::isMode(string key) </strong> <br/>
<strong>bool Settings::isParm(string key) </strong> <br/>
<strong>bool Settings::isWord(string key) </strong> <br/>
<strong>bool Settings::isFVec(string key) </strong> <br/>
<strong>bool Settings::isMVec(string key) </strong> <br/>
<strong>bool Settings::isPVec(string key) </strong> <br/>
return true if an entry of the given name and kind
exists, else false.
<a name="method10"></a>
<p/><strong>void Settings::addFlag(string key, bool default) </strong> <br/>
<strong>void Settings::addMode(string key, int default, bool hasMin, bool hasMax, int min, int max) </strong> <br/>
<strong>void Settings::addParm(string key, double default, bool hasMin, bool hasMax, double min, double max) </strong> <br/>
<strong>void Settings::addWord(string key, string default) </strong> <br/>
<strong>void Settings::addFVec(string key, vector<bool> default) </strong> <br/>
<strong>void Settings::addMVec(string key, vector<int> default, bool hasMin, bool hasMax, int min, int max) </strong> <br/>
<strong>void Settings::addPVec(string key, vector<double> default, bool hasMin, bool hasMax, double min, double max) </strong> <br/>
add an entry of the respective kind to the database. The name and default
value(s) always has to be supplied, for <code>Mode</code>, <code>Parm</code>,
<code>MVec</code> and <code>PVec</code> additionally if lower and/or
upper limits are to be imposed and, if so, what those limit are.
<a name="method11"></a>
<p/><strong>bool Settings::flag(string key) </strong> <br/>
<strong>int Settings::mode(string key) </strong> <br/>
<strong>double Settings::parm(string key) </strong> <br/>
<strong>string Settings::word(string key) </strong> <br/>
<strong>vector<bool> Settings::fvec(string key) </strong> <br/>
<strong>vector<int> Settings::mvec(string key) </strong> <br/>
<strong>vector<double> Settings::pvec(string key) </strong> <br/>
return the current value(s) of the respective setting. If the name
does not exist in the database, a value <code>false</code>,
<code>0</code>, <code>0.</code>, <code>" "</code>, or a
vector of length 1 and value <code>false</code>, <code>0</code> or
<code>0.</code>, respectively, is returned.
<a name="method12"></a>
<p/><strong>bool Settings::flagDefault(string key) </strong> <br/>
<strong>int Settings::modeDefault(string key) </strong> <br/>
<strong>double Settings::parmDefault(string key) </strong> <br/>
<strong>string Settings::wordDefault(string key) </strong> <br/>
<strong>vector<bool> Settings::fvecDefault(string key) </strong> <br/>
<strong>vector<int> Settings::mvecDefault(string key) </strong> <br/>
<strong>vector<double> Settings::pvecDefault(string key) </strong> <br/>
return the default value(s) of the respective setting. If the name
does not exist in the database, a value <code>false</code>,
<code>0</code>, <code>0.</code>, <code>" "</code>, or a
vector of length 1 and value <code>false</code>, <code>0</code> or
<code>0.</code>, respectively, is returned.
<a name="method13"></a>
<p/><strong>map<string, Flag> Settings::getFlagMap(string match) </strong> <br/>
<strong>map<string, Mode> Settings::getModeMap(string match) </strong> <br/>
<strong>map<string, Parm> Settings::getParmMap(string match) </strong> <br/>
<strong>map<string, Word> Settings::getWordMap(string match) </strong> <br/>
<strong>map<string, FVec> Settings::getFVecMap(string match) </strong> <br/>
<strong>map<string, MVec> Settings::getMVecMap(string match) </strong> <br/>
<strong>map<string, PVec> Settings::getPVecMap(string match) </strong> <br/>
return a map of all settings of the respective type that contain the
string "match" in its name.
<a name="method14"></a>
<p/><strong>void Settings::flag(string key, bool now) </strong> <br/>
<strong>void Settings::mode(string key, int now) </strong> <br/>
<strong>void Settings::parm(string key, double now) </strong> <br/>
<strong>void Settings::word(string key, string now) </strong> <br/>
<strong>void Settings::fvec(string key, vector<bool> now) </strong> <br/>
<strong>void Settings::mvec(string key, vector<int> now) </strong> <br/>
<strong>void Settings::pvec(string key, vector<double> now) </strong> <br/>
change the current value(s) of the respective setting to the provided
new value(s). If lower or upper limits have been set, input values
outside the allowed range are reinterpreted as being a the nearest
limit.
<a name="method15"></a>
<p/><strong>void Settings::forceMode(string key, int now) </strong> <br/>
<strong>void Settings::forceParm(string key, double now) </strong> <br/>
<strong>void Settings::forceMVec(string key, vector<int> now) </strong> <br/>
<strong>void Settings::forcePVec(string key, vector<double> now) </strong> <br/>
as above, but do not check lower and upper limits, so that the current
value(s) can be put outside the intended borders.
<a name="method16"></a>
<p/><strong>void Settings::resetFlag(string key) </strong> <br/>
<strong>void Settings::resetMode(string key) </strong> <br/>
<strong>void Settings::resetParm(string key) </strong> <br/>
<strong>void Settings::resetWord(string key) </strong> <br/>
<strong>void Settings::resetFVec(string key) </strong> <br/>
<strong>void Settings::resetMVec(string key) </strong> <br/>
<strong>void Settings::resetPVec(string key) </strong> <br/>
reset the current value to the default one.
</body>
</html>
<!-- Copyright (C) 2014 Torbjorn Sjostrand -->
