OPAL (Object Oriented Parallel Accelerator Library) 2022.1
OPAL
Options.cpp
Go to the documentation of this file.
1//
2// Namespace Options
3// The global OPAL option flags.
4// This namespace contains the global option flags.
5//
6// Copyright (c) 200x - 2020, Paul Scherrer Institut, Villigen PSI, Switzerland
7// All rights reserved
8//
9// This file is part of OPAL.
10//
11// OPAL is free software: you can redistribute it and/or modify
12// it under the terms of the GNU General Public License as published by
13// the Free Software Foundation, either version 3 of the License, or
14// (at your option) any later version.
15//
16// You should have received a copy of the GNU General Public License
17// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
18//
19#include "Utilities/Options.h"
21
22#include <string>
23
24namespace Options {
25 // The global program options.
26 bool echo = false;
27
28 bool info = true;
29 int infoLevel = 1;
30
31 bool mtrace = false;
32
33 bool warn = true;
34 int warnLevel = 1;
35
37 int seed = 123456789;
38
39 int psDumpFreq = 10;
40
41 int statDumpFreq = 10;
42
43 bool psDumpEachTurn = false;
44
46
47 int sptDumpFreq = 1;
48
49 int repartFreq = 10;
50
51 int minBinEmitted = 10;
52
53 int minStepForRebin = 200;
54
55 int rebinFreq = 100;
56
57 int scSolveFreq = 1;
58
59 int mtsSubsteps = 1;
60
61 double remotePartDel = 0.0;
62
63 bool rhoDump = false;
64
65 bool ebDump = false;
66
67 bool csrDump = false;
68
69 int autoPhase = 6;
70
71 int numBlocks = 0;
72
74
75 int nLHS = 1;
76
77 bool cZero = false;
78
79 std::string rngtype = std::string("RANDOM");
80
81 bool enableHDF5 = true;
82
83 bool enableVTK = true;
84
85 bool asciidump = false;
86
88
89 double beamHaloBoundary = 0;
90
91 bool cloTuneOnly = false;
92
93 bool idealized = false;
94
96
97 int version = 10000;
98
99 bool amr = false;
100
102
104
105 bool memoryDump = false;
106
107 double haloShift = 0.0;
108
109 unsigned int delPartFreq = 1;
110
111 bool computePercentiles = false;
112
113 bool dumpBeamMatrix = false;
114
115}
DumpFrame
Definition: Options.h:26
Some AMR types used a lot.
Definition: AmrDefs.h:33
bool computePercentiles
Definition: Options.cpp:111
int mtsSubsteps
Definition: Options.cpp:59
double remotePartDel
Definition: Options.cpp:61
int psDumpFreq
The frequency to dump the phase space, i.e.dump data when steppsDumpFreq==0.
Definition: Options.cpp:39
double haloShift
The constant parameter C to shift halo, by < w^4 > / < w^2 > ^2 - C (w=x,y,z)
Definition: Options.cpp:107
bool writeBendTrajectories
Definition: Options.cpp:95
bool mtrace
Trace flag.
Definition: Options.cpp:31
int boundpDestroyFreq
Definition: Options.cpp:87
bool memoryDump
Definition: Options.cpp:105
bool enableVTK
If true VTK files are written.
Definition: Options.cpp:83
int version
opal version of input file
Definition: Options.cpp:97
int minBinEmitted
The number of bins that have to be emitted before the bin are squashed into a single bin.
Definition: Options.cpp:51
bool enableHDF5
If true HDF5 files are written.
Definition: Options.cpp:81
bool psDumpEachTurn
phase space dump flag for OPAL-cycl
Definition: Options.cpp:43
bool asciidump
Definition: Options.cpp:85
int amrRegridFreq
After how many steps the AMR grid hierarchy is updated.
Definition: Options.cpp:103
int numBlocks
RCG: cycle length.
Definition: Options.cpp:71
int sptDumpFreq
The frequency to dump single particle trajectory of particles with ID = 0 & 1.
Definition: Options.cpp:47
int autoPhase
Definition: Options.cpp:69
bool warn
Warn flag.
Definition: Options.cpp:33
std::string rngtype
random number generator
Definition: Options.cpp:79
bool echo
Echo flag.
Definition: Options.cpp:26
bool rhoDump
Definition: Options.cpp:63
int minStepForRebin
The number of steps into the simulation before the bins are squashed into a single bin.
Definition: Options.cpp:53
bool cloTuneOnly
Do closed orbit and tune calculation only.
Definition: Options.cpp:91
bool csrDump
Definition: Options.cpp:67
bool ebDump
Definition: Options.cpp:65
bool idealized
Definition: Options.cpp:93
int amrYtDumpFreq
The frequency to dump AMR grid data and particles into file.
Definition: Options.cpp:101
unsigned int delPartFreq
The frequency to delete particles (currently: OPAL-cycl only)
Definition: Options.cpp:109
bool dumpBeamMatrix
Definition: Options.cpp:113
int scSolveFreq
The frequency to solve space charge fields.
Definition: Options.cpp:57
int warnLevel
Definition: Options.cpp:34
int repartFreq
The frequency to do particles repartition for better load balance between nodes.
Definition: Options.cpp:49
bool cZero
If true create symmetric distribution.
Definition: Options.cpp:77
double beamHaloBoundary
Definition: Options.cpp:89
int nLHS
number of old left hand sides used to extrapolate a new start vector
Definition: Options.cpp:75
int rebinFreq
The frequency to reset energy bin ID for all particles.
Definition: Options.cpp:55
int infoLevel
Definition: Options.cpp:29
bool info
Info flag.
Definition: Options.cpp:28
Random rangen
Definition: Options.cpp:36
int seed
The current random seed.
Definition: Options.cpp:37
DumpFrame psDumpFrame
flag to decide in which coordinate frame the phase space will be dumped for OPAL-cycl
Definition: Options.cpp:45
int statDumpFreq
The frequency to dump statistical values, e.e. dump data when stepstatDumpFreq==0.
Definition: Options.cpp:41
int recycleBlocks
RCG: number of recycle blocks.
Definition: Options.cpp:73
The CLASSIC random generator.
Definition: ClassicRandom.h:36