BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
beamBase.cc
1/*
2Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway,
3University of London 2001 - 2023.
4
5This file is part of BDSIM.
6
7BDSIM is free software: you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published
9by the Free Software Foundation version 3 of the License.
10
11BDSIM is distributed in the hope that it will be useful, but
12WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with BDSIM. If not, see <http://www.gnu.org/licenses/>.
18*/
19#include "beamBase.h"
20
21#include <iostream>
22
23using namespace GMAD;
24
25BeamBase::BeamBase()
26{
27 particle = "";
29 beamEnergy = 0;
31 beamMomentum = 0;
32 distrType = "reference";
33 xDistrType = "reference";
34 yDistrType = "reference";
35 zDistrType = "reference";
36 spaceDistrType = "reference";
37 directionDistrType = "reference";
38 energyDistrType = "reference";
39 distrFile = "";
40 distrFileFormat = "";
43 distrFileLoop = false;
46 nlinesIgnore = 0;
47 nlinesSkip = 0;
48
50 bunchPeriod = 0;
52
53 X0 = 0.0;
54 Y0 = 0.0;
55 Z0 = 0.0;
56 S0 = 0.0;
57 Xp0 = 0.0;
58 Yp0 = 0.0;
59 Zp0 = 0.0;
60 T0 = 0.0;
61 E0 = 0.0;
62 Ek0 = 0.0;
63 P0 = 0.0;
64 tilt = 0.0;
65 sigmaT = 0.0;
66 sigmaE = 0.0;
67 sigmaEk = 0.0;
68 sigmaP = 0.0;
69
70 betx = 0.0;
71 bety = 0.0;
72 alfx = 0.0;
73 alfy = 0.0;
74 emitx = 0.0;
75 emity = 0.0;
76 emitNX = 0.0;
77 emitNY = 0.0;
78 dispx = 0.0;
79 dispy = 0.0;
80 dispxp = 0.0;
81 dispyp = 0.0;
82 sigmaX = 0.0;
83 sigmaXp = 0.0;
84 sigmaY = 0.0;
85 sigmaYp = 0.0;
86
87 envelopeX = 0.0;
88 envelopeXp = 0.0;
89 envelopeY = 0.0;
90 envelopeYp = 0.0;
91 envelopeZ = 0.0;
92 envelopeZp = 0.0;
93 envelopeT = 0.0;
94 envelopeE = 0.0;
95 envelopeR = 0.0;
96 envelopeRp = 0.0;
97 zFromT = false;
98
99 sigma11 = 0.0,sigma12 = 0.0,sigma13 = 0.0,sigma14 = 0.0,sigma15 = 0.0,sigma16 = 0.0;
100 sigma22 = 0.0,sigma23 = 0.0,sigma24 = 0.0,sigma25 = 0.0,sigma26 = 0.0;
101 sigma33 = 0.0,sigma34 = 0.0,sigma35 = 0.0,sigma36 = 0.0;
102 sigma44 = 0.0,sigma45 = 0.0,sigma46 = 0.0;
103 sigma55 = 0.0,sigma56 = 0.0;
104 sigma66 = 0.0;
105
106 shellX = 0.0;
107 shellXp = 0.0;
108 shellY = 0.0;
109 shellYp = 0.0;
110 shellXWidth = 0.0;
111 shellXpWidth = 0.0;
112 shellYWidth = 0.0;
113 shellYpWidth = 0.0;
114
115 Rmin = 0.0;
116 Rmax = 0.0;
117
118 haloNSigmaXInner = 0.0;
119 haloNSigmaXOuter = 1e9;
120 haloNSigmaYInner = 0.0;
121 haloNSigmaYOuter = 1e9;
122 haloXCutInner = 0.0;
123 haloYCutInner = 0.0;
124 haloXCutOuter = 1e9;
125 haloYCutOuter = 1e9;
126 haloXpCutInner = 0.0;
127 haloYpCutInner = 0.0;
128 haloXpCutOuter = 1e9;
129 haloYpCutOuter = 1e9;
132
133 offsetSampleMean = false;
134
136 eventGeneratorMinX = -1e6;
137 eventGeneratorMaxX = 1e6;
138 eventGeneratorMinY = -1e6;
139 eventGeneratorMaxY = 1e6;
140 eventGeneratorMinZ = -1e6;
141 eventGeneratorMaxZ = 1e6;
143 eventGeneratorMaxXp = 1.1; // > 1 for no ambiguity (max value 1)
151 eventGeneratorMaxT = 1e50;
153 eventGeneratorMaxEK = 1e50;
156}
double dispy
initial twiss parameters
Definition: beamBase.h:90
double alfy
initial twiss parameters
Definition: beamBase.h:90
std::string particle
beam parameters
Definition: beamBase.h:40
double eventGeneratorMaxYp
Event generator file filter.
Definition: beamBase.h:153
double sigma45
for the gaussian sigma matrix distribution
Definition: beamBase.h:109
double eventGeneratorMaxXp
Event generator file filter.
Definition: beamBase.h:151
double sigmaE
for the gaussian, elliptic shell, ring distributions
Definition: beamBase.h:85
double emity
initial twiss parameters
Definition: beamBase.h:90
double haloXCutOuter
for the halo distribution
Definition: beamBase.h:130
double bunchFrequency
Bunch offsets in time.
Definition: beamBase.h:64
double sigma16
for the gaussian sigma matrix distribution
Definition: beamBase.h:106
double haloNSigmaYInner
for the halo distribution
Definition: beamBase.h:126
double beamKineticEnergy
beam parameters
Definition: beamBase.h:43
double envelopeRp
for the circle/square/box beam distribution
Definition: beamBase.h:101
double eventGeneratorMaxEK
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:95
std::string distrFileFormat
beam parameters
Definition: beamBase.h:53
double beamEnergy
beam parameters
Definition: beamBase.h:42
double envelopeZp
for the circle/square/box beam distribution
Definition: beamBase.h:99
bool eventGeneratorWarnSkippedParticles
Event generator file filter.
Definition: beamBase.h:163
double shellXp
for the elliptic shell distribution
Definition: beamBase.h:115
double sigma66
for the gaussian sigma matrix distribution
Definition: beamBase.h:111
double haloXCutInner
for the halo distribution
Definition: beamBase.h:128
double envelopeZ
for the circle/square/box beam distribution
Definition: beamBase.h:99
double sigma35
for the gaussian sigma matrix distribution
Definition: beamBase.h:108
double sigma44
for the gaussian sigma matrix distribution
Definition: beamBase.h:109
double haloYpCutInner
for the halo distribution
Definition: beamBase.h:133
double emitNY
initial twiss parameters
Definition: beamBase.h:91
double envelopeE
for the circle/square/box beam distribution
Definition: beamBase.h:100
double eventGeneratorMaxZp
Event generator file filter.
Definition: beamBase.h:155
double sigmaXp
for the gaussian beam distribution
Definition: beamBase.h:95
double eventGeneratorMinYp
Event generator file filter.
Definition: beamBase.h:152
double sigma13
for the gaussian sigma matrix distribution
Definition: beamBase.h:106
int eventsPerBunch
Bunch offsets in time.
Definition: beamBase.h:66
double sigma34
for the gaussian sigma matrix distribution
Definition: beamBase.h:108
double betx
initial twiss parameters
Definition: beamBase.h:90
std::string distrFile
beam parameters
Definition: beamBase.h:52
double eventGeneratorMinEK
Event generator file filter.
Definition: beamBase.h:160
std::string directionDistrType
beam parameters
Definition: beamBase.h:50
double haloYCutOuter
for the halo distribution
Definition: beamBase.h:131
double sigmaYp
for the gaussian beam distribution
Definition: beamBase.h:95
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:54
double dispxp
initial twiss parameters
Definition: beamBase.h:90
double envelopeYp
for the circle/square/box beam distribution
Definition: beamBase.h:99
double eventGeneratorMaxZ
Event generator file filter.
Definition: beamBase.h:149
double eventGeneratorMinY
Event generator file filter.
Definition: beamBase.h:146
double sigma12
for the gaussian sigma matrix distribution
Definition: beamBase.h:106
double Ek0
initial beam centroid
Definition: beamBase.h:74
std::string spaceDistrType
beam parameters
Definition: beamBase.h:49
double haloNSigmaYOuter
for the halo distribution
Definition: beamBase.h:127
std::string beamParticleName
beam parameters
Definition: beamBase.h:41
bool distrFileLoop
beam parameters
Definition: beamBase.h:56
bool removeUnstableWithoutDecay
beam parameters
Definition: beamBase.h:58
double sigma26
for the gaussian sigma matrix distribution
Definition: beamBase.h:107
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:79
double sigma25
for the gaussian sigma matrix distribution
Definition: beamBase.h:107
double shellXpWidth
for the elliptic shell distribution
Definition: beamBase.h:116
std::string distrType
beam parameters
Definition: beamBase.h:45
double sigma36
for the gaussian sigma matrix distribution
Definition: beamBase.h:108
int eventGeneratorNEventsSkip
Event generator file filter.
Definition: beamBase.h:143
double sigma46
for the gaussian sigma matrix distribution
Definition: beamBase.h:109
double eventGeneratorMaxRp
Event generator file filter.
Definition: beamBase.h:157
int nlinesIgnore
Ignore first lines in the input bunch file.
Definition: beamBase.h:60
double emitNX
initial twiss parameters
Definition: beamBase.h:91
double eventGeneratorMinZ
Event generator file filter.
Definition: beamBase.h:148
double envelopeR
for the circle/square/box beam distribution
Definition: beamBase.h:101
double S0
initial beam centroid
Definition: beamBase.h:70
double eventGeneratorMinXp
Event generator file filter.
Definition: beamBase.h:150
double shellYp
for the elliptic shell distribution
Definition: beamBase.h:115
double dispyp
initial twiss parameters
Definition: beamBase.h:90
double sigma14
for the gaussian sigma matrix distribution
Definition: beamBase.h:106
bool zFromT
for the circle/square/box beam distribution
Definition: beamBase.h:102
double bunchPeriod
Bunch offsets in time.
Definition: beamBase.h:65
double sigma23
for the gaussian sigma matrix distribution
Definition: beamBase.h:107
double sigma11
for the gaussian sigma matrix distribution
Definition: beamBase.h:106
double eventGeneratorMinZp
Event generator file filter.
Definition: beamBase.h:154
double envelopeX
for the circle/square/box beam distribution
Definition: beamBase.h:99
double shellX
for the elliptic shell distribution
Definition: beamBase.h:115
double P0
initial beam centroid
Definition: beamBase.h:75
std::string zDistrType
beam parameters
Definition: beamBase.h:48
double haloNSigmaXOuter
for the halo distribution
Definition: beamBase.h:125
double dispx
initial twiss parameters
Definition: beamBase.h:90
double alfx
initial twiss parameters
Definition: beamBase.h:90
double emitx
initial twiss parameters
Definition: beamBase.h:90
std::string eventGeneratorParticles
Event generator file filter.
Definition: beamBase.h:162
double sigmaT
bunch length
Definition: beamBase.h:82
double sigma22
for the gaussian sigma matrix distribution
Definition: beamBase.h:107
double bety
initial twiss parameters
Definition: beamBase.h:90
std::string yDistrType
beam parameters
Definition: beamBase.h:47
double Zp0
initial beam centroid
Definition: beamBase.h:71
double Rmax
for the ring beam distribution
Definition: beamBase.h:120
double envelopeXp
for the circle/square/box beam distribution
Definition: beamBase.h:99
int distrFileLoopNTimes
beam parameters
Definition: beamBase.h:57
double Z0
initial beam centroid
Definition: beamBase.h:70
double sigma33
for the gaussian sigma matrix distribution
Definition: beamBase.h:108
std::string energyDistrType
beam parameters
Definition: beamBase.h:51
double eventGeneratorMaxY
Event generator file filter.
Definition: beamBase.h:147
double eventGeneratorMinT
Event generator file filter.
Definition: beamBase.h:158
double sigma15
for the gaussian sigma matrix distribution
Definition: beamBase.h:106
double eventGeneratorMaxT
Event generator file filter.
Definition: beamBase.h:159
double envelopeY
for the circle/square/box beam distribution
Definition: beamBase.h:99
double haloPSWeightParameter
for the halo distribution
Definition: beamBase.h:136
double sigma55
for the gaussian sigma matrix distribution
Definition: beamBase.h:110
double sigma56
for the gaussian sigma matrix distribution
Definition: beamBase.h:110
double X0
initial beam centroid
Definition: beamBase.h:70
double eventGeneratorMaxX
Event generator file filter.
Definition: beamBase.h:145
double envelopeT
for the circle/square/box beam distribution
Definition: beamBase.h:100
int nlinesSkip
Number of event lines to skip after the ignore lines.
Definition: beamBase.h:61
double eventGeneratorMinRp
Event generator file filter.
Definition: beamBase.h:156
bool distrFileMatchLength
beam parameters
Definition: beamBase.h:55
double beamMomentum
beam parameters
Definition: beamBase.h:44
double Xp0
initial beam centroid
Definition: beamBase.h:71
double sigma24
for the gaussian sigma matrix distribution
Definition: beamBase.h:107
double eventGeneratorMinX
Event generator file filter.
Definition: beamBase.h:144
std::string xDistrType
beam parameters
Definition: beamBase.h:46
double shellY
for the elliptic shell distribution
Definition: beamBase.h:115
double Yp0
initial beam centroid
Definition: beamBase.h:71
std::string haloPSWeightFunction
for the halo distribution
Definition: beamBase.h:137
double shellYpWidth
for the elliptic shell distribution
Definition: beamBase.h:116
double haloXpCutInner
for the halo distribution
Definition: beamBase.h:132
double Y0
initial beam centroid
Definition: beamBase.h:70
double haloYpCutOuter
for the halo distribution
Definition: beamBase.h:135
double Rmin
for the ring beam distribution
Definition: beamBase.h:120
double T0
initial beam centroid
Definition: beamBase.h:72
double sigmaY
for the gaussian beam distribution
Definition: beamBase.h:95
double shellXWidth
for the elliptic shell distribution
Definition: beamBase.h:116
double shellYWidth
for the elliptic shell distribution
Definition: beamBase.h:116
double E0
initial beam centroid
Definition: beamBase.h:73
Parser namespace for GMAD language. Combination of Geant4 and MAD.