BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
beamBase.h
1/*
2Beam Delivery Simulation (BDSIM) Copyright (C) BDSIM Collaboration, 2001 - 2026.
3
4This file is part of BDSIM.
5
6BDSIM is free software: you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published
8by the Free Software Foundation version 3 of the License.
9
10BDSIM is distributed in the hope that it will be useful, but
11WITHOUT ANY WARRANTY; without even the implied warranty of
12MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13GNU General Public License for more details.
14
15You should have received a copy of the GNU General Public License
16along with BDSIM. If not, see <http://www.gnu.org/licenses/>.
17*/
18#ifndef BEAMBASE_H
19#define BEAMBASE_H
20
21#include <string>
22#include <vector>
23
24namespace GMAD
25{
34 {
35 public:
36 BeamBase();
37
39 std::string particle;
40 std::string beamParticleName;
41 double beamEnergy;
44 std::string distrType;
45 std::string xDistrType;
46 std::string yDistrType;
47 std::string zDistrType;
48 std::string spaceDistrType;
49 std::string directionDistrType;
50 std::string energyDistrType;
51 std::string distrFile;
52 std::string distrFileFormat;
61
67
69 double X0, Y0, Z0, S0;
70 double Xp0, Yp0, Zp0;
71 double T0;
72 double E0;
73 double Ek0;
74 double P0;
76
78 double tilt;
79
81 double sigmaT;
82
84 double sigmaE;
85 double sigmaEk;
86 double sigmaP;
87
90 double emitNX, emitNY;
92
96
101 bool zFromT;
103
110 double sigma66;
112
117
119 double Rmin, Rmax;
120 double Rpmin, Rpmax;
122
139
140 bool offsetSampleMean;
141
165
167 double dTStart;
168 double dTStop;
169 double dPStart;
170 double dPStop;
172
174 std::vector<std::string> setKeys;
175
176 double polarization1;
177 double polarization2;
178 double polarization3;
179 };
180}
181
182#endif
Options for a beam distribution.
Definition beamBase.h:34
double dispy
initial twiss parameters
Definition beamBase.h:89
double alfy
initial twiss parameters
Definition beamBase.h:89
std::string particle
beam parameters
Definition beamBase.h:39
double eventGeneratorMaxYp
fo event generator file filter
Definition beamBase.h:153
double sigma45
for the gaussian sigma matrix distribution
Definition beamBase.h:108
double eventGeneratorMaxXp
fo event generator file filter
Definition beamBase.h:151
double sigmaE
for the gaussian, elliptic shell, ring distributions
Definition beamBase.h:84
double emity
initial twiss parameters
Definition beamBase.h:89
double haloXCutOuter
for the halo distribution
Definition beamBase.h:130
double bunchFrequency
Bunch offsets in time.
Definition beamBase.h:63
double sigma16
for the gaussian sigma matrix distribution
Definition beamBase.h:105
double haloNSigmaYInner
for the halo distribution
Definition beamBase.h:126
double beamKineticEnergy
beam parameters
Definition beamBase.h:42
double envelopeRp
for the circle/square/box beam distribution
Definition beamBase.h:100
double eventGeneratorMaxEK
fo event generator file filter
Definition beamBase.h:161
double haloXpCutOuter
for the halo distribution
Definition beamBase.h:134
double sigmaX
for the gaussian beam distribution
Definition beamBase.h:94
std::string distrFileFormat
beam parameters
Definition beamBase.h:52
double beamEnergy
beam parameters
Definition beamBase.h:41
double envelopeZp
for the circle/square/box beam distribution
Definition beamBase.h:98
bool eventGeneratorWarnSkippedParticles
fo event generator file filter
Definition beamBase.h:163
double shellXp
for the elliptic shell distribution
Definition beamBase.h:114
double sigma66
for the gaussian sigma matrix distribution
Definition beamBase.h:110
double haloXCutInner
for the halo distribution
Definition beamBase.h:128
double envelopeZ
for the circle/square/box beam distribution
Definition beamBase.h:98
double sigma35
for the gaussian sigma matrix distribution
Definition beamBase.h:107
double sigma44
for the gaussian sigma matrix distribution
Definition beamBase.h:108
double haloYpCutInner
for the halo distribution
Definition beamBase.h:133
double emitNY
initial twiss parameters
Definition beamBase.h:90
double envelopeE
for the circle/square/box beam distribution
Definition beamBase.h:99
double eventGeneratorMaxZp
fo event generator file filter
Definition beamBase.h:155
double sigmaXp
for the gaussian beam distribution
Definition beamBase.h:94
double eventGeneratorMinYp
fo event generator file filter
Definition beamBase.h:152
double sigma13
for the gaussian sigma matrix distribution
Definition beamBase.h:105
int eventsPerBunch
Bunch offsets in time.
Definition beamBase.h:65
double sigma34
for the gaussian sigma matrix distribution
Definition beamBase.h:107
double betx
initial twiss parameters
Definition beamBase.h:89
std::string distrFile
beam parameters
Definition beamBase.h:51
double dPStop
for slow-extraction beam
Definition beamBase.h:170
double dTStart
for slow-extraction beam
Definition beamBase.h:167
double eventGeneratorMinEK
fo event generator file filter
Definition beamBase.h:160
std::string directionDistrType
beam parameters
Definition beamBase.h:49
double haloYCutOuter
for the halo distribution
Definition beamBase.h:131
double sigmaYp
for the gaussian beam distribution
Definition beamBase.h:94
double haloNSigmaXInner
for the halo distribution
Definition beamBase.h:124
bool distrFileFromExecOptions
Required to know how to build the absolute path properly.
Definition beamBase.h:53
double dispxp
initial twiss parameters
Definition beamBase.h:89
double envelopeYp
for the circle/square/box beam distribution
Definition beamBase.h:98
double eventGeneratorMaxZ
fo event generator file filter
Definition beamBase.h:149
double eventGeneratorMinY
fo event generator file filter
Definition beamBase.h:146
double sigma12
for the gaussian sigma matrix distribution
Definition beamBase.h:105
double Ek0
initial beam centroid
Definition beamBase.h:73
std::string spaceDistrType
beam parameters
Definition beamBase.h:48
double haloNSigmaYOuter
for the halo distribution
Definition beamBase.h:127
std::string beamParticleName
beam parameters
Definition beamBase.h:40
bool distrFileLoop
beam parameters
Definition beamBase.h:55
bool removeUnstableWithoutDecay
beam parameters
Definition beamBase.h:57
double sigma26
for the gaussian sigma matrix distribution
Definition beamBase.h:106
double haloYCutInner
for the halo distribution
Definition beamBase.h:129
double tilt
tilt of beam applied as rotation about unit local z
Definition beamBase.h:78
double sigma25
for the gaussian sigma matrix distribution
Definition beamBase.h:106
double shellXpWidth
for the elliptic shell distribution
Definition beamBase.h:115
std::string distrType
beam parameters
Definition beamBase.h:44
double sigma36
for the gaussian sigma matrix distribution
Definition beamBase.h:107
int eventGeneratorNEventsSkip
fo event generator file filter
Definition beamBase.h:143
double sigma46
for the gaussian sigma matrix distribution
Definition beamBase.h:108
double eventGeneratorMaxRp
fo event generator file filter
Definition beamBase.h:157
int nlinesIgnore
Ignore first lines in the input bunch file.
Definition beamBase.h:59
double emitNX
initial twiss parameters
Definition beamBase.h:90
double eventGeneratorMinZ
fo event generator file filter
Definition beamBase.h:148
double dPStart
for slow-extraction beam
Definition beamBase.h:169
double envelopeR
for the circle/square/box beam distribution
Definition beamBase.h:100
double S0
initial beam centroid
Definition beamBase.h:69
double eventGeneratorMinXp
fo event generator file filter
Definition beamBase.h:150
double shellYp
for the elliptic shell distribution
Definition beamBase.h:114
double dispyp
initial twiss parameters
Definition beamBase.h:89
double sigma14
for the gaussian sigma matrix distribution
Definition beamBase.h:105
bool zFromT
for the circle/square/box beam distribution
Definition beamBase.h:101
double bunchPeriod
Bunch offsets in time.
Definition beamBase.h:64
double sigma23
for the gaussian sigma matrix distribution
Definition beamBase.h:106
double sigma11
for the gaussian sigma matrix distribution
Definition beamBase.h:105
double eventGeneratorMinZp
fo event generator file filter
Definition beamBase.h:154
double envelopeX
for the circle/square/box beam distribution
Definition beamBase.h:98
double shellX
for the elliptic shell distribution
Definition beamBase.h:114
double dTStop
for slow-extraction beam
Definition beamBase.h:168
double P0
initial beam centroid
Definition beamBase.h:74
std::string zDistrType
beam parameters
Definition beamBase.h:47
double haloNSigmaXOuter
for the halo distribution
Definition beamBase.h:125
std::vector< std::string > setKeys
A list of all the keys that have been set in this instance.
Definition beamBase.h:174
double dispx
initial twiss parameters
Definition beamBase.h:89
double alfx
initial twiss parameters
Definition beamBase.h:89
double emitx
initial twiss parameters
Definition beamBase.h:89
std::string eventGeneratorParticles
fo event generator file filter
Definition beamBase.h:162
double sigmaT
bunch length
Definition beamBase.h:81
double sigma22
for the gaussian sigma matrix distribution
Definition beamBase.h:106
double bety
initial twiss parameters
Definition beamBase.h:89
std::string yDistrType
beam parameters
Definition beamBase.h:46
double Zp0
initial beam centroid
Definition beamBase.h:70
double Rmax
for the ring beam distribution
Definition beamBase.h:119
double envelopeXp
for the circle/square/box beam distribution
Definition beamBase.h:98
int distrFileLoopNTimes
beam parameters
Definition beamBase.h:56
double Z0
initial beam centroid
Definition beamBase.h:69
double sigma33
for the gaussian sigma matrix distribution
Definition beamBase.h:107
std::string energyDistrType
beam parameters
Definition beamBase.h:50
double eventGeneratorMaxY
fo event generator file filter
Definition beamBase.h:147
double eventGeneratorMinT
fo event generator file filter
Definition beamBase.h:158
double sigma15
for the gaussian sigma matrix distribution
Definition beamBase.h:105
double eventGeneratorMaxT
fo event generator file filter
Definition beamBase.h:159
double envelopeY
for the circle/square/box beam distribution
Definition beamBase.h:98
double haloPSWeightParameter
for the halo distribution
Definition beamBase.h:136
double Rpmax
for the ring beam distribution
Definition beamBase.h:120
double sigma55
for the gaussian sigma matrix distribution
Definition beamBase.h:109
double sigma56
for the gaussian sigma matrix distribution
Definition beamBase.h:109
double X0
initial beam centroid
Definition beamBase.h:69
double eventGeneratorMaxX
fo event generator file filter
Definition beamBase.h:145
double envelopeT
for the circle/square/box beam distribution
Definition beamBase.h:99
int nlinesSkip
Number of event lines to skip after the ignore lines.
Definition beamBase.h:60
double eventGeneratorMinRp
fo event generator file filter
Definition beamBase.h:156
bool distrFileMatchLength
beam parameters
Definition beamBase.h:54
double beamMomentum
beam parameters
Definition beamBase.h:43
double Xp0
initial beam centroid
Definition beamBase.h:70
double sigma24
for the gaussian sigma matrix distribution
Definition beamBase.h:106
double eventGeneratorMinX
fo event generator file filter
Definition beamBase.h:144
std::string xDistrType
beam parameters
Definition beamBase.h:45
double shellY
for the elliptic shell distribution
Definition beamBase.h:114
double Yp0
initial beam centroid
Definition beamBase.h:70
std::string haloPSWeightFunction
for the halo distribution
Definition beamBase.h:137
double shellYpWidth
for the elliptic shell distribution
Definition beamBase.h:115
double haloXpCutInner
for the halo distribution
Definition beamBase.h:132
double Y0
initial beam centroid
Definition beamBase.h:69
double haloYpCutOuter
for the halo distribution
Definition beamBase.h:135
double Rpmin
for the ring beam distribution
Definition beamBase.h:120
double Rmin
for the ring beam distribution
Definition beamBase.h:119
double T0
initial beam centroid
Definition beamBase.h:71
double sigmaY
for the gaussian beam distribution
Definition beamBase.h:94
double shellXWidth
for the elliptic shell distribution
Definition beamBase.h:115
double shellYWidth
for the elliptic shell distribution
Definition beamBase.h:115
double E0
initial beam centroid
Definition beamBase.h:72
Parser namespace for GMAD language. Combination of Geant4 and MAD.