ParallelCyclotronTracker.cpp 222 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 20

#include "Algorithms/ParallelCyclotronTracker.h"

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

#include "AbsBeamline/Collimator.h"
#include "AbsBeamline/Corrector.h"
#include "AbsBeamline/Cyclotron.h"
adelmann's avatar
adelmann committed
30
#include "AbsBeamline/Degrader.h"
gsell's avatar
gsell committed
31 32 33 34
#include "AbsBeamline/Diagnostic.h"
#include "AbsBeamline/Drift.h"
#include "AbsBeamline/ElementBase.h"
#include "AbsBeamline/Lambertson.h"
35
#include "AbsBeamline/Offset.h"
gsell's avatar
gsell committed
36 37 38 39 40 41 42 43
#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"
44
#include "AbsBeamline/SBend3D.h"
gsell's avatar
gsell committed
45 46 47 48 49
#include "AbsBeamline/Separator.h"
#include "AbsBeamline/Septum.h"
#include "AbsBeamline/Solenoid.h"
#include "AbsBeamline/CyclotronValley.h"
#include "AbsBeamline/Stripper.h"
50
#include "AbsBeamline/VariableRFCavity.h"
51 52

#include "Elements/OpalBeamline.h"
kraus's avatar
kraus committed
53
#include "AbsBeamline/Ring.h"
gsell's avatar
gsell committed
54 55 56

#include "BeamlineGeometry/Euclid3D.h"
#include "BeamlineGeometry/PlanarArcGeometry.h"
Jianjun Yang's avatar
Jianjun Yang committed
57
#include "BeamlineGeometry/RBendGeometry.h"
gsell's avatar
gsell committed
58 59 60 61 62 63 64 65 66 67 68 69
#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"

70
#include "Structure/BoundaryGeometry.h"
kraus's avatar
kraus committed
71
#include "Utilities/OpalOptions.h"
gsell's avatar
gsell committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90

#include "Ctunes.h"
#include "Ctunes.cc"
#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
91
const double PIOVER180 = pi / 180.0;
92

93 94 95
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
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114

#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),
115
    eta_m(0.01),
gsell's avatar
gsell committed
116 117
    myNode_m(Ippl::myNode()),
    initialLocalNum_m(0),
118 119
    initialTotalNum_m(0),
    opalRing_m(NULL) {
gsell's avatar
gsell committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
    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,
                                                   int maxSTEPS, int timeIntegrator):
    Tracker(beamline, reference, revBeam, revTrack),
    maxSteps_m(maxSTEPS),
    timeIntegrator_m(timeIntegrator),
144
    eta_m(0.01),
gsell's avatar
gsell committed
145 146
    myNode_m(Ippl::myNode()),
    initialLocalNum_m(bunch.getLocalNum()),
147 148
    initialTotalNum_m(bunch.getTotalNum()),
    opalRing_m(NULL) {
gsell's avatar
gsell committed
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
    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() {
    for(list<Component *>::iterator compindex = myElements.begin(); compindex != myElements.end(); compindex++) {
        delete(*compindex);
    }
    for(beamline_list::iterator fdindex = FieldDimensions.begin(); fdindex != FieldDimensions.end(); fdindex++) {
        delete(*fdindex);
    }
    delete itsBeamline;
174 175 176
    if (opalRing_m != NULL) {
        // delete opalRing_m;
    }
gsell's avatar
gsell committed
177 178
}

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

199 200 201 202 203 204 205 206 207
/**
 *
 *
 * @param fn Base file name
 */
void ParallelCyclotronTracker::bgf_main_collision_test() {
  if(!bgf_m) return;

  Inform msg("bgf_main_collision_test ");
208 209

  /**
210 211 212
   *Here we check if a particles is outside the domain, flag it for deletion
   */

gsell's avatar
gsell committed
213
  Vector_t intecoords = 0.0;
214 215 216 217 218

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

219
  int triId = 0;
220 221
  size_t Nimpact = 0;
  for(size_t i = 0; i < itsBunch->getLocalNum(); i++) {
222
    int res = bgf_m->PartInside(itsBunch->R[i]*1.0e-3, itsBunch->P[i], dtime, itsBunch->PType[i], itsBunch->Q[i], intecoords, triId);
223
    if(res >= 0) {
224 225
      itsBunch->Bin[i] = -1;
      Nimpact++;
226
    }
227 228 229 230
  }
}


gsell's avatar
gsell committed
231 232 233 234 235
/**
 *
 *
 * @param fn Base file name
 */
236
void ParallelCyclotronTracker::openFiles(std::string SfileName) {
gsell's avatar
gsell committed
237

238
    std::string  SfileName2 = SfileName + std::string("-Angle0.dat");
gsell's avatar
gsell committed
239 240 241 242

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

245
    SfileName2 = SfileName + std::string("-Angle1.dat");
gsell's avatar
gsell committed
246 247 248
    outfTheta1_m.precision(8);
    outfTheta1_m.setf(ios::scientific, ios::floatfield);
    outfTheta1_m.open(SfileName2.c_str());
Jianjun Yang's avatar
Jianjun Yang committed
249
    outfTheta1_m << "#  r [mm]      beta_r*gamma       theta [mm]      beta_theta*gamma        z [mm]          beta_z*gamma"  << endl;
gsell's avatar
gsell committed
250

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

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

259
    SfileName2 = SfileName + std::string("-afterEachTurn.dat");
gsell's avatar
gsell committed
260 261 262 263 264

    outfThetaEachTurn_m.precision(8);
    outfThetaEachTurn_m.setf(ios::scientific, ios::floatfield);

    outfThetaEachTurn_m.open(SfileName2.c_str());
Jianjun Yang's avatar
Jianjun Yang committed
265
    outfTheta2_m << "#  r [mm]      beta_r*gamma       theta [mm]      beta_theta*gamma        z [mm]          beta_z*gamma"  << endl;
gsell's avatar
gsell committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
}

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

281
/**
282 283 284
 *
 * @param ring
 */
kraus's avatar
kraus committed
285
void ParallelCyclotronTracker::visitRing(const Ring &ring) {
Daniel Winklehner's avatar
Daniel Winklehner committed
286

kraus's avatar
kraus committed
287
    *gmsg << "Adding Ring" << endl;
Daniel Winklehner's avatar
Daniel Winklehner committed
288 289

    if (opalRing_m != NULL)
290
        delete opalRing_m;
Daniel Winklehner's avatar
Daniel Winklehner committed
291

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

294
    myElements.push_back(opalRing_m);
Daniel Winklehner's avatar
Daniel Winklehner committed
295

296 297 298 299 300
    opalRing_m->initialise(itsBunch);

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

302
    if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
kraus's avatar
kraus committed
303
        throw OpalException("Error in ParallelCyclotronTracker::visitRing",
304 305
                            "PHIINIT is out of [-180, 180)!");
    }
Daniel Winklehner's avatar
Daniel Winklehner committed
306 307

    referenceZ = 0.0;
308
    referencePz = 0.0;
Daniel Winklehner's avatar
Daniel Winklehner committed
309 310 311 312

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

313 314
    if(referencePtot < 0.0)
        referencePt *= -1.0;
Daniel Winklehner's avatar
Daniel Winklehner committed
315

316 317
    sinRefTheta_m = sin(referenceTheta * PIOVER180);
    cosRefTheta_m = cos(referenceTheta * PIOVER180);
gsell's avatar
gsell committed
318

319
    double BcParameter[8];
Daniel Winklehner's avatar
Daniel Winklehner committed
320

321
    for(int i = 0; i < 8; i++)
Daniel Winklehner's avatar
Daniel Winklehner committed
322 323
        BcParameter[i] = 0.0;

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
    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
341 342 343 344 345 346 347 348 349 350

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

    *gmsg << "* --------- Cyclotron ------------------------------" << endl;

351 352
    Cyclotron *elptr = dynamic_cast<Cyclotron *>(cycl.clone());
    myElements.push_back(elptr);
353

354
    // Fresh run (no restart):
355
    if(!OpalData::getInstance()->inRestartRun()) {
356

357 358 359 360 361
        // Get reference values from cyclotron element
        referenceR     = elptr->getRinit();
        referenceTheta = elptr->getPHIinit();
        referenceZ     = elptr->getZinit();
        referencePr    = elptr->getPRinit();
362 363
        referencePz    = elptr->getPZinit();

364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
        if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
            throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron", "PHIINIT is out of [-180, 180)!");
        }

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

        // Calculate reference azimuthal (tangential) momentum from total-, z- and radial momentum:
        float insqrt = referencePtot * referencePtot - referencePr * referencePr - referencePz * referencePz;

        if(insqrt < 0) {

            if(insqrt > -1.0e-10) {

	        referencePt = 0.0;

            } else {

	        throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron", "Pt imaginary!");
            }

        } else {

            referencePt = sqrt(insqrt);
        }

389
        if(referencePtot < 0.0)
Daniel Winklehner's avatar
Daniel Winklehner committed
390
            referencePt *= -1.0;
391 392 393 394 395 396 397 398 399 400
        // End calculate referencePt

    // Restart a run:
    } else {

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

            throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron", "PHIINIT is out of [-180, 180)!");

        }
401

402 403
        referencePtot =  bega;
        // Note: Nothing else has to be set, b/c everything comes from the h5 file -DW
404 405
    }

406
    sinRefTheta_m = sin(referenceTheta * PIOVER180);
407 408
    cosRefTheta_m = cos(referenceTheta * PIOVER180);

409
    *gmsg << endl;
adelmann's avatar
adelmann committed
410
    *gmsg << "* Bunch global starting position:" << endl;
411 412
    *gmsg << "* RINIT = " << referenceR  << " [mm]" << endl;
    *gmsg << "* PHIINIT = " << referenceTheta << " [deg]" << endl;
413
    *gmsg << "* ZINIT = " << referenceZ << " [mm]" << endl;
414
    *gmsg << endl;
adelmann's avatar
adelmann committed
415
    *gmsg << "* Bunch global starting momenta:" << endl;
gsell's avatar
gsell committed
416 417
    *gmsg << "* Initial gamma = " << itsReference.getGamma() << endl;
    *gmsg << "* Initial beta = " << itsReference.getBeta() << endl;
418
    *gmsg << "* Reference total momentum (beta * gamma) = " << referencePtot * 1000.0 << " [MCU]" << endl;
419 420 421
    *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;
422
    *gmsg << endl;
adelmann's avatar
adelmann committed
423

gsell's avatar
gsell committed
424
    double sym = elptr->getSymmetry();
425
    *gmsg << "* " << sym << "-fold field symmerty " << endl;
gsell's avatar
gsell committed
426

427 428 429
    // 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
430

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

434
    std::string type = elptr->getType();
435
    *gmsg << "* Type of cyclotron = " << type << " " << endl;
436

437 438
    double rmin = elptr->getMinR();
    double rmax = elptr->getMaxR();
439
    *gmsg << "* Radial aperture = " << rmin << " ... " << rmax<<" [mm] "<< endl;
440 441 442

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

445
    /**
446
    bool Sflag = elptr->getSuperpose();
447
    std::string flagsuperposed;
448 449 450 451
    if (Sflag)
      flagsuperposed="yes";
    else
      flagsuperposed="no";
452
    *gmsg << "* Electric field maps are superposed? " << flagsuperposed << " " << endl;
453
    */
454

gsell's avatar
gsell committed
455
    double h = elptr->getCyclHarm();
456
    *gmsg << "* Harmonic number h = " << h << " " << endl;
gsell's avatar
gsell committed
457

458
    /**
adelmann's avatar
adelmann committed
459
    if (elptr->getSuperpose())
460
        *gmsg << "* Fields are superposed " << endl;
461
    */
adelmann's avatar
adelmann committed
462

gsell's avatar
gsell committed
463 464 465 466 467 468 469 470 471 472 473
    /**
     * 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;
474
    if(type == std::string("CARBONCYCL")) {
gsell's avatar
gsell committed
475
        fieldflag = 2;
476
    } else if(type == std::string("CYCIAE")) {
gsell's avatar
gsell committed
477
        fieldflag = 3;
478
    } else if(type == std::string("AVFEQ")) {
gsell's avatar
gsell committed
479
        fieldflag = 4;
480
    } else if(type == std::string("FFAG")) {
gsell's avatar
gsell committed
481
        fieldflag = 5;
482
    } else if(type == std::string("BANDRF")) {
gsell's avatar
gsell committed
483
        fieldflag = 6;
484
    } else //(type == "RING")
gsell's avatar
gsell committed
485 486 487 488
        fieldflag = 1;

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

    double BcParameter[8];
493

494
    for(int i = 0; i < 8; i++)
adelmann's avatar
adelmann committed
495
      BcParameter[i] = 0.0;
496

gsell's avatar
gsell committed
497 498 499
    BcParameter[0] = elptr->getRmin();
    BcParameter[1] = elptr->getRmax();

500 501
    // Store inner radius and outer radius of cyclotron field map in the list
    buildupFieldList(BcParameter, "CYCLOTRON", elptr);
gsell's avatar
gsell committed
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
}

/**
 * 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) {

519
    *gmsg << "* --------- Collimator -----------------------------" << endl;
gsell's avatar
gsell committed
520

521 522
    Collimator* elptr = dynamic_cast<Collimator *>(coll.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
523

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

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

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

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

536
    double zstart = elptr->getZStart();
adelmann's avatar
adelmann committed
537
    *gmsg << "* Zstart= " << zstart << " [mm]" << endl;
538 539

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

542
    double width = elptr->getWidth();
adelmann's avatar
adelmann committed
543
    *gmsg << "* Width= " << width << " [mm]" << endl;
gsell's avatar
gsell committed
544 545 546 547 548 549

    elptr->initialise(itsBunch, 1.0);

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
550
    std::string ElementType = "CCOLLIMATOR";
551 552 553 554
    BcParameter[0] = xstart ;
    BcParameter[1] = xend;
    BcParameter[2] = ystart ;
    BcParameter[3] = yend;
gsell's avatar
gsell committed
555 556 557 558 559 560 561 562 563 564 565 566 567 568
    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
569 570 571 572 573 574 575 576 577 578 579 580
/**
 *
 *
 * @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
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
/**
 *
 *
 * @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()));
}

611 612 613 614
void ParallelCyclotronTracker::visitOffset(const Offset & off) {
    if (opalRing_m == NULL)
        throw OpalException(
                        "ParallelCylcotronTracker::visitOffset",
kraus's avatar
kraus committed
615
                        "Attempt to place an offset when Ring not defined");
616 617 618 619 620 621
    Offset* offNonConst = const_cast<Offset*>(&off);
    offNonConst->updateGeometry(opalRing_m->getNextPosition(),
                       opalRing_m->getNextNormal());
    opalRing_m->appendElement(off);
}

gsell's avatar
gsell committed
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
/**
 *
 *
 * @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());
}

644

gsell's avatar
gsell committed
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
/**
 *
 *
 * @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) {
661
    *gmsg << "* -----------  Probe -------------------------------" << endl;
662 663
    Probe *elptr = dynamic_cast<Probe *>(prob.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
664

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

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

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

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

677
    double width = elptr->getWidth();
678
    *gmsg << "Width= " << width << " [mm]" << endl;
gsell's avatar
gsell committed
679 680 681 682 683 684 685 686


    // initialise, do nothing
    elptr->initialise(itsBunch, 1.0);

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
687
    std::string ElementType = "PROBE";
gsell's avatar
gsell committed
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
    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()));
}

708 709 710 711 712 713 714 715 716
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");
}

717 718 719 720 721 722 723 724 725
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
726 727 728 729 730 731 732 733
/**
 *
 *
 * @param as
 */
void ParallelCyclotronTracker::visitRFCavity(const RFCavity &as) {

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

735 736
    RFCavity *elptr = dynamic_cast<RFCavity *>(as.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
737 738 739 740 741 742 743

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

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

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

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

753
    std::string fmfn = elptr->getFieldMapFN();
gsell's avatar
gsell committed
754
    *gmsg << "* RF Field map file name= " << fmfn << endl;
755
    double angle = elptr->getAzimuth();
gsell's avatar
gsell committed
756 757
    *gmsg << "* Cavity azimuth position= " << angle << " [deg] " << endl;

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

761
    double pdis = elptr->getPerpenDistance();
gsell's avatar
gsell committed
762 763 764
    *gmsg << "* Cavity Shift distance= " << pdis << " [mm] " << endl;


765
    double phi0 = elptr->getPhi0();
gsell's avatar
gsell committed
766 767 768 769 770 771 772 773
    *gmsg << "* Initial RF phase (t=0)= " << phi0 << " [deg] " << endl;

    // read cavity voltage profile data from file.
    elptr->initialise(itsBunch, 1.0);

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
774
    std::string ElementType = "CAVITY";
gsell's avatar
gsell committed
775 776 777 778 779 780 781 782 783 784 785 786 787 788
    BcParameter[0] = rmin;
    BcParameter[1] = rmax;
    BcParameter[2] = pdis;
    BcParameter[3] = angle;

    buildupFieldList(BcParameter, ElementType, elptr);
}

/**
 *
 *
 * @param rfq
 */
void ParallelCyclotronTracker::visitRFQuadrupole(const RFQuadrupole &rfq) {
789
    *gmsg << "In RFQuadrupole; L = " << rfq.getElementLength() << " however the element is missing " << endl;
gsell's avatar
gsell committed
790 791 792 793 794 795 796 797 798
    myElements.push_back(dynamic_cast<RFQuadrupole *>(rfq.clone()));
}

/**
 *
 *
 * @param bend
 */
void ParallelCyclotronTracker::visitSBend(const SBend &bend) {
799
    *gmsg << "In SBend; L = " << bend.getElementLength() << " however the element is missing " << endl;
gsell's avatar
gsell committed
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
    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) {
819

820
    *gmsg << endl << "* -----------------------------  Septum ------------------------------- *" << endl;
gsell's avatar
gsell committed
821

822 823
    Septum *elptr = dynamic_cast<Septum *>(sept.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
824

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

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

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

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

837
    double width = elptr->getWidth();
838
    *gmsg << "Width = " << width << " [mm]" << endl;
gsell's avatar
gsell committed
839 840 841 842 843 844 845 846


    // initialise, do nothing
    elptr->initialise(itsBunch, 1.0);

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
847
    std::string ElementType = "SEPTUM";
gsell's avatar
gsell committed
848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
    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;

916 917 918 919
    Stripper *elptr = dynamic_cast<Stripper *>(stripper.clone());
    myElements.push_back(elptr);

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

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

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

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

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

934
    double opcharge = elptr->getOPCharge();
935
    *gmsg << "Charge of outcoming particle = +e * " << opcharge << endl;
gsell's avatar
gsell committed
936

937
    double opmass = elptr->getOPMass();
938
    *gmsg << "* Mass of the outcoming particle = " << opmass << " [GeV/c^2]" << endl;
gsell's avatar
gsell committed
939 940 941 942 943 944

    elptr->initialise(itsBunch, 1.0);

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
945
    std::string ElementType = "STRIPPER";
gsell's avatar
gsell committed
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
    BcParameter[0] = xstart ;
    BcParameter[1] = xend;
    BcParameter[2] = ystart ;
    BcParameter[3] = yend;
    BcParameter[4] = width ;
    BcParameter[5] = opcharge;
    BcParameter[6] = opmass;

    buildupFieldList(BcParameter, ElementType, elptr);
}


void ParallelCyclotronTracker::applyExitFringe(double angle, double curve,
        const BMultipoleField &field, double scale) {

}


/**
 *
 *
 * @param BcParameter
 * @param ElementType
 * @param elptr
 */
971
void ParallelCyclotronTracker::buildupFieldList(double BcParameter[], std::string ElementType, Component *elptr) {
gsell's avatar
gsell committed
972 973 974 975 976 977 978 979 980 981 982
    beamline_list::iterator sindex;

    type_pair *localpair = new type_pair();
    localpair->first = ElementType;

    for(int i = 0; i < 8; i++)
        *(((localpair->second).first) + i) = *(BcParameter + i);

    (localpair->second).second = elptr;

    // always put cyclotron as the first element in the list.
983
    if(ElementType == "OPALRING" || ElementType == "CYCLOTRON") { // CYCLOTRON is TEMP -DW
gsell's avatar
gsell committed
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
        sindex = FieldDimensions.begin();
    } else {
        sindex = FieldDimensions.end();
    }
    FieldDimensions.insert(sindex, localpair);

}

/**
 *
 *
 * @param bl
 */
void ParallelCyclotronTracker::visitBeamline(const Beamline &bl) {
    itsBeamline->iterate(*dynamic_cast<BeamlineVisitor *>(this), false);
}

Matthias Toggweiler's avatar
Matthias Toggweiler committed
1001 1002 1003 1004
void ParallelCyclotronTracker::checkNumPart(std::string s) {
    int nlp = itsBunch->getLocalNum();
    int minnlp = 0;
    int maxnlp = 111111;
gsell's avatar
gsell committed
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
    reduce(nlp, minnlp, OpMinAssign());
    reduce(nlp, maxnlp, OpMaxAssign());
    *gmsg << s << " min local particle number " << minnlp << " max local particle number: " << maxnlp << endl;
}

/**
 *
 *
 */
void ParallelCyclotronTracker::execute() {

    /*
      Initialize common variables and structures
      for the integrators
    */

    step_m = 0;
    restartStep0_m = 0;
Daniel Winklehner's avatar
Daniel Winklehner committed
1023 1024

    // Record how many bunches have already been injected. ONLY FOR MPM
gsell's avatar
gsell committed
1025 1026 1027 1028 1029 1030
    BunchCount_m = itsBunch->getNumBunch();

    // For the time being, we set bin number equal to bunch number. FixMe: not used
    BinCount_m = BunchCount_m;

    itsBeamline->accept(*this);
1031 1032
    if (opalRing_m != NULL)
        opalRing_m->lockRing();
gsell's avatar
gsell committed
1033

Daniel Winklehner's avatar
Daniel Winklehner committed
1034 1035
    // Display the selected elements
    *gmsg << "* -------------------------------------" << endl;
adelmann's avatar
Cleanup  
adelmann committed
1036
    *gmsg << "* The selected Beam line elements are :" << endl;
1037

gsell's avatar
gsell committed
1038
    for(beamline_list::iterator sindex = FieldDimensions.begin(); sindex != FieldDimensions.end(); sindex++)
1039 1040
        *gmsg << "* -> " <<  ((*sindex)->first) << endl;

Daniel Winklehner's avatar
Daniel Winklehner committed
1041
    *gmsg << "* -------------------------------------" << endl;
1042

Daniel Winklehner's avatar
Daniel Winklehner committed
1043 1044
    // Don't initializeBoundaryGeometry()
    // Get BoundaryGeometry that is already initialized
1045
    bgf_m = OpalData::getInstance()->getGlobalGeometry();
1046

Daniel Winklehner's avatar
Daniel Winklehner committed
1047
    // External field arrays for dumping
gsell's avatar
gsell committed
1048 1049
    for(int k = 0; k < 2; k++)
        FDext_m[k] = Vector_t(0.0, 0.0, 0.0);
Daniel Winklehner's avatar
Daniel Winklehner committed
1050

gsell's avatar
gsell committed
1051 1052 1053 1054 1055
    extE_m = Vector_t(0.0, 0.0, 0.0);
    extB_m = Vector_t(0.0, 0.0, 0.0);

    if(timeIntegrator_m == 0) {
        *gmsg << "* 4th order Runge-Kutta integrator" << endl;
1056 1057 1058
#ifdef GENERICTRACKER
        Tracker_Generic();
#else
gsell's avatar
gsell committed
1059
        Tracker_RK4();
1060
#endif
gsell's avatar
gsell committed
1061 1062
    } else if(timeIntegrator_m == 1) {
        *gmsg << "* 2nd order Leap-Frog integrator" << endl;
1063 1064 1065
#ifdef GENERICTRACKER
        Tracker_Generic();
#else
gsell's avatar
gsell committed
1066
        Tracker_LF();
1067
#endif
1068 1069 1070
    } else if(timeIntegrator_m == 2) {
        *gmsg << "* Multiple time stepping (MTS) integrator" << endl;
        Tracker_MTS();
gsell's avatar
gsell committed
1071 1072 1073 1074
    } else {
        *gmsg << "ERROR: Invalid name of TIMEINTEGRATOR in Track command" << endl;
        exit(1);
    }
1075
    *gmsg << "* ----------------------------------------------- *" << endl;
adelmann's avatar
Cleanup  
adelmann committed
1076
    *gmsg << "* Finalizing i.e. write data and close files :" << endl;
gsell's avatar
gsell committed
1077 1078 1079
    for(beamline_list::iterator sindex = FieldDimensions.begin(); sindex != FieldDimensions.end(); sindex++) {
        (((*sindex)->second).second)->finalise();
    }
1080
    *gmsg << "* ----------------------------------------------- *" << endl;
gsell's avatar
gsell committed
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
}

/**
   In general the two tracker have much code in common.
   This is a great source of errors.
   Need to avoid this

*/



/**
 *
 *
 */
void ParallelCyclotronTracker::Tracker_LF() {

    BorisPusher pusher;

    // time steps interval between bunches for multi-bunch simulation.
    const int stepsPerTurn = itsBunch->getStepsPerTurn();

1103
    const double harm = getHarmonicNumber();
gsell's avatar
gsell committed
1104 1105 1106 1107 1108 1109 1110 1111 1112

    // load time
    const double dt = itsBunch->getdT() * 1.0e9 * harm; //[s]-->[ns]

    // find the injection time interval
    if(numBunch_m > 1) {
        *gmsg << "Time interval between neighbour bunches is set to " << stepsPerTurn *dt << "[ns]" << endl;
    }

1113
    initTrackOrbitFile();
gsell's avatar
gsell committed
1114 1115 1116 1117

    int SteptoLastInj = itsBunch->getSteptoLastInj();

    // get data from h5 file for restart run
1118
    if(OpalData::getInstance()->inRestartRun()) {
1119
        restartStep0_m = itsBunch->getLocalTrackStep();
gsell's avatar
gsell committed
1120
        step_m = restartStep0_m;