ParallelCyclotronTracker.cpp 122 KB
Newer Older
gsell's avatar
gsell committed
1 2 3 4 5 6 7 8 9
// ------------------------------------------------------------------------
// $RCSfile: ParallelCyclotronTracker.cpp,v $
// ------------------------------------------------------------------------
// $Revision: 1.1 $initialLocalNum_m
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: ParallelCyclotronTracker
ext-rogers_c's avatar
ext-rogers_c committed
10
//   The class for tracking particles with 3D space charge in Cyclotrons and FFAs
gsell's avatar
gsell committed
11 12 13 14
//
// ------------------------------------------------------------------------
//
// $Date: 2007/10/17 04:00:08 $
15
// $Author: adelmann, yang, winklehner $
gsell's avatar
gsell committed
16 17
//
// ------------------------------------------------------------------------
kraus's avatar
kraus committed
18 19

#include "Algorithms/ParallelCyclotronTracker.h"
20

gsell's avatar
gsell committed
21
#include <fstream>
22 23
#include <iostream>
#include <limits>
gsell's avatar
gsell committed
24
#include <vector>
frey_m's avatar
frey_m committed
25
#include <numeric>
26 27

#include "AbstractObjects/Element.h"
28
#include "AbstractObjects/OpalData.h"
gsell's avatar
gsell committed
29

30
#include "AbsBeamline/CCollimator.h"
gsell's avatar
gsell committed
31 32
#include "AbsBeamline/Corrector.h"
#include "AbsBeamline/Cyclotron.h"
33
#include "AbsBeamline/CyclotronValley.h"
adelmann's avatar
adelmann committed
34
#include "AbsBeamline/Degrader.h"
gsell's avatar
gsell committed
35 36 37 38
#include "AbsBeamline/Diagnostic.h"
#include "AbsBeamline/Drift.h"
#include "AbsBeamline/ElementBase.h"
#include "AbsBeamline/Lambertson.h"
39
#include "AbsBeamline/Offset.h"
gsell's avatar
gsell committed
40 41 42
#include "AbsBeamline/Marker.h"
#include "AbsBeamline/Monitor.h"
#include "AbsBeamline/Multipole.h"
ext-rogers_c's avatar
ext-rogers_c committed
43
#include "AbsBeamline/MultipoleT.h"
44 45 46 47
#include "AbsBeamline/MultipoleTBase.h"
#include "AbsBeamline/MultipoleTStraight.h"
#include "AbsBeamline/MultipoleTCurvedConstRadius.h"
#include "AbsBeamline/MultipoleTCurvedVarRadius.h"
48
#include "AbsBeamline/PluginElement.h"
gsell's avatar
gsell committed
49 50
#include "AbsBeamline/Probe.h"
#include "AbsBeamline/RBend.h"
51
#include "AbsBeamline/Ring.h"
gsell's avatar
gsell committed
52 53 54
#include "AbsBeamline/RFCavity.h"
#include "AbsBeamline/RFQuadrupole.h"
#include "AbsBeamline/SBend.h"
55
#include "AbsBeamline/SBend3D.h"
ext-rogers_c's avatar
ext-rogers_c committed
56
#include "AbsBeamline/ScalingFFAMagnet.h"
gsell's avatar
gsell committed
57 58 59 60
#include "AbsBeamline/Separator.h"
#include "AbsBeamline/Septum.h"
#include "AbsBeamline/Solenoid.h"
#include "AbsBeamline/Stripper.h"
61
#include "AbsBeamline/VariableRFCavity.h"
62
#include "AbsBeamline/VariableRFCavityFringeField.h"
63

64 65
#include "Algorithms/Ctunes.h"
#include "Algorithms/PolynomialTimeDependence.h"
gsell's avatar
gsell committed
66 67

#include "Beamlines/Beamline.h"
68
#include "Beamlines/FlaggedBeamline.h"
gsell's avatar
gsell committed
69

70
#include "Elements/OpalBeamline.h"
gsell's avatar
gsell committed
71 72 73 74

#include "Physics/Physics.h"

#include "Utilities/OpalException.h"
75
#include "Utilities/Options.h"
gsell's avatar
gsell committed
76

77
#include "BasicActions/DumpFields.h"
78
#include "BasicActions/DumpEMFields.h"
79

80
#include "Structure/BoundaryGeometry.h"
81
#include "Structure/DataSink.h"
frey_m's avatar
frey_m committed
82

gsell's avatar
gsell committed
83 84 85
using Physics::pi;
using Physics::q_e;

86

87
const double c_mmtns = Physics::c * 1.0e-6; // m/s --> mm/ns
88

89 90 91
Vector_t const ParallelCyclotronTracker::xaxis = Vector_t(1.0, 0.0, 0.0);
Vector_t const ParallelCyclotronTracker::yaxis = Vector_t(0.0, 1.0, 0.0);
Vector_t const ParallelCyclotronTracker::zaxis = Vector_t(0.0, 0.0, 1.0);
gsell's avatar
gsell committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

extern Inform *gmsg;

/**
 * Constructor ParallelCyclotronTracker
 *
 * @param beamline
 * @param bunch
 * @param ds
 * @param reference
 * @param revBeam
 * @param revTrack
 * @param maxSTEPS
 * @param timeIntegrator
 */
ParallelCyclotronTracker::ParallelCyclotronTracker(const Beamline &beamline,
frey_m's avatar
frey_m committed
108
                                                   PartBunchBase<double, 3> *bunch,
gsell's avatar
gsell committed
109 110 111
                                                   DataSink &ds,
                                                   const PartData &reference,
                                                   bool revBeam, bool revTrack,
frey_m's avatar
frey_m committed
112
                                                   int maxSTEPS, int timeIntegrator,
113 114 115 116 117
                                                   const int& numBunch,
                                                   const double& mbEta,
                                                   const double& mbPara,
                                                   const std::string& mbMode,
                                                   const std::string& mbBinning)
frey_m's avatar
frey_m committed
118 119 120 121 122 123 124 125 126 127
    : Tracker(beamline, bunch, reference, revBeam, revTrack)
    , bgf_m(nullptr)
    , maxSteps_m(maxSTEPS)
    , lastDumpedStep_m(0)
    , myNode_m(Ippl::myNode())
    , initialLocalNum_m(bunch->getLocalNum())
    , initialTotalNum_m(bunch->getTotalNum())
    , opalRing_m(nullptr)
    , itsStepper_mp(nullptr)
{
gsell's avatar
gsell committed
128 129 130
    itsBeamline = dynamic_cast<Beamline *>(beamline.clone());
    itsDataSink = &ds;

131 132 133
    if ( numBunch > 1 ) {
        mbHandler_m = std::unique_ptr<MultiBunchHandler>(
            new MultiBunchHandler(bunch, numBunch, mbEta,
frey_m's avatar
frey_m committed
134
                                  mbPara, mbMode, mbBinning)
135 136 137
        );
    }

gsell's avatar
gsell committed
138 139 140 141
    IntegrationTimer_m = IpplTimings::getTimer("Integration");
    TransformTimer_m   = IpplTimings::getTimer("Frametransform");
    DumpTimer_m        = IpplTimings::getTimer("Dump");
    BinRepartTimer_m   = IpplTimings::getTimer("Binaryrepart");
142 143
    PluginElemTimer_m  = IpplTimings::getTimer("PluginElements");
    DelParticleTimer_m = IpplTimings::getTimer("DeleteParticles");
144

145 146 147 148 149 150 151 152 153
    // FIXME Change track command
    if ( initialTotalNum_m == 1 ) {
        mode_m = MODE::SINGLE;
    } else if ( initialTotalNum_m == 2 ) {
        mode_m = MODE::SEO;
    } else if ( initialTotalNum_m > 2 ) {
        mode_m = MODE::BUNCH;
    } else
        mode_m = MODE::UNDEFINED;
154

155 156 157 158 159 160 161 162
    if ( timeIntegrator == 0 ) {
        stepper_m = stepper::INTEGRATOR::RK4;
    } else if ( timeIntegrator == 1) {
        stepper_m = stepper::INTEGRATOR::LF2;
    } else if ( timeIntegrator == 2) {
        stepper_m = stepper::INTEGRATOR::MTS;
    } else
        stepper_m = stepper::INTEGRATOR::UNDEFINED;
gsell's avatar
gsell committed
163 164 165 166 167 168 169
}

/**
 * Destructor ParallelCyclotronTracker
 *
 */
ParallelCyclotronTracker::~ParallelCyclotronTracker() {
170 171
    for(Component* component : myElements) {
        delete(component);
gsell's avatar
gsell committed
172
    }
173 174
    for(auto fd : FieldDimensions) {
        delete(fd);
gsell's avatar
gsell committed
175 176
    }
    delete itsBeamline;
177
    // delete opalRing_m;
gsell's avatar
gsell committed
178 179
}

frey_m's avatar
frey_m committed
180

181 182 183 184 185 186
/**
 *
 *
 * @param fn Base file name
 */
void ParallelCyclotronTracker::bgf_main_collision_test() {
187
    if(!bgf_m) return;
188

189
    Inform msg("bgf_main_collision_test ");
190

191
    /**
192
     *Here we check if a particle is outside the domain, flag it for deletion
193
     */
194

195
    Vector_t intecoords = 0.0;
196

197
    // This has to match the dT in the rk4 pusher
frey_m's avatar
frey_m committed
198
    double dtime = itsBunch_m->getdT() * getHarmonicNumber();
199

200
    int triId = 0;
frey_m's avatar
frey_m committed
201 202 203
    for(size_t i = 0; i < itsBunch_m->getLocalNum(); i++) {
        int res = bgf_m->partInside(itsBunch_m->R[i], itsBunch_m->P[i], dtime, itsBunch_m->PType[i], itsBunch_m->Q[i], intecoords, triId);
        //int res = bgf_m->partInside(itsBunch_m->R[i]*1.0e-3, itsBunch_m->P[i], dtime, itsBunch_m->PType[i], itsBunch_m->Q[i], intecoords, triId);
204
        if(res >= 0) {
frey_m's avatar
frey_m committed
205
            itsBunch_m->Bin[i] = -1;
206
        }
207
    }
208 209
}

210
// only used for dumping into stat file
frey_m's avatar
frey_m committed
211 212 213 214 215
void ParallelCyclotronTracker::dumpAngle(const double& theta,
                                         double& prevAzimuth,
                                         double& azimuth)
{
    if ( prevAzimuth < 0.0 ) { // only at first occurrence
frey_m's avatar
frey_m committed
216 217 218 219 220
        double plus = 0.0;
        if ( OpalData::getInstance()->inRestartRun() ) {
            plus = 360.0 * turnnumber_m;
        }
        azimuth_m = theta + plus;
221
    } else {
frey_m's avatar
frey_m committed
222
        double dtheta = theta - prevAzimuth;
223 224 225 226 227 228
        if ( dtheta < 0 ) {
            dtheta += 360.0;
        }
        if ( dtheta > 180 ) { // rotating clockwise, reduce angle
            dtheta -= 360;
        }
frey_m's avatar
frey_m committed
229
        azimuth += dtheta;
230
    }
frey_m's avatar
frey_m committed
231
    prevAzimuth = theta;
232 233 234
}


frey_m's avatar
frey_m committed
235 236 237 238 239 240
double ParallelCyclotronTracker::computeRadius(const Vector_t& meanR) const {
    // New OPAL 2.0: m --> mm
    return 1000.0 * std::sqrt(meanR(0) * meanR(0) + meanR(1) * meanR(1));
}


241 242 243 244
double ParallelCyclotronTracker::computePathLengthUpdate(const double& dt,
                                                         short bunchNr)
{
    double dotP = 0.0;
245
    if ( Options::psDumpFrame == Options::BUNCH_MEAN || isMultiBunch()) {
246 247 248 249 250 251 252 253 254 255
        for(unsigned int i = 0; i < itsBunch_m->getLocalNum(); ++i) {
            // take all particles if bunchNr <= -1
            if ( bunchNr > -1 && itsBunch_m->bunchNum[i] != bunchNr)
                continue;

            dotP += dot(itsBunch_m->P[i], itsBunch_m->P[i]);
        }

        allreduce(dotP, 1, std::plus<double>());

256
        dotP /= itsBunch_m->getTotalNumPerBunch(bunchNr);
257 258

    } else if ( itsBunch_m->getLocalNum() == 0 ) {
259
        // here we are in Options::GLOBAL mode
260 261
        return 0.0;
    } else {
262
        // here we are in Options::GLOBAL mode
263 264 265 266 267 268 269 270 271
        dotP = dot(itsBunch_m->P[0], itsBunch_m->P[0]);
    }

    double const gamma = std::sqrt(1.0 + dotP);
    double const beta  = std::sqrt(dotP) / gamma;
    return c_mmtns * dt * 1.0e-3 * beta; // unit: m
}


272

gsell's avatar
gsell committed
273 274 275 276 277
/**
 *
 *
 * @param fn Base file name
 */
278
void ParallelCyclotronTracker::openFiles(size_t numFiles, std::string SfileName) {
gsell's avatar
gsell committed
279

280
    for (unsigned int i=0; i<numFiles; i++) {
281 282 283 284 285 286 287 288
        std::string SfileName2 = SfileName;
        if (i<=2) {
            SfileName2 += std::string("-Angle" + std::to_string(int(i)) + ".dat");
        }
        else {
            // for single Particle Mode, output after each turn, to define matched initial phase ellipse.
            SfileName2 += std::string("-afterEachTurn.dat");
        }
gsell's avatar
gsell committed
289

290 291 292 293 294 295
        outfTheta_m.emplace_back(new std::ofstream(SfileName2.c_str()));
        outfTheta_m.back()->precision(8);
        outfTheta_m.back()->setf(std::ios::scientific, std::ios::floatfield);
        *outfTheta_m.back() << "# r [mm]        beta_r*gamma       "
                            << "theta [deg]     beta_theta*gamma        "
                            << "z [mm]          beta_z*gamma" << std::endl;
296
    }
gsell's avatar
gsell committed
297 298 299 300 301 302 303 304
}

/**
 * Close all files related to
 * special output in the Cyclotron
 * mode.
 */
void ParallelCyclotronTracker::closeFiles() {
305
    for (auto & file : outfTheta_m) {
306
        file->close();
307
    }
gsell's avatar
gsell committed
308 309
}

310
/**
311 312 313
 *
 * @param ring
 */
kraus's avatar
kraus committed
314
void ParallelCyclotronTracker::visitRing(const Ring &ring) {
Daniel Winklehner's avatar
Daniel Winklehner committed
315

316
    *gmsg << "* ----------------------------- Adding Ring ------------------------------ *" << endl;
Daniel Winklehner's avatar
Daniel Winklehner committed
317

snuverink_j's avatar
snuverink_j committed
318
    delete opalRing_m;
Daniel Winklehner's avatar
Daniel Winklehner committed
319

kraus's avatar
kraus committed
320
    opalRing_m = dynamic_cast<Ring*>(ring.clone());
Daniel Winklehner's avatar
Daniel Winklehner committed
321

322
    myElements.push_back(opalRing_m);
Daniel Winklehner's avatar
Daniel Winklehner committed
323

frey_m's avatar
frey_m committed
324
    opalRing_m->initialise(itsBunch_m);
325 326 327 328

    referenceR = opalRing_m->getBeamRInit();
    referencePr = opalRing_m->getBeamPRInit();
    referenceTheta = opalRing_m->getBeamPhiInit();
Daniel Winklehner's avatar
Daniel Winklehner committed
329

330
    if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
kraus's avatar
kraus committed
331
        throw OpalException("Error in ParallelCyclotronTracker::visitRing",
332 333
                            "PHIINIT is out of [-180, 180)!");
    }
Daniel Winklehner's avatar
Daniel Winklehner committed
334 335

    referenceZ = 0.0;
336
    referencePz = 0.0;
Daniel Winklehner's avatar
Daniel Winklehner committed
337 338 339 340

    referencePtot = itsReference.getGamma() * itsReference.getBeta();
    referencePt = sqrt(referencePtot * referencePtot - referencePr * referencePr);

341 342
    if(referencePtot < 0.0)
        referencePt *= -1.0;
Daniel Winklehner's avatar
Daniel Winklehner committed
343

344 345
    sinRefTheta_m = sin(referenceTheta * Physics::deg2rad);
    cosRefTheta_m = cos(referenceTheta * Physics::deg2rad);
gsell's avatar
gsell committed
346

snuverink_j's avatar
snuverink_j committed
347
    double BcParameter[8] = {}; // zero initialise array
Daniel Winklehner's avatar
Daniel Winklehner committed
348

349
    buildupFieldList(BcParameter, ElementBase::RING, opalRing_m);
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365

    // Finally print some diagnostic
    *gmsg << "* Initial beam radius = " << referenceR << " [mm] " << endl;
    *gmsg << "* Initial gamma = " << itsReference.getGamma() << endl;
    *gmsg << "* Initial beta = " << itsReference.getBeta() << endl;
    *gmsg << "* Total reference momentum   = " << referencePtot * 1000.0
          << " [MCU]" << endl;
    *gmsg << "* Reference azimuthal momentum  = " << referencePt * 1000.0
          << " [MCU]" << endl;
    *gmsg << "* Reference radial momentum     = " << referencePr * 1000.0
          << " [MCU]" << endl;
    *gmsg << "* " << opalRing_m->getSymmetry() << " fold field symmetry "
          << endl;
    *gmsg << "* Harmonic number h= " << opalRing_m->getHarmonicNumber() << " "
          << endl;
}
gsell's avatar
gsell committed
366 367 368 369 370 371 372 373

/**
 *
 *
 * @param cycl
 */
void ParallelCyclotronTracker::visitCyclotron(const Cyclotron &cycl) {

374
    *gmsg << "* -------------------------- Adding Cyclotron ---------------------------- *" << endl;
gsell's avatar
gsell committed
375

376 377
    Cyclotron *elptr = dynamic_cast<Cyclotron *>(cycl.clone());
    myElements.push_back(elptr);
378

379
    // Is this a Spiral Inflector Simulation? If yes, we'll give the user some
380 381 382 383 384 385
    // useful information
    spiral_flag = elptr->getSpiralFlag();

    if(spiral_flag) {

        *gmsg << endl << "* This is a Spiral Inflector Simulation! This means the following:" << endl;
386
        *gmsg         << "* 1.) It is up to the user to provide appropriate geometry, electric and magnetic fields!" << endl;
387 388
        *gmsg         << "*     (Use BANDRF type cyclotron and use RFMAPFN to load both magnetic" << endl;
        *gmsg         << "*     and electric fields, setting SUPERPOSE to an array of TRUE values.)" << endl;
snuverink_j's avatar
snuverink_j committed
389
        *gmsg         << "* 2.) For high currents it is strongly recommended to use the SAAMG fieldsolver," << endl;
390 391
        *gmsg         << "*     FFT does not give the correct results (boundary conditions are missing)." << endl;
        *gmsg         << "* 3.) The whole geometry will be meshed and used for the fieldsolver." << endl;
392 393
        *gmsg         << "*     There will be no transformations of the bunch into a local frame und consequently," << endl;
        *gmsg         << "*     the problem will be treated non-relativistically!" << endl;
394 395 396
        *gmsg         << "*     (This is not an issue for spiral inflectors as they are typically < 100 keV/amu.)" << endl;
        *gmsg << endl << "* Note: For now, multi-bunch mode (MBM) needs to be de-activated for spiral inflector" << endl;
        *gmsg         << "* and space charge needs to be solved every time-step. numBunch_m and scSolveFreq are reset." << endl;
frey_m's avatar
frey_m committed
397 398 399
        if (isMultiBunch()) {
            mbHandler_m = nullptr;
        }
400 401
    }

402
    // Fresh run (no restart):
403
    if(!OpalData::getInstance()->inRestartRun()) {
404

405
        // Get reference values from cyclotron element
406
        // For now, these are still stored in mm. should be the only ones. -DW
407 408 409 410
        referenceR     = elptr->getRinit();
        referenceTheta = elptr->getPHIinit();
        referenceZ     = elptr->getZinit();
        referencePr    = elptr->getPRinit();
411 412
        referencePz    = elptr->getPZinit();

413
        if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
414 415
            throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                "PHIINIT is out of [-180, 180)!");
416 417 418 419 420
        }

        referencePtot =  itsReference.getGamma() * itsReference.getBeta();

        // Calculate reference azimuthal (tangential) momentum from total-, z- and radial momentum:
421
        float insqrt = referencePtot * referencePtot - \
422
            referencePr * referencePr - referencePz * referencePz;
423 424 425 426 427

        if(insqrt < 0) {

            if(insqrt > -1.0e-10) {

428
                referencePt = 0.0;
429 430 431

            } else {

432
                throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
433
                                    "Pt imaginary!");
434 435 436 437 438 439 440
            }

        } else {

            referencePt = sqrt(insqrt);
        }

441
        if(referencePtot < 0.0)
Daniel Winklehner's avatar
Daniel Winklehner committed
442
            referencePt *= -1.0;
443 444
        // End calculate referencePt

445
        // Restart a run:
446 447
    } else {

448
        // If the user wants to save the restarted run in local frame,
449
        // make sure the previous h5 file was local too
450
      if (Options::psDumpFrame != Options::GLOBAL) {
winklehner_d's avatar
-DW  
winklehner_d committed
451
        if (!previousH5Local) {
452 453
                throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                    "You are trying a local restart from a global h5 file!");
winklehner_d's avatar
-DW  
winklehner_d committed
454
        }
455 456
            // Else, if the user wants to save the restarted run in global frame,
            // make sure the previous h5 file was global too
winklehner_d's avatar
-DW  
winklehner_d committed
457 458
      } else {
        if (previousH5Local) {
459 460
                throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                    "You are trying a global restart from a local h5 file!");
461
            }
462
        }
463

464
        // Adjust some of the reference variables from the h5 file
465 466
        referencePhi *= Physics::deg2rad;
        referencePsi *= Physics::deg2rad;
467
        referencePtot = bega;
468
        if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
469
            throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
470 471
                                "PHIINIT is out of [-180, 180)!");
        }
472 473
    }

474 475
    sinRefTheta_m = sin(referenceTheta * Physics::deg2rad);
    cosRefTheta_m = cos(referenceTheta * Physics::deg2rad);
476

477
    *gmsg << endl;
adelmann's avatar
adelmann committed
478
    *gmsg << "* Bunch global starting position:" << endl;
479 480
    *gmsg << "* RINIT = " << referenceR  << " [mm]" << endl;
    *gmsg << "* PHIINIT = " << referenceTheta << " [deg]" << endl;
481
    *gmsg << "* ZINIT = " << referenceZ << " [mm]" << endl;
482
    *gmsg << endl;
adelmann's avatar
adelmann committed
483
    *gmsg << "* Bunch global starting momenta:" << endl;
gsell's avatar
gsell committed
484 485
    *gmsg << "* Initial gamma = " << itsReference.getGamma() << endl;
    *gmsg << "* Initial beta = " << itsReference.getBeta() << endl;
486
    *gmsg << "* Reference total momentum (beta * gamma) = " << referencePtot * 1000.0 << " [MCU]" << endl;
487 488 489
    *gmsg << "* Reference azimuthal momentum (Pt) = " << referencePt * 1000.0 << " [MCU]" << endl;
    *gmsg << "* Reference radial momentum (Pr) = " << referencePr * 1000.0 << " [MCU]" << endl;
    *gmsg << "* Reference axial momentum (Pz) = " << referencePz * 1000.0 << " [MCU]" << endl;
490
    *gmsg << endl;
adelmann's avatar
adelmann committed
491

gsell's avatar
gsell committed
492
    double sym = elptr->getSymmetry();
snuverink_j's avatar
snuverink_j committed
493
    *gmsg << "* " << sym << "-fold field symmetry " << endl;
gsell's avatar
gsell committed
494

495 496 497
    // ckr: this just returned the default value as defined in Component.h
    // double rff = elptr->getRfFrequ();
    // *gmsg << "* Rf frequency= " << rff << " [MHz]" << endl;
gsell's avatar
gsell committed
498

499
    std::string fmfn = elptr->getFieldMapFN();
500
    *gmsg << "* Field map file name = " << fmfn << " " << endl;
gsell's avatar
gsell committed
501

502
    std::string type = elptr->getCyclotronType();
503
    *gmsg << "* Type of cyclotron = " << type << " " << endl;
504

505 506
    double rmin = elptr->getMinR();
    double rmax = elptr->getMaxR();
adelmann's avatar
adelmann committed
507
    *gmsg << "* Radial aperture = " << rmin << " ... " << rmax<<" [m] "<< endl;
508 509 510

    double zmin = elptr->getMinZ();
    double zmax = elptr->getMaxZ();
adelmann's avatar
adelmann committed
511
    *gmsg << "* Vertical aperture = " << zmin << " ... " << zmax<<" [m]"<< endl;
gsell's avatar
gsell committed
512 513

    double h = elptr->getCyclHarm();
514
    *gmsg << "* Number of trimcoils = " << elptr->getNumberOfTrimcoils() << endl;
515
    *gmsg << "* Harmonic number h = " << h << " " << endl;
516

gsell's avatar
gsell committed
517 518 519 520 521 522 523
    /**
     * To ease the initialise() function, set a integral parameter fieldflag internally.
     * Its value is  by the option "TYPE" of the element  "CYCLOTRON"
     * fieldflag = 1, readin PSI format measured field file (default)
     * fieldflag = 2, readin carbon cyclotron field file created by Jianjun Yang, TYPE=CARBONCYCL
     * fieldflag = 3, readin ANSYS format file for CYCIAE-100 created by Jianjun Yang, TYPE=CYCIAE
     * fieldflag = 4, readin AVFEQ format file for Riken cyclotrons
ext-rogers_c's avatar
ext-rogers_c committed
524
     * fieldflag = 5, readin FFA format file for MSU/FNAL FFA
gsell's avatar
gsell committed
525
     * fieldflag = 6, readin both median plane B field map and 3D E field map of RF cavity for compact cyclotron
526
     * fieldflag = 7, read in fields for Daniel's synchrocyclotron simulations
gsell's avatar
gsell committed
527
     */
528
    int fieldflag = elptr->getFieldFlag(type);
gsell's avatar
gsell committed
529

530
    // Read in cyclotron field maps (midplane + 3D fields if desired).
frey_m's avatar
frey_m committed
531
    elptr->initialise(itsBunch_m, fieldflag, elptr->getBScale());
gsell's avatar
gsell committed
532

snuverink_j's avatar
snuverink_j committed
533
    double BcParameter[8] = {};
534

535 536
    BcParameter[0] = 0.001 * elptr->getRmin();
    BcParameter[1] = 0.001 * elptr->getRmax();
gsell's avatar
gsell committed
537

538
    // Store inner radius and outer radius of cyclotron field map in the list
539
    buildupFieldList(BcParameter, ElementBase::CYCLOTRON, elptr);
gsell's avatar
gsell committed
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
}

/**
 * Not implemented and most probable never used
 *
 */
void ParallelCyclotronTracker::visitBeamBeam(const BeamBeam &) {
    *gmsg << "In BeamBeam tracker is missing " << endl;
}

/**
 *
 *
 * @param coll
 */
555
void ParallelCyclotronTracker::visitCCollimator(const CCollimator &coll) {
gsell's avatar
gsell committed
556

557
    *gmsg << "* --------- Collimator -----------------------------" << endl;
gsell's avatar
gsell committed
558

559
    CCollimator* elptr = dynamic_cast<CCollimator *>(coll.clone());
560
    myElements.push_back(elptr);
gsell's avatar
gsell committed
561

562
    double xstart = elptr->getXStart();
adelmann's avatar
adelmann committed
563
    *gmsg << "* Xstart= " << xstart << " [mm]" << endl;
gsell's avatar
gsell committed
564

565
    double xend = elptr->getXEnd();
adelmann's avatar
adelmann committed
566
    *gmsg << "* Xend= " << xend << " [mm]" << endl;
gsell's avatar
gsell committed
567

568
    double ystart = elptr->getYStart();
adelmann's avatar
adelmann committed
569
    *gmsg << "* Ystart= " << ystart << " [mm]" << endl;
gsell's avatar
gsell committed
570

571
    double yend = elptr->getYEnd();
572
    *gmsg << "* Yend= " << yend << " [mm]" << endl;
gsell's avatar
gsell committed
573

574
    double zstart = elptr->getZStart();
adelmann's avatar
adelmann committed
575
    *gmsg << "* Zstart= " << zstart << " [mm]" << endl;
576 577

    double zend = elptr->getZEnd();
578
    *gmsg << "* Zend= " << zend << " [mm]" << endl;
579

580
    double width = elptr->getWidth();
adelmann's avatar
adelmann committed
581
    *gmsg << "* Width= " << width << " [mm]" << endl;
gsell's avatar
gsell committed
582

frey_m's avatar
frey_m committed
583
    elptr->initialise(itsBunch_m);
gsell's avatar
gsell committed
584

snuverink_j's avatar
snuverink_j committed
585
    double BcParameter[8] = {};
586

587 588 589 590 591 592
    BcParameter[0] = 0.001 * xstart ;
    BcParameter[1] = 0.001 * xend;
    BcParameter[2] = 0.001 * ystart ;
    BcParameter[3] = 0.001 * yend;
    BcParameter[4] = 0.001 * width ;

593
    buildupFieldList(BcParameter, ElementBase::CCOLLIMATOR, elptr);
gsell's avatar
gsell committed
594 595 596 597 598 599 600 601 602 603 604 605
}

/**
 *
 *
 * @param corr
 */
void ParallelCyclotronTracker::visitCorrector(const Corrector &corr) {
    *gmsg << "In Corrector; L= " << corr.getElementLength() << endl;
    myElements.push_back(dynamic_cast<Corrector *>(corr.clone()));
}

adelmann's avatar
adelmann committed
606 607 608 609 610 611 612 613 614 615 616 617
/**
 *
 *
 * @param degrader
 */
void ParallelCyclotronTracker::visitDegrader(const Degrader &deg) {
    *gmsg << "In Degrader; L= " << deg.getElementLength() << endl;
    myElements.push_back(dynamic_cast<Degrader *>(deg.clone()));

}


gsell's avatar
gsell committed
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
/**
 *
 *
 * @param diag
 */
void ParallelCyclotronTracker::visitDiagnostic(const Diagnostic &diag) {
    *gmsg << "In Diagnostic; L= " << diag.getElementLength() << endl;
    myElements.push_back(dynamic_cast<Diagnostic *>(diag.clone()));
}

/**
 *
 *
 * @param drift
 */
void ParallelCyclotronTracker::visitDrift(const Drift &drift) {
    *gmsg << "In drift L= " << drift.getElementLength() << endl;
    myElements.push_back(dynamic_cast<Drift *>(drift.clone()));
}

638 639
/**
 *
640 641
 *
 *  @param
642 643 644 645 646
 */
void ParallelCyclotronTracker::visitFlexibleCollimator(const FlexibleCollimator &) {

}

gsell's avatar
gsell committed
647 648 649 650 651 652 653 654 655 656
/**
 *
 *
 * @param lamb
 */
void ParallelCyclotronTracker::visitLambertson(const Lambertson &lamb) {
    *gmsg << "In Lambertson; L= " << lamb.getElementLength() << endl;
    myElements.push_back(dynamic_cast<Lambertson *>(lamb.clone()));
}

657 658 659
void ParallelCyclotronTracker::visitOffset(const Offset & off) {
    if (opalRing_m == NULL)
        throw OpalException(
660 661
                            "ParallelCylcotronTracker::visitOffset",
                            "Attempt to place an offset when Ring not defined");
662 663
    Offset* offNonConst = const_cast<Offset*>(&off);
    offNonConst->updateGeometry(opalRing_m->getNextPosition(),
664
                                opalRing_m->getNextNormal());
665 666 667
    opalRing_m->appendElement(off);
}

gsell's avatar
gsell committed
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699
/**
 *
 *
 * @param marker
 */
void ParallelCyclotronTracker::visitMarker(const Marker &marker) {
    //   *gmsg << "In Marker; L= " << marker.getElementLength() << endl;
    myElements.push_back(dynamic_cast<Marker *>(marker.clone()));
    // Do nothing.
}

/**
 *
 *
 * @param corr
 */
void ParallelCyclotronTracker::visitMonitor(const Monitor &corr) {
    //   *gmsg << "In Monitor; L= " << corr.getElementLength() << endl;
    myElements.push_back(dynamic_cast<Monitor *>(corr.clone()));
    //   applyDrift(flip_s * corr.getElementLength());
}

/**
 *
 *
 * @param mult
 */
void ParallelCyclotronTracker::visitMultipole(const Multipole &mult) {
    *gmsg << "In Multipole; L= " << mult.getElementLength() << " however the element is missing " << endl;
    myElements.push_back(dynamic_cast<Multipole *>(mult.clone()));
}

ext-rogers_c's avatar
ext-rogers_c committed
700 701 702 703 704 705 706
/**
 *
 *
 * @param multT
 */
void ParallelCyclotronTracker::visitMultipoleT(const MultipoleT &multT) {
    *gmsg << "Adding MultipoleT" << endl;
707
    if (opalRing_m != NULL) {
ext-rogers_c's avatar
ext-rogers_c committed
708
        opalRing_m->appendElement(multT);
709
    } else {
ext-rogers_c's avatar
ext-rogers_c committed
710 711
        throw OpalException("ParallelCyclotronTracker::visitMultipoleT",
                            "Need to define a RINGDEFINITION to use MultipoleT element");
712
    }
ext-rogers_c's avatar
ext-rogers_c committed
713 714 715
    myElements.push_back(dynamic_cast<MultipoleT *>(multT.clone()));
}

716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
/**
 *
 *
 * @param multTstraight
 */
void ParallelCyclotronTracker::visitMultipoleTStraight(const MultipoleTStraight &multTstraight) {
    *gmsg << "Adding MultipoleTStraight" << endl;
    if (opalRing_m != NULL) {
        opalRing_m->appendElement(multTstraight);
    } else {
        throw OpalException("ParallelCyclotronTracker::visitMultipoleTStraight",
                            "Need to define a RINGDEFINITION to use MultipoleTStraight element");
    }
    myElements.push_back(dynamic_cast<MultipoleTStraight *>(multTstraight.clone()));
}

/**
 *
 *
 * @param multTccurv
 */
void ParallelCyclotronTracker::visitMultipoleTCurvedConstRadius(const MultipoleTCurvedConstRadius &multTccurv) {
    *gmsg << "Adding MultipoleTCurvedConstRadius" << endl;
    if (opalRing_m != NULL) {
        opalRing_m->appendElement(multTccurv);
    } else {
        throw OpalException("ParallelCyclotronTracker::visitMultipoleTCurvedConstRadius",
                            "Need to define a RINGDEFINITION to use MultipoleTCurvedConstRadius element");
    }
    myElements.push_back(dynamic_cast<MultipoleTCurvedConstRadius *>(multTccurv.clone()));
}

/**
 *
 *
 * @param multTvcurv
 */
void ParallelCyclotronTracker::visitMultipoleTCurvedVarRadius(const MultipoleTCurvedVarRadius &multTvcurv) {
    *gmsg << "Adding MultipoleTCurvedVarRadius" << endl;
    if (opalRing_m != NULL) {
        opalRing_m->appendElement(multTvcurv);
    } else {
        throw OpalException("ParallelCyclotronTracker::visitMultipoleTCurvedVarRadius",
                            "Need to define a RINGDEFINITION to use MultipoleTCurvedVarRadius element");
    }
    myElements.push_back(dynamic_cast<MultipoleTCurvedVarRadius *>(multTvcurv.clone()));
}

gsell's avatar
gsell committed
764 765 766 767 768 769
/**
 *
 *
 * @param prob
 */
void ParallelCyclotronTracker::visitProbe(const Probe &prob) {
770
    *gmsg << "* -----------  Probe -------------------------------" << endl;
771 772
    Probe *elptr = dynamic_cast<Probe *>(prob.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
773

774
    double xstart = elptr->getXStart();
775
    *gmsg << "XStart= " << xstart << " [mm]" << endl;
gsell's avatar
gsell committed
776

777
    double xend = elptr->getXEnd();
778
    *gmsg << "XEnd= " << xend << " [mm]" << endl;
gsell's avatar
gsell committed
779

780
    double ystart = elptr->getYStart();
781
    *gmsg << "YStart= " << ystart << " [mm]" << endl;
gsell's avatar
gsell committed
782

783
    double yend = elptr->getYEnd();
784
    *gmsg << "YEnd= " << yend << " [mm]" << endl;
gsell's avatar
gsell committed
785 786

    // initialise, do nothing
frey_m's avatar
frey_m committed
787
    elptr->initialise(itsBunch_m);
gsell's avatar
gsell committed
788

snuverink_j's avatar
snuverink_j committed
789
    double BcParameter[8] = {};
790

791 792 793 794
    BcParameter[0] = 0.001 * xstart ;
    BcParameter[1] = 0.001 * xend;
    BcParameter[2] = 0.001 * ystart ;
    BcParameter[3] = 0.001 * yend;
795
    BcParameter[4] = 0.001 ; // width
gsell's avatar
gsell committed
796 797

    // store probe parameters in the list
798
    buildupFieldList(BcParameter, ElementBase::PROBE, elptr);
gsell's avatar
gsell committed
799 800 801 802 803 804 805 806 807 808 809 810
}

/**
 *
 *
 * @param bend
 */
void ParallelCyclotronTracker::visitRBend(const RBend &bend) {
    *gmsg << "In RBend; L= " << bend.getElementLength() << " however the element is missing " << endl;
    myElements.push_back(dynamic_cast<RBend *>(bend.clone()));
}

811 812 813 814 815 816
void ParallelCyclotronTracker::visitSBend3D(const SBend3D &bend) {
    *gmsg << "Adding SBend3D" << endl;
    if (opalRing_m != NULL)
        opalRing_m->appendElement(bend);
    else
        throw OpalException("ParallelCyclotronTracker::visitSBend3D",
817
                            "Need to define a RINGDEFINITION to use SBend3D element");
818 819
}

ext-rogers_c's avatar
ext-rogers_c committed
820 821
void ParallelCyclotronTracker::visitScalingFFAMagnet(const ScalingFFAMagnet &bend) {
    *gmsg << "Adding ScalingFFAMagnet" << endl;
ext-rogers_c's avatar
ext-rogers_c committed
822
    if (opalRing_m != NULL) {
823
        opalRing_m->appendElement(bend);
ext-rogers_c's avatar
ext-rogers_c committed
824
    } else {
ext-rogers_c's avatar
ext-rogers_c committed
825 826
        throw OpalException("ParallelCyclotronTracker::visitScalingFFAMagnet",
                            "Need to define a RINGDEFINITION to use ScalingFFAMagnet element");
ext-rogers_c's avatar
ext-rogers_c committed
827
    }
828 829
}

830 831 832 833 834 835
void ParallelCyclotronTracker::visitVariableRFCavity(const VariableRFCavity &cav) {
    *gmsg << "Adding Variable RF Cavity" << endl;
    if (opalRing_m != NULL)
        opalRing_m->appendElement(cav);
    else
        throw OpalException("ParallelCyclotronTracker::visitVariableRFCavity",
836
                            "Need to define a RINGDEFINITION to use VariableRFCavity element");
837 838 839 840 841 842 843 844 845 846
}

void ParallelCyclotronTracker::visitVariableRFCavityFringeField
                                  (const VariableRFCavityFringeField &cav) {
    *gmsg << "Adding Variable RF Cavity with Fringe Field" << endl;
    if (opalRing_m != NULL)
        opalRing_m->appendElement(cav);
    else
        throw OpalException("ParallelCyclotronTracker::visitVariableRFCavityFringeField",
                            "Need to define a RINGDEFINITION to use VariableRFCavity element");
847 848
}

gsell's avatar
gsell committed
849 850 851 852 853 854 855 856
/**
 *
 *
 * @param as
 */
void ParallelCyclotronTracker::visitRFCavity(const RFCavity &as) {

    *gmsg << "* --------- RFCavity ------------------------------" << endl;
857

858 859
    RFCavity *elptr = dynamic_cast<RFCavity *>(as.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
860 861 862 863 864 865 866

    if((elptr->getComponentType() != "SINGLEGAP") && (elptr->getComponentType() != "DOUBLEGAP")) {
        *gmsg << (elptr->getComponentType()) << endl;
        throw OpalException("ParallelCyclotronTracker::visitRFCavity",
                            "The ParallelCyclotronTracker can only play with cyclotron type RF system currently ...");
    }

867
    double rmin = elptr->getRmin();
gsell's avatar
gsell committed
868 869
    *gmsg << "* Minimal radius of cavity= " << rmin << " [mm]" << endl;

870
    double rmax = elptr->getRmax();
gsell's avatar
gsell committed
871 872
    *gmsg << "* Maximal radius of cavity= " << rmax << " [mm]" << endl;

873
    double rff = elptr->getCycFrequency();
gsell's avatar
gsell committed
874 875
    *gmsg << "* RF frequency (2*pi*f)= " << rff << " [rad/s]" << endl;

876
    std::string fmfn = elptr->getFieldMapFN();
gsell's avatar
gsell committed
877
    *gmsg << "* RF Field map file name= " << fmfn << endl;
878

879
    double angle = elptr->getAzimuth();
gsell's avatar
gsell committed
880 881
    *gmsg << "* Cavity azimuth position= " << angle << " [deg] " << endl;

882
    double gap = elptr->getGapWidth();
gsell's avatar
gsell committed
883 884
    *gmsg << "* Cavity gap width= " << gap << " [mm] " << endl;

885
    double pdis = elptr->getPerpenDistance();
gsell's avatar
gsell committed
886 887
    *gmsg << "* Cavity Shift distance= " << pdis << " [mm] " << endl;

888
    double phi0 = elptr->getPhi0();
gsell's avatar
gsell committed
889 890
    *gmsg << "* Initial RF phase (t=0)= " << phi0 << " [deg] " << endl;

891 892 893
    /*
      Setup time dependence and in case of no
      timedependence use a polynom with  a_0 = 1 and a_k = 0, k = 1,2,3.
894
    */
895

896 897 898 899
    std::shared_ptr<AbstractTimeDependence> freq_atd = nullptr;
    std::shared_ptr<AbstractTimeDependence> ampl_atd = nullptr;
    std::shared_ptr<AbstractTimeDependence> phase_atd = nullptr;

900
    dvector_t  unityVec;
901 902 903 904
    unityVec.push_back(1.);
    unityVec.push_back(0.);
    unityVec.push_back(0.);
    unityVec.push_back(0.);
905

906
    if (elptr->getFrequencyModelName() != "") {
907 908
        freq_atd = AbstractTimeDependence::getTimeDependence(elptr->getFrequencyModelName());
        *gmsg << "* Variable frequency RF Model name " << elptr->getFrequencyModelName() << endl;
909
    }
910 911
    else
        freq_atd = std::shared_ptr<AbstractTimeDependence>(new PolynomialTimeDependence(unityVec));
912 913

    if (elptr->getAmplitudeModelName() != "") {
914 915
        ampl_atd = AbstractTimeDependence::getTimeDependence(elptr->getAmplitudeModelName());
        *gmsg << "* Variable amplitude RF Model name " << elptr->getAmplitudeModelName() << endl;
916
    }
917 918
    else
        ampl_atd = std::shared_ptr<AbstractTimeDependence>(new PolynomialTimeDependence(unityVec));
919 920

    if (elptr->getPhaseModelName() != "") {
921 922
        phase_atd = AbstractTimeDependence::getTimeDependence(elptr->getPhaseModelName());
        *gmsg << "* Variable phase RF Model name " << elptr->getPhaseModelName() << endl;