ParallelCyclotronTracker.cpp 129 KB
Newer Older
gsell's avatar
gsell committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// ------------------------------------------------------------------------
// $RCSfile: ParallelCyclotronTracker.cpp,v $
// ------------------------------------------------------------------------
// $Revision: 1.1 $initialLocalNum_m
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: ParallelCyclotronTracker
//   The class for tracking particles with 3D space charge in Cyclotrons and FFAG's
//
// ------------------------------------------------------------------------
//
// $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 21
#include "Algorithms/PolynomialTimeDependence.h"
#include "Elements/OpalPolynomialTimeDependence.h"
22

gsell's avatar
gsell committed
23 24 25 26
#include <cfloat>
#include <iostream>
#include <fstream>
#include <vector>
27
#include "AbstractObjects/OpalData.h"
gsell's avatar
gsell committed
28

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

62 63
#include "AbstractObjects/Element.h"

64
#include "Beamlines/FlaggedBeamline.h"
65
#include "Elements/OpalBeamline.h"
kraus's avatar
kraus committed
66
#include "AbsBeamline/Ring.h"
gsell's avatar
gsell committed
67 68 69

#include "BeamlineGeometry/Euclid3D.h"
#include "BeamlineGeometry/PlanarArcGeometry.h"
Jianjun Yang's avatar
Jianjun Yang committed
70
#include "BeamlineGeometry/RBendGeometry.h"
ext-rogers_c's avatar
ext-rogers_c committed
71
#include "BeamlineGeometry/StraightGeometry.h"
gsell's avatar
gsell committed
72 73 74 75 76 77 78 79 80 81
#include "Beamlines/Beamline.h"

#include "Fields/BMultipoleField.h"
#include "FixedAlgebra/FTps.h"
#include "FixedAlgebra/FTpsMath.h"
#include "FixedAlgebra/FVps.h"

#include "Physics/Physics.h"

#include "Utilities/OpalException.h"
82
#include "Utilities/Options.h"
gsell's avatar
gsell committed
83

84
#include "BasicActions/DumpFields.h"
85
#include "BasicActions/DumpEMFields.h"
86

87
#include "Structure/H5PartWrapperForPC.h"
88
#include "Structure/BoundaryGeometry.h"
gsell's avatar
gsell committed
89

90
#include "Algorithms/Ctunes.h"
gsell's avatar
gsell committed
91 92 93 94 95
#include <cassert>

#include <hdf5.h>
#include "H5hut.h"

frey_m's avatar
frey_m committed
96 97
//FIXME Remove headers and dynamic_cast in readOneBunchFromFile
#include "Algorithms/PartBunch.h"
98
#ifdef ENABLE_AMR
frey_m's avatar
frey_m committed
99 100
    #include "Algorithms/AmrPartBunch.h"
#endif
frey_m's avatar
frey_m committed
101

gsell's avatar
gsell committed
102 103
class Beamline;
class PartData;
104

gsell's avatar
gsell committed
105 106 107
using Physics::pi;
using Physics::q_e;

108

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

111 112 113
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
114

snuverink_j's avatar
snuverink_j committed
115
//#define PSdim 6
gsell's avatar
gsell committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129

extern Inform *gmsg;

// typedef FVector<double, PSdim> Vector;

/**
 * Constructor ParallelCyclotronTracker
 *
 * @param beamline
 * @param reference
 * @param revBeam
 * @param revTrack
 */
ParallelCyclotronTracker::ParallelCyclotronTracker(const Beamline &beamline,
130
                                                   const PartData &reference,
frey_m's avatar
frey_m committed
131 132 133 134 135
                                                   bool revBeam, bool revTrack)
    : Tracker(beamline, reference, revBeam, revTrack)
    , itsDataSink(nullptr)
    , itsMBDump_m(new MultiBunchDump())
    , bgf_m(nullptr)
136
    , numBunch_m(1)
frey_m's avatar
frey_m committed
137 138 139 140 141 142 143 144 145 146 147
    , lastDumpedStep_m(0)
    , eta_m(0.01)
    , myNode_m(Ippl::myNode())
    , initialLocalNum_m(0)
    , initialTotalNum_m(0)
    , onebunch_m(OpalData::getInstance()->getInputBasename() + "-onebunch.h5")
    , opalRing_m(nullptr)
    , itsStepper_mp(nullptr)
    , mode_m(MODE::UNDEFINED)
    , stepper_m(stepper::INTEGRATOR::UNDEFINED)
{
gsell's avatar
gsell committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
    itsBeamline = dynamic_cast<Beamline *>(beamline.clone());
}

/**
 * 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
164
                                                   PartBunchBase<double, 3> *bunch,
gsell's avatar
gsell committed
165 166 167
                                                   DataSink &ds,
                                                   const PartData &reference,
                                                   bool revBeam, bool revTrack,
frey_m's avatar
frey_m committed
168
                                                   int maxSTEPS, int timeIntegrator,
frey_m's avatar
frey_m committed
169
                                                   int numBunch)
frey_m's avatar
frey_m committed
170 171 172 173
    : Tracker(beamline, bunch, reference, revBeam, revTrack)
    , itsMBDump_m(new MultiBunchDump())
    , bgf_m(nullptr)
    , maxSteps_m(maxSTEPS)
174
    , numBunch_m(numBunch)
frey_m's avatar
frey_m committed
175 176 177 178 179 180 181 182 183
    , lastDumpedStep_m(0)
    , eta_m(0.01)
    , myNode_m(Ippl::myNode())
    , initialLocalNum_m(bunch->getLocalNum())
    , initialTotalNum_m(bunch->getTotalNum())
    , onebunch_m(OpalData::getInstance()->getInputBasename() + "-onebunch.h5")
    , opalRing_m(nullptr)
    , itsStepper_mp(nullptr)
{
gsell's avatar
gsell committed
184 185
    itsBeamline = dynamic_cast<Beamline *>(beamline.clone());
    itsDataSink = &ds;
frey_m's avatar
frey_m committed
186
    //  scaleFactor_m = itsBunch_m->getdT() * c;
gsell's avatar
gsell committed
187
    scaleFactor_m = 1;
188
    multiBunchMode_m = MB_MODE::NONE;
gsell's avatar
gsell committed
189 190 191 192 193

    IntegrationTimer_m = IpplTimings::getTimer("Integration");
    TransformTimer_m   = IpplTimings::getTimer("Frametransform");
    DumpTimer_m        = IpplTimings::getTimer("Dump");
    BinRepartTimer_m   = IpplTimings::getTimer("Binaryrepart");
194

195 196 197 198 199 200 201 202 203
    // 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;
204

205 206 207 208 209 210 211 212
    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
213 214 215 216 217 218 219
}

/**
 * Destructor ParallelCyclotronTracker
 *
 */
ParallelCyclotronTracker::~ParallelCyclotronTracker() {
220 221
    for(Component* component : myElements) {
        delete(component);
gsell's avatar
gsell committed
222
    }
223 224
    for(auto fd : FieldDimensions) {
        delete(fd);
gsell's avatar
gsell committed
225 226
    }
    delete itsBeamline;
227
    // delete opalRing_m;
gsell's avatar
gsell committed
228 229
}

230 231 232 233 234
/// set the working sub-mode for multi-bunch mode: "FORCE" or "AUTO"
inline
void ParallelCyclotronTracker::setMultiBunchMode(const std::string& mbmode)
{
    if ( mbmode.compare("FORCE") == 0 ) {
235 236
        *gmsg << "FORCE mode: The multi bunches will be injected consecutively" << endl
              << "            after each revolution, until get \"TURNS\" bunches." << endl;
237 238
        multiBunchMode_m = MB_MODE::FORCE;
    } else if ( mbmode.compare("AUTO") == 0 ) {
239 240 241 242
        *gmsg << "AUTO mode: The multi bunches will be injected only when the" << endl
              << "           distance between two neighboring bunches is below" << endl
              << "           the limitation. The control parameter is set to "
              << CoeffDBunches_m << endl;
243 244 245 246 247 248 249 250
        multiBunchMode_m = MB_MODE::AUTO;
    } else if ( mbmode.compare("NONE") == 0 )
        multiBunchMode_m = MB_MODE::NONE;
    else
        throw OpalException("ParallelCyclotronTracker::setMultiBunchMode()",
                            "MBMODE name \"" + mbmode + "\" unknown.");
}

frey_m's avatar
frey_m committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
void ParallelCyclotronTracker::setMultiBunchBinning(std::string binning) {
    
    binning = Util::toUpper(binning);
    
    if ( binning.compare("BUNCH") == 0 ) {
        *gmsg << "Use 'BUNCH' injection for binnning." << endl;
        binningType_m = MB_BINNING::BUNCH;
    } else if ( binning.compare("GAMMA") == 0 ) {
        *gmsg << "Use 'GAMMA' for binning." << endl;
        binningType_m = MB_BINNING::GAMMA;
    } else {
        throw OpalException("ParallelCyclotronTracker::setMultiBunchBinning()",
                            "MB_BINNING name \"" + binning + "\" unknown.");
    }
}

267 268 269 270 271 272
/**
 *
 *
 * @param fn Base file name
 */
void ParallelCyclotronTracker::bgf_main_collision_test() {
273
    if(!bgf_m) return;
274

275
    Inform msg("bgf_main_collision_test ");
276

277 278 279
    /**
     *Here we check if a particles is outside the domain, flag it for deletion
     */
280

281
    Vector_t intecoords = 0.0;
282

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

286
    int triId = 0;
frey_m's avatar
frey_m committed
287 288 289
    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);
290
        if(res >= 0) {
frey_m's avatar
frey_m committed
291
            itsBunch_m->Bin[i] = -1;
292
        }
293
    }
294 295 296
}


gsell's avatar
gsell committed
297 298 299 300 301
/**
 *
 *
 * @param fn Base file name
 */
302
void ParallelCyclotronTracker::openFiles(std::string SfileName) {
gsell's avatar
gsell committed
303

304
    std::string  SfileName2 = SfileName + std::string("-Angle0.dat");
gsell's avatar
gsell committed
305
    outfTheta0_m.precision(8);
306
    outfTheta0_m.setf(std::ios::scientific, std::ios::floatfield);
gsell's avatar
gsell committed
307
    outfTheta0_m.open(SfileName2.c_str());
308 309 310
    outfTheta0_m << "#  r [mm]      beta_r*gamma       "
                 << "theta [mm]      beta_theta*gamma        "
                 << "z [mm]          beta_z*gamma" << std::endl;
gsell's avatar
gsell committed
311

312
    SfileName2 = SfileName + std::string("-Angle1.dat");
gsell's avatar
gsell committed
313
    outfTheta1_m.precision(8);
314
    outfTheta1_m.setf(std::ios::scientific, std::ios::floatfield);
gsell's avatar
gsell committed
315
    outfTheta1_m.open(SfileName2.c_str());
316 317 318
    outfTheta1_m << "#  r [mm]      beta_r*gamma       "
                 << "theta [mm]      beta_theta*gamma        "
                 << "z [mm]          beta_z*gamma"  << std::endl;
gsell's avatar
gsell committed
319

320
    SfileName2 = SfileName + std::string("-Angle2.dat");
gsell's avatar
gsell committed
321
    outfTheta2_m.precision(8);
322
    outfTheta2_m.setf(std::ios::scientific, std::ios::floatfield);
gsell's avatar
gsell committed
323
    outfTheta2_m.open(SfileName2.c_str());
324 325 326
    outfTheta2_m << "#  r [mm]      beta_r*gamma       "
                 << "theta [mm]      beta_theta*gamma        "
                 << "z [mm]          beta_z*gamma"  << std::endl;
gsell's avatar
gsell committed
327 328 329

    // for single Particle Mode, output after each turn, to define matched initial phase ellipse.

330
    SfileName2 = SfileName + std::string("-afterEachTurn.dat");
gsell's avatar
gsell committed
331 332

    outfThetaEachTurn_m.precision(8);
333
    outfThetaEachTurn_m.setf(std::ios::scientific, std::ios::floatfield);
gsell's avatar
gsell committed
334 335

    outfThetaEachTurn_m.open(SfileName2.c_str());
336 337 338
    outfTheta2_m << "#  r [mm]      beta_r*gamma       "
                 << "theta [mm]      beta_theta*gamma        "
                 << "z [mm]          beta_z*gamma"  << std::endl;
gsell's avatar
gsell committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
}

/**
 * Close all files related to
 * special output in the Cyclotron
 * mode.
 */
void ParallelCyclotronTracker::closeFiles() {

    outfTheta0_m.close();
    outfTheta1_m.close();
    outfTheta2_m.close();
    outfThetaEachTurn_m.close();
}

354
/**
355 356 357
 *
 * @param ring
 */
kraus's avatar
kraus committed
358
void ParallelCyclotronTracker::visitRing(const Ring &ring) {
Daniel Winklehner's avatar
Daniel Winklehner committed
359

360
    *gmsg << "* ----------------------------- Adding Ring ------------------------------ *" << endl;
Daniel Winklehner's avatar
Daniel Winklehner committed
361

snuverink_j's avatar
snuverink_j committed
362
    delete opalRing_m;
Daniel Winklehner's avatar
Daniel Winklehner committed
363

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

366
    myElements.push_back(opalRing_m);
Daniel Winklehner's avatar
Daniel Winklehner committed
367

frey_m's avatar
frey_m committed
368
    opalRing_m->initialise(itsBunch_m);
369 370 371 372

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

374
    if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
kraus's avatar
kraus committed
375
        throw OpalException("Error in ParallelCyclotronTracker::visitRing",
376 377
                            "PHIINIT is out of [-180, 180)!");
    }
Daniel Winklehner's avatar
Daniel Winklehner committed
378 379

    referenceZ = 0.0;
380
    referencePz = 0.0;
Daniel Winklehner's avatar
Daniel Winklehner committed
381 382 383 384

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

385 386
    if(referencePtot < 0.0)
        referencePt *= -1.0;
Daniel Winklehner's avatar
Daniel Winklehner committed
387

388 389
    sinRefTheta_m = sin(referenceTheta * Physics::deg2rad);
    cosRefTheta_m = cos(referenceTheta * Physics::deg2rad);
gsell's avatar
gsell committed
390

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

393
    buildupFieldList(BcParameter, ElementBase::RING, opalRing_m);
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409

    // 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
410 411 412 413 414 415 416 417

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

418
    *gmsg << "* -------------------------- Adding Cyclotron ---------------------------- *" << endl;
gsell's avatar
gsell committed
419

420 421
    Cyclotron *elptr = dynamic_cast<Cyclotron *>(cycl.clone());
    myElements.push_back(elptr);
422

423
    // Is this a Spiral Inflector Simulation? If yes, we'll give the user some
424 425 426 427 428 429
    // useful information
    spiral_flag = elptr->getSpiralFlag();

    if(spiral_flag) {

        *gmsg << endl << "* This is a Spiral Inflector Simulation! This means the following:" << endl;
430
        *gmsg         << "* 1.) It is up to the user to provide appropriate geometry, electric and magnetic fields!" << endl;
431 432
        *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
433
        *gmsg         << "* 2.) For high currents it is strongly recommended to use the SAAMG fieldsolver," << endl;
434 435
        *gmsg         << "*     FFT does not give the correct results (boundaty conditions are missing)." << endl;
        *gmsg         << "* 3.) The whole geometry will be meshed and used for the fieldsolve." << endl;
436 437
        *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;
438 439 440 441 442 443 444
        *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;
        numBunch_m = 1;

    }

445
    // Fresh run (no restart):
446
    if(!OpalData::getInstance()->inRestartRun()) {
447

448
        // Get reference values from cyclotron element
449
        // For now, these are still stored in mm. should be the only ones. -DW
450 451 452 453
        referenceR     = elptr->getRinit();
        referenceTheta = elptr->getPHIinit();
        referenceZ     = elptr->getZinit();
        referencePr    = elptr->getPRinit();
454 455
        referencePz    = elptr->getPZinit();

456
        if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
457 458
            throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                "PHIINIT is out of [-180, 180)!");
459 460 461 462 463
        }

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

        // Calculate reference azimuthal (tangential) momentum from total-, z- and radial momentum:
464
        float insqrt = referencePtot * referencePtot - \
465
            referencePr * referencePr - referencePz * referencePz;
466 467 468 469 470

        if(insqrt < 0) {

            if(insqrt > -1.0e-10) {

471
                referencePt = 0.0;
472 473 474

            } else {

475
                throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
476
                                    "Pt imaginary!");
477 478 479 480 481 482 483
            }

        } else {

            referencePt = sqrt(insqrt);
        }

484
        if(referencePtot < 0.0)
Daniel Winklehner's avatar
Daniel Winklehner committed
485
            referencePt *= -1.0;
486 487
        // End calculate referencePt

488
        // Restart a run:
489 490
    } else {

491
        // If the user wants to save the restarted run in local frame,
492
        // make sure the previous h5 file was local too
493
      if (Options::psDumpFrame != Options::GLOBAL) {
winklehner_d's avatar
-DW  
winklehner_d committed
494
        if (!previousH5Local) {
495 496
                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
497
        }
498 499
            // 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
500 501
      } else {
        if (previousH5Local) {
502 503
                throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                    "You are trying a global restart from a local h5 file!");
504
            }
505
        }
506

507
        // Adjust some of the reference variables from the h5 file
508 509
        referencePhi *= Physics::deg2rad;
        referencePsi *= Physics::deg2rad;
510
        referencePtot = bega;
511
        if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
512
            throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
513 514
                                "PHIINIT is out of [-180, 180)!");
        }
515 516
    }

517 518
    sinRefTheta_m = sin(referenceTheta * Physics::deg2rad);
    cosRefTheta_m = cos(referenceTheta * Physics::deg2rad);
519

520
    *gmsg << endl;
adelmann's avatar
adelmann committed
521
    *gmsg << "* Bunch global starting position:" << endl;
522 523
    *gmsg << "* RINIT = " << referenceR  << " [mm]" << endl;
    *gmsg << "* PHIINIT = " << referenceTheta << " [deg]" << endl;
524
    *gmsg << "* ZINIT = " << referenceZ << " [mm]" << endl;
525
    *gmsg << endl;
adelmann's avatar
adelmann committed
526
    *gmsg << "* Bunch global starting momenta:" << endl;
gsell's avatar
gsell committed
527 528
    *gmsg << "* Initial gamma = " << itsReference.getGamma() << endl;
    *gmsg << "* Initial beta = " << itsReference.getBeta() << endl;
529
    *gmsg << "* Reference total momentum (beta * gamma) = " << referencePtot * 1000.0 << " [MCU]" << endl;
530 531 532
    *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;
533
    *gmsg << endl;
adelmann's avatar
adelmann committed
534

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

538 539 540
    // 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
541

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

545
    std::string type = elptr->getCyclotronType();
546
    *gmsg << "* Type of cyclotron = " << type << " " << endl;
547

548 549
    double rmin = elptr->getMinR();
    double rmax = elptr->getMaxR();
adelmann's avatar
adelmann committed
550
    *gmsg << "* Radial aperture = " << rmin << " ... " << rmax<<" [m] "<< endl;
551 552 553

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

    double h = elptr->getCyclHarm();
557
    *gmsg << "* Number of trimcoils = " << elptr->getNumberOfTrimcoils() << endl;
558
    *gmsg << "* Harmonic number h = " << h << " " << endl;
559

gsell's avatar
gsell committed
560 561 562 563 564 565 566 567 568
    /**
     * 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
     * fieldflag = 5, readin FFAG format file for MSU/FNAL FFAG
     * fieldflag = 6, readin both median plane B field map and 3D E field map of RF cavity for compact cyclotron
569
     * fieldflag = 7, read in fields for Daniel's synchrocyclotron simulations
gsell's avatar
gsell committed
570
     */
571
    int fieldflag = elptr->getFieldFlag(type);
gsell's avatar
gsell committed
572

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

snuverink_j's avatar
snuverink_j committed
576
    double BcParameter[8] = {};
577

578 579
    BcParameter[0] = 0.001 * elptr->getRmin();
    BcParameter[1] = 0.001 * elptr->getRmax();
gsell's avatar
gsell committed
580

581
    // Store inner radius and outer radius of cyclotron field map in the list
582
    buildupFieldList(BcParameter, ElementBase::CYCLOTRON, elptr);
gsell's avatar
gsell committed
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
}

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

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

600
    *gmsg << "* --------- Collimator -----------------------------" << endl;
gsell's avatar
gsell committed
601

602
    CCollimator* elptr = dynamic_cast<CCollimator *>(coll.clone());
603
    myElements.push_back(elptr);
gsell's avatar
gsell committed
604

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

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

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

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

617
    double zstart = elptr->getZStart();
adelmann's avatar
adelmann committed
618
    *gmsg << "* Zstart= " << zstart << " [mm]" << endl;
619 620

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

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

frey_m's avatar
frey_m committed
626
    elptr->initialise(itsBunch_m);
gsell's avatar
gsell committed
627

snuverink_j's avatar
snuverink_j committed
628
    double BcParameter[8] = {};
629

630 631 632 633 634 635
    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 ;

636
    buildupFieldList(BcParameter, ElementBase::CCOLLIMATOR, elptr);
gsell's avatar
gsell committed
637 638 639 640 641 642 643 644 645 646 647 648
}

/**
 *
 *
 * @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
649 650 651 652 653 654 655 656 657 658 659 660
/**
 *
 *
 * @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
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
/**
 *
 *
 * @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()));
}

681 682
/**
 *
683 684
 *
 *  @param
685 686 687 688 689
 */
void ParallelCyclotronTracker::visitFlexibleCollimator(const FlexibleCollimator &) {

}

gsell's avatar
gsell committed
690 691 692 693 694 695 696 697 698 699
/**
 *
 *
 * @param lamb
 */
void ParallelCyclotronTracker::visitLambertson(const Lambertson &lamb) {
    *gmsg << "In Lambertson; L= " << lamb.getElementLength() << endl;
    myElements.push_back(dynamic_cast<Lambertson *>(lamb.clone()));
}

700 701 702
void ParallelCyclotronTracker::visitOffset(const Offset & off) {
    if (opalRing_m == NULL)
        throw OpalException(
703 704
                            "ParallelCylcotronTracker::visitOffset",
                            "Attempt to place an offset when Ring not defined");
705 706
    Offset* offNonConst = const_cast<Offset*>(&off);
    offNonConst->updateGeometry(opalRing_m->getNextPosition(),
707
                                opalRing_m->getNextNormal());
708 709 710
    opalRing_m->appendElement(off);
}

gsell's avatar
gsell committed
711 712 713 714 715 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
/**
 *
 *
 * @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
743 744 745 746 747 748 749
/**
 *
 *
 * @param multT
 */
void ParallelCyclotronTracker::visitMultipoleT(const MultipoleT &multT) {
    *gmsg << "Adding MultipoleT" << endl;
750
    if (opalRing_m != NULL) {
ext-rogers_c's avatar
ext-rogers_c committed
751
        opalRing_m->appendElement(multT);
752
    } else {
ext-rogers_c's avatar
ext-rogers_c committed
753 754
        throw OpalException("ParallelCyclotronTracker::visitMultipoleT",
                            "Need to define a RINGDEFINITION to use MultipoleT element");
755
    }
ext-rogers_c's avatar
ext-rogers_c committed
756 757 758
    myElements.push_back(dynamic_cast<MultipoleT *>(multT.clone()));
}

759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
/**
 *
 *
 * @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
807 808 809 810 811 812
/**
 *
 *
 * @param prob
 */
void ParallelCyclotronTracker::visitProbe(const Probe &prob) {
813
    *gmsg << "* -----------  Probe -------------------------------" << endl;
814 815
    Probe *elptr = dynamic_cast<Probe *>(prob.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
816

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

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

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

826
    double yend = elptr->getYEnd();
827
    *gmsg << "YEnd= " << yend << " [mm]" << endl;
gsell's avatar
gsell committed
828 829

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

snuverink_j's avatar
snuverink_j committed
832
    double BcParameter[8] = {};
833

834 835 836 837
    BcParameter[0] = 0.001 * xstart ;
    BcParameter[1] = 0.001 * xend;
    BcParameter[2] = 0.001 * ystart ;
    BcParameter[3] = 0.001 * yend;
838
    BcParameter[4] = 0.001 ; // width
gsell's avatar
gsell committed
839 840

    // store probe parameters in the list
841
    buildupFieldList(BcParameter, ElementBase::PROBE, elptr);
gsell's avatar
gsell committed
842 843 844 845 846 847 848 849 850 851 852 853
}

/**
 *
 *
 * @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()));
}

854 855 856 857 858 859
void ParallelCyclotronTracker::visitSBend3D(const SBend3D &bend) {
    *gmsg << "Adding SBend3D" << endl;
    if (opalRing_m != NULL)
        opalRing_m->appendElement(bend);
    else
        throw OpalException("ParallelCyclotronTracker::visitSBend3D",
860
                            "Need to define a RINGDEFINITION to use SBend3D element");
861 862
}

863 864
void ParallelCyclotronTracker::visitScalingFFAGMagnet(const ScalingFFAGMagnet &bend) {
    *gmsg << "Adding ScalingFFAGMagnet" << endl;
ext-rogers_c's avatar
ext-rogers_c committed
865
    if (opalRing_m != NULL) {
866
        opalRing_m->appendElement(bend);
ext-rogers_c's avatar
ext-rogers_c committed
867
    } else {
868 869
        throw OpalException("ParallelCyclotronTracker::visitScalingFFAGMagnet",
                            "Need to define a RINGDEFINITION to use ScalingFFAGMagnet element");
ext-rogers_c's avatar
ext-rogers_c committed
870
    }
871 872
}

873 874 875 876 877 878
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",
879
                            "Need to define a RINGDEFINITION to use VariableRFCavity element");
880 881 882 883 884 885 886 887 888 889
}

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");
890 891
}

gsell's avatar
gsell committed
892 893 894 895 896 897 898 899
/**
 *
 *
 * @param as
 */
void ParallelCyclotronTracker::visitRFCavity(const RFCavity &as) {

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

901 902
    RFCavity *elptr = dynamic_cast<RFCavity *>(as.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
903 904 905 906 907 908 909

    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 ...");
    }

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

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

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

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

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

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

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

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

934 935 936
    /*
      Setup time dependence and in case of no
      timedependence use a polynom with  a_0 = 1 and a_k = 0, k = 1,2,3.
937
    */
938

939 940 941 942
    std::shared_ptr<AbstractTimeDependence> freq_atd = nullptr;
    std::shared_ptr<AbstractTimeDependence> ampl_atd = nullptr;
    std::shared_ptr<AbstractTimeDependence> phase_atd = nullptr;

943
    dvector_t  unityVec;
944 945 946 947
    unityVec.push_back(1.);
    unityVec.push_back(0.);
    unityVec.push_back(0.);
    unityVec.push_back(0.);
948

949
    if (elptr->getFrequencyModelName() != "") {
950 951
        freq_atd = AbstractTimeDependence::getTimeDependence(elptr->getFrequencyModelName());
        *gmsg << "* Variable frequency RF Model name " << elptr->getFrequencyModelName() << endl;
952
    }
953 954
    else
        freq_atd = std::shared_ptr<AbstractTimeDependence>(new PolynomialTimeDependence(unityVec));