Commit c25b9e40 authored by ext-calvo_p's avatar ext-calvo_p
Browse files

Merge branch '55-update-option-statements' into 'master'

Resolve "Update OPTION statements"

Closes #55

See merge request OPAL/documentation/manual!125
parents 0bba20ef 408dfa71
......@@ -79,15 +79,17 @@ The next five logical flags activate or deactivate execution options:
ECHO::
Controls printing of an echo of input lines on the standard error
file.
file. Its default value is false.
INFO::
If this option is turned off, _OPAL_ suppresses all information
messages. It also affects the _gnu.out_ and _eb.out_ files in case of
_OPAL-cycl_ simulations.
_OPAL-cycl_ simulations. Its default value is true.
TRACE::
If true, print execution trace. Default false.
If true, print execution trace. Must be the first option in the
inputfile in order to render correct results. Its default value is false.
WARN::
If this option is turned off, _OPAL_ suppresses all warning messages.
Its default value is true.
TELL::
If true, the current settings are listed. Must be the last option in
the inputfile in order to render correct results.
......@@ -99,7 +101,7 @@ SEED::
see link:format#sec.format.adefer[Deferred Expressions and Random Values].
PSDUMPFREQ::
Defines after how many time steps the phase space is dumped into the
H5hut file. Default value is 10.
H5hut file. Its default value is 10.
STATDUMPFREQ::
Defines after how many time steps we dump statistical data, such as
RMS beam emittance, to the .stat file. The default value is 10.
......@@ -107,7 +109,7 @@ STATDUMPFREQ::
PSDUMPEACHTURN::
Control option of phase space dumping. If true, dump phase space after
each turn. For the time being, this is only use for multi-bunch
simulation in _OPAL-cycl_. Its default set is false.
simulation in _OPAL-cycl_. Its default value is false.
PSDUMPFRAME::
Control option that defines the frame in which the phase space data is
written for h5 and stat files. Beware that the data is written in a
......@@ -164,10 +166,10 @@ REMOTEPARTDEL::
RHODUMP::
If true the scalar latexmath:[\rho] field is saved each time a phase
space is written. There exists a reader in Visit with versions greater
or equal 1.11.1.
or equal 1.11.1. Its default value is false.
EBDUMP::
If true the electric and magnetic field on the particle is saved each
time a phase space is written.
time a phase space is written. Its default value is false.
CSRDUMP::
If true the electric csr field component, latexmath:[E_z], line
density and the derivative of the line density is written into the
......@@ -180,6 +182,7 @@ CSRDUMP::
The CSR field is dumped at each time step of the calculation. Each
text file is named "Bend Name" (from input file) + "-CSRWake"
+ "time step number in that bend (starting from 1)" + ".txt".
Its default value is false.
AUTOPHASE::
Defines how accurate the search for the phase at which the maximal energy
is gained should be. The higher this number the more accurate the phase
......@@ -196,7 +199,7 @@ NLHS::
vector. Default value is 1 and just the last solution is used.
CZERO::
If true the distributions are generated such that the centroid is
exactly zero and not statistically dependent.
exactly zero and not statistically dependent. Its default value is false.
RNGTYPE::
The name (see link:format#sec.format.astring[String Attributes]) of a random number generator can be
provided. The default random number generator (RANDOM) is a portable
......@@ -209,15 +212,17 @@ RNGTYPE::
For details see the GSL reference manual (18.5).
ENABLEHDF5::
If true (default), HDF5 read and write is enabled.
ENABLEVTK::
If true (default), VTK write of geometry voxel mesh is enabled.
ASCIIDUMP::
If true, instead of HDF5, ASCII output is generated for the following
elements: Probe, Collimator, Monitor, Stripper, Geometry,
Beam stripping losses and global losses.
Beam stripping losses and global losses. Its default value is false.
BOUNDPDESTROYFQ::
The frequency to do `boundp_destroy` to delete lost particles. Default 10.
Only used in _OPAL-cycl_.
DELPARTFREQ::
The frequency to delete particles in _OPAL-cycl_. Default: 1
The frequency to delete particles in _OPAL-cycl_. Its default value is 1.
BEAMHALOBOUNDARY::
Defines in terms of sigma where the halo starts. Default: 0.0. Only used in _OPAL-cycl_.
CLOTUNEONLY::
......@@ -240,6 +245,8 @@ MEMORYDUMP::
If true, it writes the memory consumption of every core to a SDDS file
(*.mem). The write frequency corresponds to STATDUMPFREQ. Default:
FALSE
HALOSHIFT::
Constant parameter to shift halo value. Its default value is 0.0.
Examples:
......@@ -255,11 +262,9 @@ OPTION,SEED=987456321
|`ECHO` |= `FALSE`
|`INFO` |= `TRUE`
|`TRACE` |= `FALSE`
|`WARN` |= `TRUE`
|`TELL` |= `FALSE`
|`SEED` |= `123456789`
|`PSDUMPFREQ` |= `10`
|`STATDUMPFREQ` |= `10`
|`PSDUMPEACHTURN` |= `FALSE`
......@@ -267,20 +272,22 @@ OPTION,SEED=987456321
|`SPTDUMPFREQ` |= `1`
|`REPARTFREQ` |= `10`
|`REBINFREQ` |= `100`
|`MINBINEMITTED` |= `10`
|`MINSTEPFORREBIN` |= `200`
|`SCSOLVEFREQ` |= `1`
|`MTSSUBSTEPS` |= `1`
|`REMOTEPARTDEL` |= `-1`
|`REMOTEPARTDEL` |= `0`
|`RHODUMP` |= `FALSE`
|`EBDUMP` |= `FALSE`
|`CSRDUMP` |= `FALSE`
|`AUTOPHASE` |= `6`
|`SURFDUMPFREQ` |= `-1`
|`NUMBLOCKS` |= `0`
|`RECYCLEBLOCKS` |= `0`
|`NLHS` |= `1`
|`CZERO` |= `FALSE`
|`RNGTYPE` |= `RANDOM`
|`ENABLEHDF5` |= `TRUE`
|`ENABLEVTK` |= `TRUE`
|`ASCIIDUMP` |= `FALSE`
|`BOUNDPDESTROYFQ` |= `10`
|`BEAMHALOBOUNDARY` |= `0.0`
......@@ -290,7 +297,10 @@ OPTION,SEED=987456321
|`VERSION` |= `none`
|`AMR` |= `FALSE`
|`AMR_YT_DUMP_FREQ` |= `10`
|`AMR_REGRID_FREQ` |= `10`
|`MEMORYDUMP` |= `FALSE`
|`HALOSHIFT` |= `0.0`
|`DELPARTFREQ` |= `1`
|=======================================================================
[[sec.consumption.parameter]]
......@@ -731,4 +741,4 @@ SHOWIT(Y);
----
// EOF
\ No newline at end of file
// EOF
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment