ParallelCyclotronTracker.cpp 232 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 21
#include "Algorithms/ParallelCyclotronTracker.h"

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

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

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

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

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

#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
92
const double PIOVER180 = pi / 180.0;
93

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

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

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

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

  Inform msg("bgf_main_collision_test ");
211 212

  /**
213 214 215
   *Here we check if a particles is outside the domain, flag it for deletion
   */

gsell's avatar
gsell committed
216
  Vector_t intecoords = 0.0;
217 218 219 220 221

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

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


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

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

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

248
    SfileName2 = SfileName + std::string("-Angle1.dat");
gsell's avatar
gsell committed
249
    outfTheta1_m.precision(8);
250
    outfTheta1_m.setf(std::ios::scientific, std::ios::floatfield);
gsell's avatar
gsell committed
251
    outfTheta1_m.open(SfileName2.c_str());
252
    outfTheta1_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("-Angle2.dat");
gsell's avatar
gsell committed
255
    outfTheta2_m.precision(8);
256
    outfTheta2_m.setf(std::ios::scientific, std::ios::floatfield);
gsell's avatar
gsell committed
257
    outfTheta2_m.open(SfileName2.c_str());
258
    outfTheta2_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 261

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

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

    outfThetaEachTurn_m.precision(8);
265
    outfThetaEachTurn_m.setf(std::ios::scientific, std::ios::floatfield);
gsell's avatar
gsell committed
266 267

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

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

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

290
    *gmsg << "* ----------------------------- Adding Ring ------------------------------ *" << endl;
Daniel Winklehner's avatar
Daniel Winklehner committed
291 292

    if (opalRing_m != NULL)
293
        delete opalRing_m;
Daniel Winklehner's avatar
Daniel Winklehner committed
294

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

297
    myElements.push_back(opalRing_m);
Daniel Winklehner's avatar
Daniel Winklehner committed
298

299 300 301 302 303
    opalRing_m->initialise(itsBunch);

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

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

    referenceZ = 0.0;
311
    referencePz = 0.0;
Daniel Winklehner's avatar
Daniel Winklehner committed
312 313 314 315

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

316 317
    if(referencePtot < 0.0)
        referencePt *= -1.0;
Daniel Winklehner's avatar
Daniel Winklehner committed
318

319 320
    sinRefTheta_m = sin(referenceTheta * PIOVER180);
    cosRefTheta_m = cos(referenceTheta * PIOVER180);
gsell's avatar
gsell committed
321

322
    double BcParameter[8];
Daniel Winklehner's avatar
Daniel Winklehner committed
323

324
    for(int i = 0; i < 8; i++)
Daniel Winklehner's avatar
Daniel Winklehner committed
325 326
        BcParameter[i] = 0.0;

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

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

352
    *gmsg << "* -------------------------- Adding Cyclotron ---------------------------- *" << endl;
gsell's avatar
gsell committed
353

354 355
    Cyclotron *elptr = dynamic_cast<Cyclotron *>(cycl.clone());
    myElements.push_back(elptr);
356

357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
    // Is this a Spiral Inflector Simulation? If yes, we'll give the user some 
    // useful information
    spiral_flag = elptr->getSpiralFlag();

    if(spiral_flag) {

        *gmsg << endl << "* This is a Spiral Inflector Simulation! This means the following:" << endl;
        *gmsg         << "* 1.) It is up to the user to provide appropriate geometry, electric and magnetic fields!" << endl;        
        *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;
        *gmsg         << "* 2.) It is strongly recommended to use the SAAMG fieldsolver," << endl; 
        *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;
        *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; 
        *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;

    }

379
    // Fresh run (no restart):
380
    if(!OpalData::getInstance()->inRestartRun()) {
381

382 383 384 385 386
        // Get reference values from cyclotron element
        referenceR     = elptr->getRinit();
        referenceTheta = elptr->getPHIinit();
        referenceZ     = elptr->getZinit();
        referencePr    = elptr->getPRinit();
387 388
        referencePz    = elptr->getPZinit();

389
        if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
390 391
            throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                "PHIINIT is out of [-180, 180)!");
392 393 394 395 396
        }

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

        // Calculate reference azimuthal (tangential) momentum from total-, z- and radial momentum:
397 398
        float insqrt = referencePtot * referencePtot - \
                       referencePr * referencePr - referencePz * referencePz;
399 400 401 402 403 404 405 406 407

        if(insqrt < 0) {

            if(insqrt > -1.0e-10) {

	        referencePt = 0.0;

            } else {

408
	        throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
409
                                    "Pt imaginary!");
410 411 412 413 414 415 416
            }

        } else {

            referencePt = sqrt(insqrt);
        }

417
        if(referencePtot < 0.0)
Daniel Winklehner's avatar
Daniel Winklehner committed
418
            referencePt *= -1.0;
419 420 421 422 423
        // End calculate referencePt

    // Restart a run:
    } else {

424
        // If the user wants to save the restarted run in local frame,
425 426
        // make sure the previous h5 file was local too
        if (Options::psDumpLocalFrame) {
427

428
	    if (!previousH5Local) {
429

430 431
                throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                    "You are trying a local restart from a global h5 file!");
432 433
	    }
	// Else, if the user wants to save the restarted run in global frame,
434 435
        // make sure the previous h5 file was global too
        } else {
436

437
	    if (previousH5Local) {
438

439 440
                throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                    "You are trying a global restart from a local h5 file!");
441
            }
442
        }
443

444 445 446 447
        // Adjust some of the reference variables from the h5 file
        referencePhi *= PIOVER180;
        referencePsi *= PIOVER180;
        referencePtot = bega;
448 449 450

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

451
            throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
452 453
                                "PHIINIT is out of [-180, 180)!");
        }
454 455
    }

456
    sinRefTheta_m = sin(referenceTheta * PIOVER180);
457 458
    cosRefTheta_m = cos(referenceTheta * PIOVER180);

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

gsell's avatar
gsell committed
474
    double sym = elptr->getSymmetry();
475
    *gmsg << "* " << sym << "-fold field symmerty " << endl;
gsell's avatar
gsell committed
476

477 478 479
    // 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
480

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

484
    std::string type = elptr->getCyclotronType();
485
    *gmsg << "* Type of cyclotron = " << type << " " << endl;
486

487 488
    double rmin = elptr->getMinR();
    double rmax = elptr->getMaxR();
489
    *gmsg << "* Radial aperture = " << rmin << " ... " << rmax<<" [mm] "<< endl;
490 491 492

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

495
    /**
496
    bool Sflag = elptr->getSuperpose();
497
    std::string flagsuperposed;
498 499 500 501
    if (Sflag)
      flagsuperposed="yes";
    else
      flagsuperposed="no";
502
    *gmsg << "* Electric field maps are superposed? " << flagsuperposed << " " << endl;
503
    */
504

gsell's avatar
gsell committed
505
    double h = elptr->getCyclHarm();
506
    *gmsg << "* Number of trimcoils = " << elptr->getNumberOfTrimcoils() << endl;
507
    *gmsg << "* Harmonic number h = " << h << " " << endl;
508
    /**
adelmann's avatar
adelmann committed
509
    if (elptr->getSuperpose())
510
        *gmsg << "* Fields are superposed " << endl;
511
    */
adelmann's avatar
adelmann committed
512

gsell's avatar
gsell committed
513 514 515 516 517 518 519 520 521 522 523
    /**
     * To ease the initialise() function, set a integral parameter fieldflag internally.
     * Its value is  by the option "TYPE" of the element  "CYCLOTRON"
     * fieldflag = 1, readin PSI format measured field file (default)
     * fieldflag = 2, readin carbon cyclotron field file created by Jianjun Yang, TYPE=CARBONCYCL
     * fieldflag = 3, readin ANSYS format file for CYCIAE-100 created by Jianjun Yang, TYPE=CYCIAE
     * fieldflag = 4, readin AVFEQ format file for Riken cyclotrons
     * 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;
524
    if(type == std::string("CARBONCYCL")) {
gsell's avatar
gsell committed
525
        fieldflag = 2;
526
    } else if(type == std::string("CYCIAE")) {
gsell's avatar
gsell committed
527
        fieldflag = 3;
528
    } else if(type == std::string("AVFEQ")) {
gsell's avatar
gsell committed
529
        fieldflag = 4;
530
    } else if(type == std::string("FFAG")) {
gsell's avatar
gsell committed
531
        fieldflag = 5;
532
    } else if(type == std::string("BANDRF")) {
gsell's avatar
gsell committed
533
        fieldflag = 6;
534 535
    } else if(type == std::string("SYNCHROCYCLOTRON")) {
	fieldflag = 7;
536
    } else //(type == "RING")
gsell's avatar
gsell committed
537 538 539 540
        fieldflag = 1;

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

    double BcParameter[8];
545

546
    for(int i = 0; i < 8; i++)
adelmann's avatar
adelmann committed
547
      BcParameter[i] = 0.0;
548

gsell's avatar
gsell committed
549 550 551
    BcParameter[0] = elptr->getRmin();
    BcParameter[1] = elptr->getRmax();

552 553
    // Store inner radius and outer radius of cyclotron field map in the list
    buildupFieldList(BcParameter, "CYCLOTRON", elptr);
gsell's avatar
gsell committed
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
}

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

571
    *gmsg << "* --------- Collimator -----------------------------" << endl;
gsell's avatar
gsell committed
572

573 574
    Collimator* elptr = dynamic_cast<Collimator *>(coll.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
575

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

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

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

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

588
    double zstart = elptr->getZStart();
adelmann's avatar
adelmann committed
589
    *gmsg << "* Zstart= " << zstart << " [mm]" << endl;
590 591

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

594
    double width = elptr->getWidth();
adelmann's avatar
adelmann committed
595
    *gmsg << "* Width= " << width << " [mm]" << endl;
gsell's avatar
gsell committed
596 597 598 599 600 601

    elptr->initialise(itsBunch, 1.0);

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
602
    std::string ElementType = "CCOLLIMATOR";
603 604 605 606
    BcParameter[0] = xstart ;
    BcParameter[1] = xend;
    BcParameter[2] = ystart ;
    BcParameter[3] = yend;
gsell's avatar
gsell committed
607 608 609 610 611 612 613 614 615 616 617 618 619 620
    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
621 622 623 624 625 626 627 628 629 630 631 632
/**
 *
 *
 * @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
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
/**
 *
 *
 * @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()));
}

663 664 665 666
void ParallelCyclotronTracker::visitOffset(const Offset & off) {
    if (opalRing_m == NULL)
        throw OpalException(
                        "ParallelCylcotronTracker::visitOffset",
kraus's avatar
kraus committed
667
                        "Attempt to place an offset when Ring not defined");
668 669 670 671 672 673
    Offset* offNonConst = const_cast<Offset*>(&off);
    offNonConst->updateGeometry(opalRing_m->getNextPosition(),
                       opalRing_m->getNextNormal());
    opalRing_m->appendElement(off);
}

gsell's avatar
gsell committed
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
/**
 *
 *
 * @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());
}

696

gsell's avatar
gsell committed
697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
/**
 *
 *
 * @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) {
713
    *gmsg << "* -----------  Probe -------------------------------" << endl;
714 715
    Probe *elptr = dynamic_cast<Probe *>(prob.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
716

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

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

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

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

729
    double width = elptr->getWidth();
730
    *gmsg << "Width= " << width << " [mm]" << endl;
gsell's avatar
gsell committed
731 732 733 734 735 736 737 738


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

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
739
    std::string ElementType = "PROBE";
gsell's avatar
gsell committed
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
    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()));
}

760 761 762 763 764 765 766 767 768
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");
}

769 770 771 772 773 774 775 776 777
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
778 779 780 781 782 783 784 785
/**
 *
 *
 * @param as
 */
void ParallelCyclotronTracker::visitRFCavity(const RFCavity &as) {

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

787 788
    RFCavity *elptr = dynamic_cast<RFCavity *>(as.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
789 790 791 792 793 794 795

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

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

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

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

805
    std::string fmfn = elptr->getFieldMapFN();
gsell's avatar
gsell committed
806
    *gmsg << "* RF Field map file name= " << fmfn << endl;
807
    double angle = elptr->getAzimuth();
gsell's avatar
gsell committed
808 809
    *gmsg << "* Cavity azimuth position= " << angle << " [deg] " << endl;

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

813
    double pdis = elptr->getPerpenDistance();
gsell's avatar
gsell committed
814 815 816
    *gmsg << "* Cavity Shift distance= " << pdis << " [mm] " << endl;


817
    double phi0 = elptr->getPhi0();
gsell's avatar
gsell committed
818 819 820 821 822 823 824 825
    *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;
826
    std::string ElementType = "CAVITY";
gsell's avatar
gsell committed
827 828 829 830 831 832 833 834 835 836 837 838 839 840
    BcParameter[0] = rmin;
    BcParameter[1] = rmax;
    BcParameter[2] = pdis;
    BcParameter[3] = angle;

    buildupFieldList(BcParameter, ElementType, elptr);
}

/**
 *
 *
 * @param rfq
 */
void ParallelCyclotronTracker::visitRFQuadrupole(const RFQuadrupole &rfq) {
841
    *gmsg << "In RFQuadrupole; L = " << rfq.getElementLength() << " however the element is missing " << endl;
gsell's avatar
gsell committed
842 843 844 845 846 847 848 849 850
    myElements.push_back(dynamic_cast<RFQuadrupole *>(rfq.clone()));
}

/**
 *
 *
 * @param bend
 */
void ParallelCyclotronTracker::visitSBend(const SBend &bend) {
851
    *gmsg << "In SBend; L = " << bend.getElementLength() << " however the element is missing " << endl;
gsell's avatar
gsell committed
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
    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) {
871

872
    *gmsg << endl << "* -----------------------------  Septum ------------------------------- *" << endl;
gsell's avatar
gsell committed
873

874 875
    Septum *elptr = dynamic_cast<Septum *>(sept.clone());
    myElements.push_back(elptr);
gsell's avatar
gsell committed
876

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

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

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

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

889
    double width = elptr->getWidth();
890
    *gmsg << "Width = " << width << " [mm]" << endl;
gsell's avatar
gsell committed
891 892 893 894 895 896 897 898


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

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
899
    std::string ElementType = "SEPTUM";
gsell's avatar
gsell committed
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 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
    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;

968 969 970 971
    Stripper *elptr = dynamic_cast<Stripper *>(stripper.clone());
    myElements.push_back(elptr);

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

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

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

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

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

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

989
    double opmass = elptr->getOPMass();
990
    *gmsg << "* Mass of the outcoming particle = " << opmass << " [GeV/c^2]" << endl;
gsell's avatar
gsell committed
991 992 993 994 995 996

    elptr->initialise(itsBunch, 1.0);

    double BcParameter[8];
    for(int i = 0; i < 8; i++)
        BcParameter[i] = 0.0;
997
    std::string ElementType = "STRIPPER";
gsell's avatar
gsell committed
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
    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
 */
1023
void ParallelCyclotronTracker::buildupFieldList(double BcParameter[], std::string ElementType, Component *elptr) {
gsell's avatar
gsell committed
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
    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.
1035
    if(ElementType == "OPALRING" || ElementType == "CYCLOTRON") {
gsell's avatar
gsell committed
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
        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
1053 1054 1055 1056
void ParallelCyclotronTracker::checkNumPart(std::string s) {
    int nlp = itsBunch->getLocalNum();
    int minnlp = 0;
    int maxnlp = 111111;
gsell's avatar
gsell committed
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
    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