OPAL (Object Oriented Parallel Accelerator Library)  2.2.0
OPAL
Options.cpp
Go to the documentation of this file.
1 #include "OptionTypes.h"
3 #include <string>
4 
5 namespace Options {
6  // The global program options.
7  bool echo = false;
8  bool info = true;
9  int infoLevel = 1;
10  bool warn = true;
11  int warnLevel = 1;
12  bool csrDump = false;
13  bool ppdebug = false;
14 
15  // If true create symmetric distribution
16  bool cZero = false;
17 
18  bool asciidump = false;
19 
20  // If the distance of a particle to bunch mass larger than remotePartDel times of the rms size of the bunch in any dimension,
21  // the particle will be deleted artifically to hold the accuracy of space charge calculation. The default setting of -1 stands for no deletion.
22  double remotePartDel = 0.0;
23 
24  double beamHaloBoundary = 0;
25 
26  bool writeBendTrajectories = false;
27 
28  // The global program options.
29  bool mtrace = false;
30  bool psDumpEachTurn = false;
32  bool rhoDump = false;
33  bool ebDump = false;
34 
35  bool enableHDF5 = true;
36 
37  // The global random generator.
39 
40  // The current random seed.
41  int seed = 123456789;
42 
43  // the number of refinements of the search range for the phase with maximum energy
44  // if eq 0 then no autophase
45  int autoPhase = 6;
46 
47  // The frequency to dump the phase space, i.e.dump data when step%psDumpFreq==0
48  int psDumpFreq = 10;
49  // // The frequency to dump the phase space, i.e.dump data when step%psDumpFreq==0
50  // double rDump = 0.0;
51 
52  // The frequency to dump statistical quantities such as beam RMS properties, i.e. dump
53  // when step%statDumpFreq == 0.
54  int statDumpFreq = 10;
55 
56  // The frequency to dump single particle trajectory of particles with ID = 0 & 1
57  int sptDumpFreq = 1;
58 
59  // The frequency to do particles repartition for better load balance between nodes
60  int repartFreq = 10;
61 
62  // The number of bins that have to be emitted before the bin are squashed into a single bin
63  int minBinEmitted = 10;
64 
65  // The number of steps into the simulation before the bins are squashed into a single bin
66  int minStepForRebin = 200;
67 
68  // The frequency to reset energy bin ID for all particles
69  int rebinFreq = 100;
70 
72  int scSolveFreq = 1;
73 
74  // How many small timesteps are inside the large timestep used in multiple time stepping (MTS) integrator
75  int mtsSubsteps = 1;
76 
77  // The frequency to dump the particle-geometry surface interation data, -1 stands for no dump.
78  int surfDumpFreq = -1;
79 
80  // Options for the Belos solver
81  int numBlocks = 0;
82  int recycleBlocks = 0;
83  int nLHS = 1;
84 
85  std::string rngtype = std::string("RANDOM");
86 
87  bool cloTuneOnly = false;
88 
89  // Governs how often boundp_destroy is called to destroy lost particles
90  // Mainly used in the CyclotronTracker as of now -DW
92 
93  // Using hard edge model for calculation of path length
94  bool idealized = false;
95 
96  // opal version of input file
97  int version = 10000;
98 
99 #ifdef ENABLE_AMR
100  bool amr = false;
101 
103  int amrYtDumpFreq = 10;
104 
105  int amrRegridFreq = 10;
106 #endif
107 
108  bool memoryDump = false;
109 
110  double haloShift = 0.0;
111 
112  unsigned int delPartFreq = 1;
113 }
bool mtrace
Trace flag.
Definition: Options.cpp:29
int seed
The current random seed.
Definition: Options.cpp:41
int infoLevel
Definition: Options.cpp:9
double haloShift
The constant parameter C to shift halo, by &lt; w^4 &gt; / &lt; w^2 &gt; ^2 - C (w=x,y,z)
Definition: Options.cpp:110
bool rhoDump
Definition: Options.cpp:32
int warnLevel
Definition: Options.cpp:11
int minStepForRebin
The number of steps into the simulation before the bins are squashed into a single bin...
Definition: Options.cpp:66
bool echo
Echo flag.
Definition: Options.cpp:7
bool memoryDump
Definition: Options.cpp:108
bool info
Info flag.
Definition: Options.cpp:8
int recycleBlocks
RCG: number of recycle blocks.
Definition: Options.cpp:82
double beamHaloBoundary
Definition: Options.cpp:24
bool warn
Warn flag.
Definition: Options.cpp:10
bool cZero
if true create symmetric distribution
Definition: Options.cpp:16
int statDumpFreq
The frequency to dump statistical values, e.e. dump data when stepstatDumpFreq==0.
Definition: Options.cpp:54
unsigned int delPartFreq
The frequency to delete particles (currently: OPAL-cycl only)
Definition: Options.cpp:112
int version
opal version of input file
Definition: Options.cpp:97
int sptDumpFreq
The frequency to dump single particle trajectory of particles with ID = 0 &amp; 1.
Definition: Options.cpp:57
Random rangen
Random generator.
Definition: Options.cpp:38
double remotePartDel
Definition: Options.cpp:22
int repartFreq
The frequency to do particles repartition for better load balance between nodes.
Definition: Options.cpp:60
std::string rngtype
random number generator
Definition: Options.cpp:85
int numBlocks
RCG: cycle length.
Definition: Options.cpp:81
The CLASSIC random generator.
Definition: ClassicRandom.h:36
bool enableHDF5
If true HDF5 files are written.
Definition: Options.cpp:35
int rebinFreq
The frequency to reset energy bin ID for all particles.
Definition: Options.cpp:69
int autoPhase
Definition: Options.cpp:45
int nLHS
number of old left hand sides used to extrapolate a new start vector
Definition: Options.cpp:83
int psDumpFreq
The frequency to dump the phase space, i.e.dump data when steppsDumpFreq==0.
Definition: Options.cpp:48
bool amr
Definition: Options.cpp:100
bool psDumpEachTurn
phase space dump flag for OPAL-cycl
Definition: Options.cpp:30
DumpFrame psDumpFrame
flag to decide in which coordinate frame the phase space will be dumped for OPAL-cycl ...
Definition: Options.cpp:31
bool asciidump
Definition: Options.cpp:18
int minBinEmitted
The number of bins that have to be emitted before the bin are squashed into a single bin...
Definition: Options.cpp:63
int amrRegridFreq
Definition: Options.cpp:105
int surfDumpFreq
The frequency to dump the particle-geometry surface interation data.
Definition: Options.cpp:78
int scSolveFreq
The frequency to solve space charge fields.
Definition: Options.cpp:72
int amrYtDumpFreq
The frequency to dump AMR grid data and particles into file.
Definition: Options.cpp:103
bool cloTuneOnly
Do closed orbit and tune calculation only.
Definition: Options.cpp:87
int boundpDestroyFreq
Definition: Options.cpp:91
int mtsSubsteps
Definition: Options.cpp:75
bool ppdebug
ppdebug flag.
Definition: Options.cpp:13
bool idealized
Definition: Options.cpp:94
bool csrDump
Definition: Options.cpp:12
bool ebDump
Definition: Options.cpp:33
bool writeBendTrajectories
Definition: Options.cpp:26