OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
Cyclotron.h
Go to the documentation of this file.
1//
2// Class Cyclotron
3// Defines the abstract interface for a cyclotron.
4//
5// Copyright (c) 2007 - 2012, Jianjun Yang and Andreas Adelmann, Paul Scherrer Institut, Villigen PSI, Switzerland
6// Copyright (c) 2013 - 2021, Paul Scherrer Institut, Villigen PSI, Switzerland
7// All rights reserved
8//
9// Implemented as part of the PhD thesis
10// "Beam dynamics in high intensity cyclotrons including neighboring bunch effects"
11// and the paper
12// "Beam dynamics in high intensity cyclotrons including neighboring bunch effects:
13// Model, implementation, and application"
14// (https://journals.aps.org/prab/pdf/10.1103/PhysRevSTAB.13.064201)
15//
16// This file is part of OPAL.
17//
18// OPAL is free software: you can redistribute it and/or modify
19// it under the terms of the GNU General Public License as published by
20// the Free Software Foundation, either version 3 of the License, or
21// (at your option) any later version.
22//
23// You should have received a copy of the GNU General Public License
24// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
25//
26#ifndef CLASSIC_Cyclotron_HH
27#define CLASSIC_Cyclotron_HH
28
31#include "Algorithms/Vektor.h"
32#include "Fields/Definitions.h"
33
34#include <cstddef>
35#include <memory>
36#include <string>
37#include <vector>
38
39class LossDataSink;
40class TrimCoil;
41
42struct BfieldData {
43 // known from file: field and three theta derivatives
44 std::vector<double> bfld_m; //Bz
45 std::vector<double> dbt_m; //dBz/dtheta
46 std::vector<double> dbtt_m; //d2Bz/dtheta2
47 std::vector<double> dbttt_m; //d3Bz/dtheta3
48
49 // to be calculated in getdiffs: all other derivatives:
50 std::vector<double> dbr_m; // dBz/dr
51 std::vector<double> dbrr_m; // ...
52 std::vector<double> dbrrr_m;
53
54 std::vector<double> dbrt_m;
55 std::vector<double> dbrrt_m;
56 std::vector<double> dbrtt_m;
57
58 // used to get (Br,Btheta,Bz) at any off-plane point
59 std::vector<double> f2_m; // for Bz
60 std::vector<double> f3_m; // for Br
61 std::vector<double> g3_m; // for Btheta
62
63 // Grid-Size
64 int nrad_m, ntet_m; // need to be read from inputfile.
65 int ntetS_m; // one more grid line is stored in azimuthal direction
66 int ntot_m; // total grid points number.
67
68 // Mean and Maximas
70};
71
72struct BPositions {
73 // these 4 parameters are need to be read from field file.
74 double rmin_m, delr_m;
76
77 // Radii and step width of initial Grid
78 std::vector<double> rarr_m;
79
80 // Multiplication factor for magnetic field
81 double Bfact_m;
82};
83
84class Cyclotron: public Component {
85
86public:
87 enum class BFieldType: unsigned short {
88 NONE,
89 PSIBF,
91 ANSYSBF,
92 AVFEQBF,
93 FFABF,
94 BANDRF,
96 };
97
99 explicit Cyclotron(const std::string& name);
100
101 Cyclotron();
102 Cyclotron(const Cyclotron&);
103
104 virtual ~Cyclotron();
105
107 virtual void accept(BeamlineVisitor&) const;
108
110 // Slices and stepsize used to determine integration step.
111 virtual double getSlices() const = 0;
112
114 // Slices and stepsize used to determine integration step.
115 virtual double getStepsize() const = 0;
116
117 void setFieldMapFN(const std::string& fmapfn);
118 virtual std::string getFieldMapFN() const;
119
120 void setRfFieldMapFN(std::vector<std::string> rffmapfn);
121 void setRFFCoeffFN(std::vector<std::string> rff_coeff_fn);
122 void setRFVCoeffFN(std::vector<std::string> rfv_coeff_fn);
123
124 void setCyclotronType(const std::string& type);
125 const std::string& getCyclotronType() const;
126
127 void setBFieldType();
129
130 virtual ElementType getType() const;
131
132 virtual void getDimensions(double& zBegin, double& zEnd) const;
133
134 unsigned int getNumberOfTrimcoils() const;
135
136 void setCyclHarm(double h);
137 virtual double getCyclHarm() const;
138
139 void setRfPhi(std::vector<double> f);
140 virtual std::vector<double> getRfPhi() const;
141
142 void setRfFrequ(std::vector<double> f);
143 virtual std::vector<double> getRfFrequ() const;
144
145 void setSymmetry(double symmetry);
146 virtual double getSymmetry() const;
147
148 void setRinit(double rinit);
149 virtual double getRinit() const;
150
151 void setPRinit(double prinit);
152 virtual double getPRinit() const;
153
154 void setPHIinit(double phiinit);
155 virtual double getPHIinit() const;
156
157 void setZinit(double zinit);
158 virtual double getZinit() const;
159
160 void setPZinit(double zinit);
161 virtual double getPZinit() const;
162
163 void setBScale(double bs);
164 virtual double getBScale() const;
165
166 void setEScale(std::vector<double> bs);
167 virtual std::vector<double> getEScale() const;
168
169 void setTrimCoils(const std::vector<TrimCoil*>& trimcoils);
170
171 void setSuperpose(std::vector<bool> flag);
172 virtual std::vector<bool> getSuperpose() const;
173
174 void setMinR(double r);
175 virtual double getMinR() const;
176 void setMaxR(double r);
177 virtual double getMaxR() const;
178
179 void setMinZ(double z);
180 virtual double getMinZ() const;
181 void setMaxZ(double z);
182 virtual double getMaxZ() const;
183
184 void setFMLowE(double e);
185 virtual double getFMLowE() const;
186 void setFMHighE(double e);
187 virtual double getFMHighE() const;
188
189 void setTrimCoilThreshold(double);
190 virtual double getTrimCoilThreshold() const;
191
192 void setSpiralFlag(bool spiral_flag);
193 virtual bool getSpiralFlag() const;
194
196 void setTurnNumber(int turn);
197
198 virtual bool apply(const size_t& id, const double& t, Vector_t& E, Vector_t& B);
199
200 virtual bool apply(const Vector_t& R, const Vector_t& P, const double& t, Vector_t& E, Vector_t& B);
201
202 virtual void apply(const double& rad, const double& z,
203 const double& tet_rad, double& br,
204 double& bt, double& bz);
205
206 virtual void initialise(PartBunchBase<double, 3>* bunch, double& startField, double& endField);
207
208 virtual void initialise(PartBunchBase<double, 3>* bunch, const double& scaleFactor);
209
210 virtual void finalise();
211
212 virtual bool bends() const;
213
214 virtual double getRmax() const;
215 virtual double getRmin() const;
216
217 bool interpolate(const double& rad,
218 const double& tet_rad,
219 double& br,
220 double& bt,
221 double& bz);
222
223 void read(const double& scaleFactor);
224
226
227 void checkInitialReferenceParticle(double refR, double refTheta, double refZ);
228
229private:
231 void applyTrimCoil (const double r, const double z, const double tet_rad, double& br, double& bz);
233 void applyTrimCoil_m(const double r, const double z, const double tet_rad, double* br, double* bz);
234
235
236protected:
237 void getdiffs();
238 double gutdf5d(double* f, double dx, const int kor, const int krl, const int lpr);
239
240 void initR(double rmin, double dr, int nrad);
241
242 void getFieldFromFile_Ring(const double& scaleFactor);
243 void getFieldFromFile_Carbon(const double& scaleFactor);
244 void getFieldFromFile_CYCIAE(const double& scaleFactor);
245 void getFieldFromFile_AVFEQ(const double& scaleFactor);
246 void getFieldFromFile_FFA(const double& scaleFactor);
247 void getFieldFromFile_BandRF(const double& scaleFactor);
248 void getFieldFromFile_Synchrocyclotron(const double& scaleFactor);
249
250 inline int idx(int irad, int ktet) {return (ktet + Bfield_m.ntetS_m * irad);}
251
252
253private:
255
256 std::string fmapfn_m;
257 std::vector<double> rffrequ_m;
258 std::vector< std::vector<double> > rffc_m;
259 std::vector<double> rfvrequ_m;
260 std::vector< std::vector<double> > rfvc_m;
261 std::vector<double> rfphi_m;
262 std::vector<double> escale_m;
263 std::vector<bool> superpose_m;
266
267 double rinit_m;
268 double prinit_m;
269 double phiinit_m;
270 double zinit_m;
271 double pzinit_m;
272
276 std::string typeName_m;
278 double harm_m;
279
280 double bscale_m;
282 std::vector<TrimCoil*> trimcoils_m;
284 double minr_m;
285 double maxr_m;
286 double minz_m;
287 double maxz_m;
288
289 double fmLowE_m;
290 double fmHighE_m;
291
292 // Not implemented.
293 void operator=(const Cyclotron &) = delete;
294
295 // RF field map handler
296 // Fieldmap RFfield;
297 std::vector<Fieldmap> RFfields_m;
298 std::vector<std::string> RFfilename_m;
299 std::vector<std::string> RFFCoeff_fn_m;
300 std::vector<std::string> RFVCoeff_fn_m;
301
302 std::unique_ptr<LossDataSink> lossDs_m;
304 int turnNumber_m = 0;
306 // Necessary for quick and dirty phase output -DW
308
313
317 bool midplaneMapInterior(const Vector_t& R) const;
318
324 static constexpr int size = 4;
325 double t[size];
326 double cosPhase[size];
327 double sinPhase[size];
328 int next = 0;
329 RFPhaseCache();
330 };
331 std::vector<RFPhaseCache> rfPhaseCache_m;
332
333 void rfPhase(std::size_t map, double t, double frequency, double phi,
334 double& cosPhase, double& sinPhase);
335
336protected:
337 // object of Matrices including magnetic field map and its derivates
339
340 // object of parameters about the map grid
342};
343
344#endif // CLASSIC_Cyclotron_HH
ElementType
Definition ElementBase.h:89
const std::string name
Interface for a single beam element.
Definition Component.h:50
double bacc_m
Definition Cyclotron.h:69
std::vector< double > dbrrt_m
Definition Cyclotron.h:55
std::vector< double > g3_m
Definition Cyclotron.h:61
std::vector< double > dbtt_m
Definition Cyclotron.h:46
std::vector< double > dbrtt_m
Definition Cyclotron.h:56
std::vector< double > f3_m
Definition Cyclotron.h:60
std::vector< double > dbrr_m
Definition Cyclotron.h:51
std::vector< double > dbrrr_m
Definition Cyclotron.h:52
std::vector< double > dbttt_m
Definition Cyclotron.h:47
double dbtmx_m
Definition Cyclotron.h:69
std::vector< double > dbrt_m
Definition Cyclotron.h:54
std::vector< double > dbr_m
Definition Cyclotron.h:50
std::vector< double > dbt_m
Definition Cyclotron.h:45
int ntetS_m
Definition Cyclotron.h:65
std::vector< double > bfld_m
Definition Cyclotron.h:44
double dbtttmx_m
Definition Cyclotron.h:69
std::vector< double > f2_m
Definition Cyclotron.h:59
double dbttmx_m
Definition Cyclotron.h:69
double delr_m
Definition Cyclotron.h:74
double rmin_m
Definition Cyclotron.h:74
double dtet_m
Definition Cyclotron.h:75
double Bfact_m
Definition Cyclotron.h:81
std::vector< double > rarr_m
Definition Cyclotron.h:78
double tetmin_m
Definition Cyclotron.h:75
virtual std::vector< double > getEScale() const
void setTrimCoilThreshold(double)
void setZinit(double zinit)
virtual double getStepsize() const =0
Get stepsize.
double minr_m
Definition Cyclotron.h:284
virtual double getCyclHarm() const
double rinit_m
Definition Cyclotron.h:267
void setBFieldType()
virtual void getDimensions(double &zBegin, double &zEnd) const
std::vector< std::string > RFfilename_m
Definition Cyclotron.h:298
virtual bool getSpiralFlag() const
virtual bool bends() const
void getFieldFromFile_CYCIAE(const double &scaleFactor)
void setSpiralFlag(bool spiral_flag)
virtual ElementType getType() const
Get element type std::string.
virtual double getPRinit() const
void getFieldFromFile_BandRF(const double &scaleFactor)
double harm_m
Definition Cyclotron.h:278
void setSuperpose(std::vector< bool > flag)
double fmHighE_m
Definition Cyclotron.h:290
void setMinR(double r)
virtual double getTrimCoilThreshold() const
double prinit_m
Definition Cyclotron.h:268
void checkInitialReferenceParticle(double refR, double refTheta, double refZ)
void setRfPhi(std::vector< double > f)
void setRFVCoeffFN(std::vector< std::string > rfv_coeff_fn)
void rfPhase(std::size_t map, double t, double frequency, double phi, double &cosPhase, double &sinPhase)
bool spiralFlag_m
Definition Cyclotron.h:273
void setPZinit(double zinit)
void setCyclotronType(const std::string &type)
virtual void accept(BeamlineVisitor &) const
Apply visitor to Cyclotron.
virtual double getPZinit() const
double symmetry_m
Definition Cyclotron.h:265
std::string typeName_m
Definition Cyclotron.h:276
virtual std::string getFieldMapFN() const
virtual double getRmin() const
void read(const double &scaleFactor)
int idx(int irad, int ktet)
Definition Cyclotron.h:250
double phiinit_m
Definition Cyclotron.h:269
virtual double getMaxR() const
void setEScale(std::vector< double > bs)
double zinit_m
Definition Cyclotron.h:270
void setSymmetry(double symmetry)
std::vector< bool > superpose_m
Definition Cyclotron.h:263
virtual void finalise()
virtual std::vector< double > getRfFrequ() const
std::vector< double > escale_m
Definition Cyclotron.h:262
std::vector< std::string > RFVCoeff_fn_m
Definition Cyclotron.h:300
bool midplaneMapInterior(const Vector_t &R) const
std::vector< double > rffrequ_m
Definition Cyclotron.h:257
double maxz_m
Definition Cyclotron.h:287
void getFieldFromFile_AVFEQ(const double &scaleFactor)
void setMaxR(double r)
virtual double getRmax() const
virtual double getFMHighE() const
double gutdf5d(double *f, double dx, const int kor, const int krl, const int lpr)
void setFieldMapFN(const std::string &fmapfn)
double trimCoilThreshold_m
Definition Cyclotron.h:274
virtual double getMaxZ() const
void getdiffs()
void setMaxZ(double z)
virtual double getBScale() const
void operator=(const Cyclotron &)=delete
virtual double getZinit() const
void getFieldFromFile_Carbon(const double &scaleFactor)
void writeOutputFieldFiles()
virtual double getPHIinit() const
std::vector< TrimCoil * > trimcoils_m
Definition Cyclotron.h:282
void setTurnNumber(int turn)
Turn number written into the loss records of apply(); the tracker sets it every step.
std::vector< std::string > RFFCoeff_fn_m
Definition Cyclotron.h:299
void setTrimCoils(const std::vector< TrimCoil * > &trimcoils)
virtual double getSymmetry() const
void setCyclHarm(double h)
virtual double getMinZ() const
void getFieldFromFile_Synchrocyclotron(const double &scaleFactor)
bool midplaneMapIsZero_m
Definition Cyclotron.h:312
virtual std::vector< double > getRfPhi() const
void applyTrimCoil_m(const double r, const double z, const double tet_rad, double *br, double *bz)
Apply trim coils (calculate field contributions)
Definition Cyclotron.cpp:99
virtual ~Cyclotron()
Definition Cyclotron.cpp:95
BFieldType getBFieldType() const
double minz_m
Definition Cyclotron.h:286
virtual void initialise(PartBunchBase< double, 3 > *bunch, double &startField, double &endField)
double fmLowE_m
Definition Cyclotron.h:289
void getFieldFromFile_FFA(const double &scaleFactor)
std::string fmapfn_m
Definition Cyclotron.h:256
void initR(double rmin, double dr, int nrad)
void setPHIinit(double phiinit)
void setRfFrequ(std::vector< double > f)
void setPRinit(double prinit)
std::vector< RFPhaseCache > rfPhaseCache_m
Definition Cyclotron.h:331
void applyTrimCoil(const double r, const double z, const double tet_rad, double &br, double &bz)
Apply trim coils (calculate field contributions) with smooth field transition.
BFieldType fieldType_m
Definition Cyclotron.h:254
double bscale_m
Definition Cyclotron.h:280
virtual bool apply(const size_t &id, const double &t, Vector_t &E, Vector_t &B)
void setRfFieldMapFN(std::vector< std::string > rffmapfn)
bool interpolate(const double &rad, const double &tet_rad, double &br, double &bt, double &bz)
void setFMHighE(double e)
std::vector< double > rfphi_m
Definition Cyclotron.h:261
std::vector< double > rfvrequ_m
Definition Cyclotron.h:259
void setMinZ(double z)
void setRinit(double rinit)
int waitingGap_m
Definition Cyclotron.h:307
double pzinit_m
Definition Cyclotron.h:271
int turnNumber_m
Definition Cyclotron.h:304
virtual std::vector< bool > getSuperpose() const
double maxr_m
Definition Cyclotron.h:285
BfieldData Bfield_m
Definition Cyclotron.h:338
std::vector< std::vector< double > > rfvc_m
Definition Cyclotron.h:260
std::vector< std::vector< double > > rffc_m
Definition Cyclotron.h:258
BPositions BP_m
Definition Cyclotron.h:341
std::vector< Fieldmap > RFfields_m
Definition Cyclotron.h:297
virtual double getFMLowE() const
std::unique_ptr< LossDataSink > lossDs_m
Definition Cyclotron.h:302
unsigned int getNumberOfTrimcoils() const
virtual double getRinit() const
void getFieldFromFile_Ring(const double &scaleFactor)
virtual double getMinR() const
const std::string & getCyclotronType() const
void setRFFCoeffFN(std::vector< std::string > rff_coeff_fn)
void setFMLowE(double e)
void setBScale(double bs)
virtual double getSlices() const =0
Get number of slices.
double sinPhase[size]
Definition Cyclotron.h:327
static constexpr int size
Definition Cyclotron.h:324
double cosPhase[size]
Definition Cyclotron.h:326