ParallelCyclotronTracker.cpp 226 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/Ctunes.hpp>
kraus's avatar
kraus committed
20
#include "Algorithms/ParallelCyclotronTracker.h"
21 22
#include "Algorithms/PolynomialTimeDependence.h"
#include "Elements/OpalPolynomialTimeDependence.h"
23

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

#include "AbsBeamline/Collimator.h"
#include "AbsBeamline/Corrector.h"
#include "AbsBeamline/Cyclotron.h"
adelmann's avatar
adelmann committed
33
#include "AbsBeamline/Degrader.h"
gsell's avatar
gsell committed
34 35 36 37
#include "AbsBeamline/Diagnostic.h"
#include "AbsBeamline/Drift.h"
#include "AbsBeamline/ElementBase.h"
#include "AbsBeamline/Lambertson.h"
38
#include "AbsBeamline/Offset.h"
gsell's avatar
gsell committed
39 40 41 42 43 44 45 46
#include "AbsBeamline/Marker.h"
#include "AbsBeamline/Monitor.h"
#include "AbsBeamline/Multipole.h"
#include "AbsBeamline/Probe.h"
#include "AbsBeamline/RBend.h"
#include "AbsBeamline/RFCavity.h"
#include "AbsBeamline/RFQuadrupole.h"
#include "AbsBeamline/SBend.h"
47
#include "AbsBeamline/SBend3D.h"
gsell's avatar
gsell committed
48 49 50 51 52
#include "AbsBeamline/Separator.h"
#include "AbsBeamline/Septum.h"
#include "AbsBeamline/Solenoid.h"
#include "AbsBeamline/CyclotronValley.h"
#include "AbsBeamline/Stripper.h"
53
#include "AbsBeamline/VariableRFCavity.h"
54

55 56
#include "AbstractObjects/Element.h"

57
#include "Elements/OpalBeamline.h"
kraus's avatar
kraus committed
58
#include "AbsBeamline/Ring.h"
gsell's avatar
gsell committed
59 60 61

#include "BeamlineGeometry/Euclid3D.h"
#include "BeamlineGeometry/PlanarArcGeometry.h"
Jianjun Yang's avatar
Jianjun Yang committed
62
#include "BeamlineGeometry/RBendGeometry.h"
gsell's avatar
gsell committed
63 64 65 66 67 68 69 70 71 72 73 74
#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/NumToStr.h"
#include "Utilities/OpalException.h"

75 76
#include "BasicActions/DumpFields.h"

77
#include "Structure/H5PartWrapperForPC.h"
78
#include "Structure/BoundaryGeometry.h"
79
#include "Utilities/Options.h"
gsell's avatar
gsell committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

#include "Ctunes.h"
#include <cassert>

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

class Beamline;
class PartData;
using Physics::c;
using Physics::m_p; // GeV
using Physics::PMASS;
using Physics::PCHARGE;
using Physics::pi;
using Physics::q_e;

const double c_mmtns = c * 1.0e-6; // m/s --> mm/ns
const double mass_coeff = 1.0e18 * q_e / c / c; // from GeV/c^2 to basic unit: GV*C*s^2/m^2
98
const double PIOVER180 = pi / 180.0;
99

100 101 102
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
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121

#define PSdim 6

extern Inform *gmsg;

// typedef FVector<double, PSdim> Vector;

/**
 * Constructor ParallelCyclotronTracker
 *
 * @param beamline
 * @param reference
 * @param revBeam
 * @param revTrack
 */
ParallelCyclotronTracker::ParallelCyclotronTracker(const Beamline &beamline,
        const PartData &reference,
        bool revBeam, bool revTrack):
    Tracker(beamline, reference, revBeam, revTrack),
122
    eta_m(0.01),
gsell's avatar
gsell committed
123 124
    myNode_m(Ippl::myNode()),
    initialLocalNum_m(0),
125
    initialTotalNum_m(0),
126 127
    opalRing_m(NULL),
    lastDumpedStep_m(0) {
gsell's avatar
gsell committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
    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,
                                                   PartBunch &bunch,
                                                   DataSink &ds,
                                                   const PartData &reference,
                                                   bool revBeam, bool revTrack,
148
                                                   int maxSTEPS, int timeIntegrator):
gsell's avatar
gsell committed
149 150 151
    Tracker(beamline, reference, revBeam, revTrack),
    maxSteps_m(maxSTEPS),
    timeIntegrator_m(timeIntegrator),
152
    eta_m(0.01),
gsell's avatar
gsell committed
153 154
    myNode_m(Ippl::myNode()),
    initialLocalNum_m(bunch.getLocalNum()),
155
    initialTotalNum_m(bunch.getTotalNum()),
156
    opalRing_m(NULL),
157
    lastDumpedStep_m(0) {
gsell's avatar
gsell committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
    itsBeamline = dynamic_cast<Beamline *>(beamline.clone());
    itsBunch = &bunch;
    itsDataSink = &ds;
    //  scaleFactor_m = itsBunch->getdT() * c;
    scaleFactor_m = 1;
    multiBunchMode_m = 0;

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

/**
 * Destructor ParallelCyclotronTracker
 *
 */
ParallelCyclotronTracker::~ParallelCyclotronTracker() {
176
    for(std::list<Component *>::iterator compindex = myElements.begin(); compindex != myElements.end(); compindex++) {
gsell's avatar
gsell committed
177 178 179 180 181 182
        delete(*compindex);
    }
    for(beamline_list::iterator fdindex = FieldDimensions.begin(); fdindex != FieldDimensions.end(); fdindex++) {
        delete(*fdindex);
    }
    delete itsBeamline;
183 184 185
    if (opalRing_m != NULL) {
        // delete opalRing_m;
    }
gsell's avatar
gsell committed
186 187
}

188 189 190 191 192 193
/**
 * AAA
 *
 * @param none
 */
void ParallelCyclotronTracker::initializeBoundaryGeometry() {
194
  for(std::list<Component *>::iterator compindex = myElements.begin(); compindex != myElements.end(); compindex++) {
195
    bgf_m = dynamic_cast<ElementBase *>(*compindex)->getBoundaryGeometry();
196
    if(!bgf_m)
197 198 199 200
      continue;
    else
      break;
  }
adelmann's avatar
adelmann committed
201
  if (bgf_m) {
202
    itsDataSink->writeGeomToVtk(*bgf_m, std::string("data/testGeometry-00000.vtk"));
adelmann's avatar
adelmann committed
203 204 205
    OpalData::getInstance()->setGlobalGeometry(bgf_m);
    *gmsg << "* Boundary geometry initialized " << endl;
  }
206
}
207

208 209 210 211 212 213 214 215 216
/**
 *
 *
 * @param fn Base file name
 */
void ParallelCyclotronTracker::bgf_main_collision_test() {
  if(!bgf_m) return;

  Inform msg("bgf_main_collision_test ");
217 218

  /**
219 220 221
   *Here we check if a particles is outside the domain, flag it for deletion
   */

gsell's avatar
gsell committed
222
  Vector_t intecoords = 0.0;
223 224 225 226 227

  // This has to match the dT in the rk4 pusher! -DW
  //double dtime = 0.5 * itsBunch->getdT();  // Old
  double dtime = itsBunch->getdT() * getHarmonicNumber();  // New

228
  int triId = 0;
229 230
  size_t Nimpact = 0;
  for(size_t i = 0; i < itsBunch->getLocalNum(); i++) {
231
    int res = bgf_m->partInside(itsBunch->R[i]*1.0e-3, itsBunch->P[i], dtime, itsBunch->PType[i], itsBunch->Q[i], intecoords, triId);
232
    if(res >= 0) {
233 234
      itsBunch->Bin[i] = -1;
      Nimpact++;
235
    }
236 237 238 239
  }
}


gsell's avatar
gsell committed
240 241 242 243 244
/**
 *
 *
 * @param fn Base file name
 */
245
void ParallelCyclotronTracker::openFiles(std::string SfileName) {
gsell's avatar
gsell committed
246

247
    std::string  SfileName2 = SfileName + std::string("-Angle0.dat");
gsell's avatar
gsell committed
248 249

    outfTheta0_m.precision(8);
250
    outfTheta0_m.setf(std::ios::scientific, std::ios::floatfield);
gsell's avatar
gsell committed
251
    outfTheta0_m.open(SfileName2.c_str());
252
    outfTheta0_m << "#  r [mm]      beta_r*gamma       theta [mm]      beta_theta*gamma        z [mm]          beta_z*gamma" << std::endl;
gsell's avatar
gsell committed
253

254
    SfileName2 = SfileName + std::string("-Angle1.dat");
gsell's avatar
gsell committed
255
    outfTheta1_m.precision(8);
256
    outfTheta1_m.setf(std::ios::scientific, std::ios::floatfield);
gsell's avatar
gsell committed
257
    outfTheta1_m.open(SfileName2.c_str());
258
    outfTheta1_m << "#  r [mm]      beta_r*gamma       theta [mm]      beta_theta*gamma        z [mm]          beta_z*gamma"  << std::endl;
gsell's avatar
gsell committed
259

260
    SfileName2 = SfileName + std::string("-Angle2.dat");
gsell's avatar
gsell committed
261
    outfTheta2_m.precision(8);
262
    outfTheta2_m.setf(std::ios::scientific, std::ios::floatfield);
gsell's avatar
gsell committed
263
    outfTheta2_m.open(SfileName2.c_str());
264
    outfTheta2_m << "#  r [mm]      beta_r*gamma       theta [mm]      beta_theta*gamma        z [mm]          beta_z*gamma"  << std::endl;
gsell's avatar
gsell committed
265 266 267

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

268
    SfileName2 = SfileName + std::string("-afterEachTurn.dat");
gsell's avatar
gsell committed
269 270

    outfThetaEachTurn_m.precision(8);
271
    outfThetaEachTurn_m.setf(std::ios::scientific, std::ios::floatfield);
gsell's avatar
gsell committed
272 273

    outfThetaEachTurn_m.open(SfileName2.c_str());
274
    outfTheta2_m << "#  r [mm]      beta_r*gamma       theta [mm]      beta_theta*gamma        z [mm]          beta_z*gamma"  << std::endl;
gsell's avatar
gsell committed
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
}

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

290
/**
291 292 293
 *
 * @param ring
 */
kraus's avatar
kraus committed
294
void ParallelCyclotronTracker::visitRing(const Ring &ring) {
Daniel Winklehner's avatar
Daniel Winklehner committed
295

296
    *gmsg << "* ----------------------------- Adding Ring ------------------------------ *" << endl;
Daniel Winklehner's avatar
Daniel Winklehner committed
297 298

    if (opalRing_m != NULL)
299
        delete opalRing_m;
Daniel Winklehner's avatar
Daniel Winklehner committed
300

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

303
    myElements.push_back(opalRing_m);
Daniel Winklehner's avatar
Daniel Winklehner committed
304

305 306 307 308 309
    opalRing_m->initialise(itsBunch);

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

311
    if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
kraus's avatar
kraus committed
312
        throw OpalException("Error in ParallelCyclotronTracker::visitRing",
313 314
                            "PHIINIT is out of [-180, 180)!");
    }
Daniel Winklehner's avatar
Daniel Winklehner committed
315 316

    referenceZ = 0.0;
317
    referencePz = 0.0;
Daniel Winklehner's avatar
Daniel Winklehner committed
318 319 320 321

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

322 323
    if(referencePtot < 0.0)
        referencePt *= -1.0;
Daniel Winklehner's avatar
Daniel Winklehner committed
324

325 326
    sinRefTheta_m = sin(referenceTheta * PIOVER180);
    cosRefTheta_m = cos(referenceTheta * PIOVER180);
gsell's avatar
gsell committed
327

328
    double BcParameter[8];
Daniel Winklehner's avatar
Daniel Winklehner committed
329

330
    for(int i = 0; i < 8; i++)
Daniel Winklehner's avatar
Daniel Winklehner committed
331 332
        BcParameter[i] = 0.0;

333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
    buildupFieldList(BcParameter, "OPALRING", opalRing_m);

    // 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
350 351 352 353 354 355 356 357

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

358
    *gmsg << "* -------------------------- Adding Cyclotron ---------------------------- *" << endl;
gsell's avatar
gsell committed
359

360 361
    Cyclotron *elptr = dynamic_cast<Cyclotron *>(cycl.clone());
    myElements.push_back(elptr);
362

363
    // Is this a Spiral Inflector Simulation? If yes, we'll give the user some
364 365 366 367 368 369
    // useful information
    spiral_flag = elptr->getSpiralFlag();

    if(spiral_flag) {

        *gmsg << endl << "* This is a Spiral Inflector Simulation! This means the following:" << endl;
370
        *gmsg         << "* 1.) It is up to the user to provide appropriate geometry, electric and magnetic fields!" << endl;
371 372
        *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;
373
        *gmsg         << "* 2.) It is strongly recommended to use the SAAMG fieldsolver," << endl;
374 375
        *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;
376 377
        *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;
378 379 380 381 382 383 384
        *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;

    }

385
    // Fresh run (no restart):
386
    if(!OpalData::getInstance()->inRestartRun()) {
387

388 389 390 391 392
        // Get reference values from cyclotron element
        referenceR     = elptr->getRinit();
        referenceTheta = elptr->getPHIinit();
        referenceZ     = elptr->getZinit();
        referencePr    = elptr->getPRinit();
393 394
        referencePz    = elptr->getPZinit();

395
        if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
396 397
            throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                "PHIINIT is out of [-180, 180)!");
398 399 400 401 402
        }

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

        // Calculate reference azimuthal (tangential) momentum from total-, z- and radial momentum:
403 404
        float insqrt = referencePtot * referencePtot - \
                       referencePr * referencePr - referencePz * referencePz;
405 406 407 408 409 410 411 412 413

        if(insqrt < 0) {

            if(insqrt > -1.0e-10) {

	        referencePt = 0.0;

            } else {

414
	        throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
415
                                    "Pt imaginary!");
416 417 418 419 420 421 422
            }

        } else {

            referencePt = sqrt(insqrt);
        }

423
        if(referencePtot < 0.0)
Daniel Winklehner's avatar
Daniel Winklehner committed
424
            referencePt *= -1.0;
425 426 427 428 429
        // End calculate referencePt

    // Restart a run:
    } else {

430
        // If the user wants to save the restarted run in local frame,
431 432
        // make sure the previous h5 file was local too
        if (Options::psDumpLocalFrame) {
433

434
	    if (!previousH5Local) {
435

436 437
                throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                    "You are trying a local restart from a global h5 file!");
438 439
	    }
	// Else, if the user wants to save the restarted run in global frame,
440 441
        // make sure the previous h5 file was global too
        } else {
442

443
	    if (previousH5Local) {
444

445 446
                throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                    "You are trying a global restart from a local h5 file!");
447
            }
448
        }
449

450 451 452 453
        // Adjust some of the reference variables from the h5 file
        referencePhi *= PIOVER180;
        referencePsi *= PIOVER180;
        referencePtot = bega;
454 455 456

        if(referenceTheta <= -180.0 || referenceTheta > 180.0) {

457
            throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
458 459
                                "PHIINIT is out of [-180, 180)!");
        }
460 461
    }

462
    sinRefTheta_m = sin(referenceTheta * PIOVER180);
463 464
    cosRefTheta_m = cos(referenceTheta * PIOVER180);

465
    *gmsg << endl;
adelmann's avatar
adelmann committed
466
    *gmsg << "* Bunch global starting position:" << endl;
467 468
    *gmsg << "* RINIT = " << referenceR  << " [mm]" << endl;
    *gmsg << "* PHIINIT = " << referenceTheta << " [deg]" << endl;
469
    *gmsg << "* ZINIT = " << referenceZ << " [mm]" << endl;
470
    *gmsg << endl;
adelmann's avatar
adelmann committed
471
    *gmsg << "* Bunch global starting momenta:" << endl;
gsell's avatar
gsell committed
472 473
    *gmsg << "* Initial gamma = " << itsReference.getGamma() << endl;
    *gmsg << "* Initial beta = " << itsReference.getBeta() << endl;
474
    *gmsg << "* Reference total momentum (beta * gamma) = " << referencePtot * 1000.0 << " [MCU]" << endl;
475 476 477
    *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;
478
    *gmsg << endl;
adelmann's avatar
adelmann committed
479

gsell's avatar
gsell committed
480
    double sym = elptr->getSymmetry();
481
    *gmsg << "* " << sym << "-fold field symmerty " << endl;
gsell's avatar
gsell committed
482

483 484 485
    // 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
486

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

490
    std::string type = elptr->getCyclotronType();
491
    *gmsg << "* Type of cyclotron = " << type << " " << endl;
492

493 494
    double rmin = elptr->getMinR();
    double rmax = elptr->getMaxR();
495
    *gmsg << "* Radial aperture = " << rmin << " ... " << rmax<<" [mm] "<< endl;
496 497 498

    double zmin = elptr->getMinZ();
    double zmax = elptr->getMaxZ();
499
    *gmsg << "* Vertical aperture = " << zmin << " ... " << zmax<<" [mm]"<< endl;
gsell's avatar
gsell committed
500

501
    /**
502
    bool Sflag = elptr->getSuperpose();
503
    std::string flagsuperposed;
504 505 506 507
    if (Sflag)
      flagsuperposed="yes";
    else
      flagsuperposed="no";
508
    *gmsg << "* Electric field maps are superposed? " << flagsuperposed << " " << endl;
509
    */
510

gsell's avatar
gsell committed
511
    double h = elptr->getCyclHarm();
512
    *gmsg << "* Number of trimcoils = " << elptr->getNumberOfTrimcoils() << endl;
513
    *gmsg << "* Harmonic number h = " << h << " " << endl;
514

515
    /**
adelmann's avatar
adelmann committed
516
    if (elptr->getSuperpose())
517
        *gmsg << "* Fields are superposed " << endl;
518
    */
adelmann's avatar
adelmann committed
519

gsell's avatar
gsell committed
520 521 522 523 524 525 526 527 528 529 530
    /**
     * 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
     */
    int  fieldflag;
531
    if(type == std::string("CARBONCYCL")) {
gsell's avatar
gsell committed
532
        fieldflag = 2;
533
    } else if(type == std::string("CYCIAE")) {
gsell's avatar
gsell committed
534
        fieldflag = 3;
535
    } else if(type == std::string("AVFEQ")) {
gsell's avatar
gsell committed
536
        fieldflag = 4;
537
    } else if(type == std::string("FFAG")) {
gsell's avatar
gsell committed
538
        fieldflag = 5;
539
    } else if(type == std::string("BANDRF")) {
gsell's avatar
gsell committed
540
        fieldflag = 6;
541 542
    } else if(type == std::string("SYNCHROCYCLOTRON")) {
	fieldflag = 7;
543
    } else //(type == "RING")
gsell's avatar
gsell committed
544 545 546 547
        fieldflag = 1;

    // read field map on the  middle plane of cyclotron.
    // currently scalefactor is set to 1.0
548
    // TEMP changed 1.0 to getBScale() to test if we can scale the midplane field -DW
549
    elptr->initialise(itsBunch, fieldflag, elptr->getBScale());
gsell's avatar
gsell committed
550 551

    double BcParameter[8];
552

553
    for(int i = 0; i < 8; i++)
adelmann's avatar
adelmann committed
554
      BcParameter[i] = 0.0;
555

gsell's avatar
gsell committed
556 557 558
    BcParameter[0] = elptr->getRmin();
    BcParameter[1] = elptr->getRmax();

559 560
    // Store inner radius and outer radius of cyclotron field map in the list
    buildupFieldList(BcParameter, "CYCLOTRON", elptr);
gsell's avatar
gsell committed
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
}

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

/**
 *
 *
 * @param coll
 */
void ParallelCyclotronTracker::visitCollimator(const Collimator &coll) {

578
    *gmsg << "* --------- Collimator -----------------------------" << endl;
gsell's avatar
gsell committed
579

580 581
    Collimator* elptr = dynamic_cast<Collimator *>(coll.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
582

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

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

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

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

595
    double zstart = elptr->getZStart();
adelmann's avatar
adelmann committed
596
    *gmsg << "* Zstart= " << zstart << " [mm]" << endl;
597 598

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

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

604
    elptr->initialise(itsBunch);
gsell's avatar
gsell committed
605 606 607 608

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
609
    std::string ElementType = "CCOLLIMATOR";
610 611 612 613
    BcParameter[0] = xstart ;
    BcParameter[1] = xend;
    BcParameter[2] = ystart ;
    BcParameter[3] = yend;
gsell's avatar
gsell committed
614 615 616 617 618 619 620 621 622 623 624 625 626 627
    BcParameter[4] = width ;
    buildupFieldList(BcParameter, ElementType, elptr);
}

/**
 *
 *
 * @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
628 629 630 631 632 633 634 635 636 637 638 639
/**
 *
 *
 * @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
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
/**
 *
 *
 * @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()));
}

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

670 671 672 673
void ParallelCyclotronTracker::visitOffset(const Offset & off) {
    if (opalRing_m == NULL)
        throw OpalException(
                        "ParallelCylcotronTracker::visitOffset",
kraus's avatar
kraus committed
674
                        "Attempt to place an offset when Ring not defined");
675 676 677 678 679 680
    Offset* offNonConst = const_cast<Offset*>(&off);
    offNonConst->updateGeometry(opalRing_m->getNextPosition(),
                       opalRing_m->getNextNormal());
    opalRing_m->appendElement(off);
}

gsell's avatar
gsell committed
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
/**
 *
 *
 * @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());
}

703

gsell's avatar
gsell committed
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
/**
 *
 *
 * @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()));
}

/**
 *
 *
 * @param prob
 */
void ParallelCyclotronTracker::visitProbe(const Probe &prob) {
720
    *gmsg << "* -----------  Probe -------------------------------" << endl;
721 722
    Probe *elptr = dynamic_cast<Probe *>(prob.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
723

724
    double xstart = elptr->getXstart();
725
    *gmsg << "XStart= " << xstart << " [mm]" << endl;
gsell's avatar
gsell committed
726

727
    double xend = elptr->getXend();
728
    *gmsg << "XEnd= " << xend << " [mm]" << endl;
gsell's avatar
gsell committed
729

730
    double ystart = elptr->getYstart();
731
    *gmsg << "YStart= " << ystart << " [mm]" << endl;
gsell's avatar
gsell committed
732

733
    double yend = elptr->getYend();
734
    *gmsg << "YEnd= " << yend << " [mm]" << endl;
gsell's avatar
gsell committed
735

736
    double width = elptr->getWidth();
737
    *gmsg << "Width= " << width << " [mm]" << endl;
gsell's avatar
gsell committed
738 739 740


    // initialise, do nothing
741
    elptr->initialise(itsBunch);
gsell's avatar
gsell committed
742 743 744 745

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
746
    std::string ElementType = "PROBE";
gsell's avatar
gsell committed
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
    BcParameter[0] = xstart ;
    BcParameter[1] = xend;
    BcParameter[2] = ystart ;
    BcParameter[3] = yend;
    BcParameter[4] = width ;

    // store probe parameters in the list
    buildupFieldList(BcParameter, ElementType, elptr);
}

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

767 768 769 770 771 772 773 774 775
void ParallelCyclotronTracker::visitSBend3D(const SBend3D &bend) {
    *gmsg << "Adding SBend3D" << endl;
    if (opalRing_m != NULL)
        opalRing_m->appendElement(bend);
    else
        throw OpalException("ParallelCyclotronTracker::visitSBend3D",
                      "Need to define a RINGDEFINITION to use SBend3D element");
}

776 777 778 779 780 781 782 783 784
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",
            "Need to define a RINGDEFINITION to use VariableRFCavity element");
}

gsell's avatar
gsell committed
785 786 787 788 789 790 791 792
/**
 *
 *
 * @param as
 */
void ParallelCyclotronTracker::visitRFCavity(const RFCavity &as) {

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

794 795
    RFCavity *elptr = dynamic_cast<RFCavity *>(as.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
796 797 798 799 800 801 802

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

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

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

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

812
    std::string fmfn = elptr->getFieldMapFN();
gsell's avatar
gsell committed
813
    *gmsg << "* RF Field map file name= " << fmfn << endl;
814
    double angle = elptr->getAzimuth();
gsell's avatar
gsell committed
815 816
    *gmsg << "* Cavity azimuth position= " << angle << " [deg] " << endl;

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

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

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

826 827 828 829 830 831

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

832 833 834 835
    std::shared_ptr<AbstractTimeDependence> freq_atd = nullptr;
    std::shared_ptr<AbstractTimeDependence> ampl_atd = nullptr;
    std::shared_ptr<AbstractTimeDependence> phase_atd = nullptr;

836 837 838 839 840
    std::vector<double>  unityVec;
    unityVec.push_back(1.);
    unityVec.push_back(0.);
    unityVec.push_back(0.);
    unityVec.push_back(0.);
841

842 843 844 845
    if (elptr->getFrequencyModelName() != "") {
      freq_atd = AbstractTimeDependence::getTimeDependence(elptr->getFrequencyModelName());
      *gmsg << "* Variable frequency RF Model name " << elptr->getFrequencyModelName() << endl;
    }
846 847
    else
        freq_atd = std::shared_ptr<AbstractTimeDependence>(new PolynomialTimeDependence(unityVec));
848 849 850 851 852

    if (elptr->getAmplitudeModelName() != "") {
      ampl_atd = AbstractTimeDependence::getTimeDependence(elptr->getAmplitudeModelName());
      *gmsg << "* Variable amplitude RF Model name " << elptr->getAmplitudeModelName() << endl;
    }
853 854
    else
        ampl_atd = std::shared_ptr<AbstractTimeDependence>(new PolynomialTimeDependence(unityVec));
855 856 857 858 859

    if (elptr->getPhaseModelName() != "") {
      phase_atd = AbstractTimeDependence::getTimeDependence(elptr->getPhaseModelName());
      *gmsg << "* Variable phase RF Model name " << elptr->getPhaseModelName() << endl;
    }
860 861
    else
        phase_atd = std::shared_ptr<AbstractTimeDependence>(new PolynomialTimeDependence(unityVec));
862

gsell's avatar
gsell committed
863
    // read cavity voltage profile data from file.
864
    elptr->initialise(itsBunch, freq_atd, ampl_atd, phase_atd);
gsell's avatar
gsell committed
865 866 867 868

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
869
    std::string ElementType = "CAVITY";
gsell's avatar
gsell committed
870 871 872 873 874 875 876 877 878 879 880 881 882 883
    BcParameter[0] = rmin;
    BcParameter[1] = rmax;
    BcParameter[2] = pdis;
    BcParameter[3] = angle;

    buildupFieldList(BcParameter, ElementType, elptr);
}

/**
 *
 *
 * @param rfq
 */
void ParallelCyclotronTracker::visitRFQuadrupole(const RFQuadrupole &rfq) {
884
    *gmsg << "In RFQuadrupole; L = " << rfq.getElementLength() << " however the element is missing " << endl;
gsell's avatar
gsell committed
885 886 887 888 889 890 891 892 893
    myElements.push_back(dynamic_cast<RFQuadrupole *>(rfq.clone()));
}

/**
 *
 *
 * @param bend
 */
void ParallelCyclotronTracker::visitSBend(const SBend &bend) {
894
    *gmsg << "In SBend; L = " << bend.getElementLength() << " however the element is missing " << endl;
gsell's avatar
gsell committed
895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
    myElements.push_back(dynamic_cast<SBend *>(bend.clone()));
}

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

/**
 *
 *
 * @param sept
 */
void ParallelCyclotronTracker::visitSeptum(const Septum &sept) {
914

915
    *gmsg << endl << "* -----------------------------  Septum ------------------------------- *" << endl;
gsell's avatar
gsell committed
916

917 918
    Septum *elptr = dynamic_cast<Septum *>(sept.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
919

920
    double xstart = elptr->getXstart();
921
    *gmsg << "XStart = " << xstart << " [mm]" << endl;
gsell's avatar
gsell committed
922

923
    double xend = elptr->getXend();
924
    *gmsg << "XEnd = " << xend << " [mm]" << endl;
gsell's avatar
gsell committed
925

926
    double ystart = elptr->getYstart();
927
    *gmsg << "YStart = " << ystart << " [mm]" << endl;
gsell's avatar
gsell committed
928

929
    double yend = elptr->getYend();
930
    *gmsg << "YEnd = " << yend << " [mm]" << endl;
gsell's avatar
gsell committed
931

932
    double width = elptr->getWidth();
933
    *gmsg << "Width = " << width << " [mm]" << endl;
gsell's avatar
gsell committed
934 935 936


    // initialise, do nothing
937
    elptr->initialise(itsBunch);
gsell's avatar
gsell committed
938 939 940 941

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
942
    std::string ElementType = "SEPTUM";
gsell's avatar
gsell committed
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
    BcParameter[0] = xstart ;
    BcParameter[1] = xend;
    BcParameter[2] = ystart ;
    BcParameter[3] = yend;
    BcParameter[4] = width ;

    // store septum parameters in the list
    buildupFieldList(BcParameter, ElementType, elptr);
}

/**
 *
 *
 * @param solenoid
 */
void ParallelCyclotronTracker::visitSolenoid(const Solenoid &solenoid) {
    myElements.push_back(dynamic_cast<Solenoid *>(solenoid.clone()));
    Component *elptr = *(--myElements.end());
    if(!elptr->hasAttribute("ELEMEDGE")) {
        *gmsg << "Solenoid: no position of the element given!" << endl;
        return;
    }
}

/**
 *
 *
 * @param pplate
 */
void ParallelCyclotronTracker::visitParallelPlate(const ParallelPlate &pplate) {//do nothing

    //*gmsg << "ParallelPlate: not in use in ParallelCyclotronTracker!" << endl;

    //buildupFieldList(startField, endField, elptr);

}

/**
 *
 *
 * @param cv
 */
void ParallelCyclotronTracker::visitCyclotronValley(const CyclotronValley &cv) {
    // Do nothing here.
}
/**
 * not used
 *
 * @param angle
 * @param curve
 * @param field
 * @param scale
 */
void ParallelCyclotronTracker::applyEntranceFringe(double angle, double curve,
        const BMultipoleField &field, double scale) {

}

/**
 *
 *
 * @param stripper
 */

void ParallelCyclotronTracker::visitStripper(const Stripper &stripper) {

    *gmsg << "* ---------Stripper------------------------------" << endl;

1011 1012 1013 1014
    Stripper *elptr = dynamic_cast<Stripper *>(stripper.clone());
    myElements.push_back(elptr);

    double xstart = elptr->getXstart();
gsell's avatar
gsell committed
1015 1016
    *gmsg << "XStart= " << xstart << " [mm]" << endl;

1017
    double xend = elptr->getXend();
gsell's avatar
gsell committed
1018 1019
    *gmsg << "XEnd= " << xend << " [mm]" << endl;