-DW

src/Algorithms/ParallelCyclotronTracker.cpp

@@ -429,19 +429,15 @@ void ParallelCyclotronTracker::visitCyclotron(const Cyclotron &cycl) {
 
         // If the user wants to save the restarted run in local frame,
         // make sure the previous h5 file was local too
-        if (Options::psDumpLocalFrame) {
-
-	    if (!previousH5Local) {
-
+      if (Options::psDumpLocalFrame != Options::GLOBAL) {
+        if (!previousH5Local) {
                 throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                     "You are trying a local restart from a global h5 file!");
-	    }
+        }
             // Else, if the user wants to save the restarted run in global frame,
             // make sure the previous h5 file was global too
-        } else {
-
-	    if (previousH5Local) {
-
+      } else {
+        if (previousH5Local) {
                 throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                     "You are trying a global restart from a local h5 file!");
             }
@@ -451,9 +447,7 @@ void ParallelCyclotronTracker::visitCyclotron(const Cyclotron &cycl) {
         referencePhi *= Physics::deg2rad;
         referencePsi *= Physics::deg2rad;
         referencePtot = bega;
-
         if(referenceTheta <= -180.0 || referenceTheta > 180.0) {
-
             throw OpalException("Error in ParallelCyclotronTracker::visitCyclotron",
                                 "PHIINIT is out of [-180, 180)!");
         }
@@ -3515,7 +3509,7 @@ void ParallelCyclotronTracker::initDistInGlobalFrame() {
             itsBunch->P[i](0) += referencePr;
             itsBunch->P[i](1) += referencePt;
             itsBunch->P[i](2) += referencePz;
-	}
+        }
 
         // Out of the three coordinates of meanR (R, Theta, Z) only the angle
         // changes the momentum vector...
@@ -3545,7 +3539,7 @@ void ParallelCyclotronTracker::initDistInGlobalFrame() {
         // Do a local frame restart (we have already checked that the old h5 file was saved in local
         // frame as well).
         // Cave: Multi-bunch must not be done in the local frame! (TODO: Is this still true? -DW)
-        if((Options::psDumpLocalFrame)) {
+        if((Options::psDumpLocalFrame != Options::GLOBAL)) {
 
             *gmsg << "* Restart in the local frame" << endl;
 
@@ -3786,8 +3780,15 @@ void ParallelCyclotronTracker::bunchDumpStatData(){
     // --------------------------------- Get some Values ---------------------------------------- //
     double const E = itsBunch->get_meanKineticEnergy();
     double const temp_t = itsBunch->getT() * 1e9; // s -> ns
-    Vector_t const meanR = calcMeanR();
-    Vector_t const meanP = calcMeanP();
+    Vector_t meanR;
+    Vector_t meanP;
+    if (Options::psDumpLocalFrame == Options::BUNCH_MEAN) {
+        meanR = calcMeanR();
+        meanP = calcMeanP();
+    } else {
+        meanR = itsBunch->R[0];
+        meanP = itsBunch->P[0];
+    }
     double phi = 0;
     double psi = 0;
     // --------------  Calculate the external fields at the center of the bunch ----------------- //
@@ -3800,9 +3801,8 @@ void ParallelCyclotronTracker::bunchDumpStatData(){
 
     // If we are saving in local frame, bunch and fields at the bunch center have to be rotated
     // TODO: Make decision if we maybe want to always save statistics data in local frame? -DW
-    if(Options::psDumpLocalFrame) {
+    if(Options::psDumpLocalFrame != Options::GLOBAL) {
         // -------------------- ----------- Do Transformations ---------------------------------- //
-
         // Bunch (local) azimuth at meanR w.r.t. y-axis
         phi = calculateAngle(meanP(0), meanP(1)) - 0.5 * pi;
 
@@ -3829,7 +3829,7 @@ void ParallelCyclotronTracker::bunchDumpStatData(){
     //itsBunch->R *= Vector_t(1000.0); // m -> mm
 
     // If we are in local mode, transform back after saving
-    if(Options::psDumpLocalFrame) {
+    if(Options::psDumpLocalFrame != Options::GLOBAL) {
         localToGlobal(itsBunch->R, phi, psi);
         localToGlobal(itsBunch->P, phi, psi);
     }
@@ -3850,8 +3850,15 @@ void ParallelCyclotronTracker::bunchDumpPhaseSpaceData() {
     // --------------------------------- Get some Values ---------------------------------------- //
     double const temp_t = itsBunch->getT() * 1.0e9; // s -> ns
 
-    Vector_t const meanR = calcMeanR();
-    Vector_t const meanP = calcMeanP();
+    Vector_t meanR;
+    Vector_t meanP;
+    if (Options::psDumpLocalFrame == Options::BUNCH_MEAN) {
+        meanR = calcMeanR();
+        meanP = calcMeanP();
+    } else {
+        meanR = itsBunch->R[0];
+        meanP = itsBunch->P[0];
+    }
 
     double const betagamma_temp = sqrt(dot(meanP, meanP));
     double const E = itsBunch->get_meanKineticEnergy();
@@ -3893,7 +3900,7 @@ void ParallelCyclotronTracker::bunchDumpPhaseSpaceData() {
 
     // -------------- If flag DumpLocalFrame is not set, dump bunch in global frame ------------- //
     if (Options::psDumpFreq < std::numeric_limits<int>::max() ){
-        if(!(Options::psDumpLocalFrame) && (Options::psDumpFreq < std::numeric_limits<int>::max())) {
+        if (Options::psDumpLocalFrame == Options::GLOBAL) {
 
             FDext_m[0] = extB_m * 0.1; // kgauss --> T
             FDext_m[1] = extE_m;

src/BasicActions/Option.cpp

@@ -23,6 +23,8 @@
 #include "Utilities/ClassicRandom.h"
 #include "Utility/IpplInfo.h"
 
+#include "Utilities/OpalException.h"
+
 #include <ctime>
 #include <iostream>
 #include <limits>
@@ -49,6 +51,7 @@ namespace {
         STATDUMPFREQ,
         PSDUMPEACHTURN,
         PSDUMPLOCALFRAME,
+        PSDUMPFRAME,
         SPTDUMPFREQ,
         REPARTFREQ,
         REBINFREQ,
@@ -123,7 +126,10 @@ Option::Option():
       ("REMOTEPARTDEL", "Artifically delete the remote particle if its distance to the beam mass is larger than REMOTEPARTDEL times of the beam rms size, its default values is 0 (no delete) ",0.0);
 
     itsAttr[PSDUMPLOCALFRAME] = Attributes::makeBool
-                                ("PSDUMPLOCALFRAME", "If true, in local Cartesian frame, otherwise in global Cartesian frame, only aviable for OPAL-cycl, its default value is false");
+                                ("PSDUMPLOCALFRAME", "Deprecated; please use PSDUMPFRAME.");
+
+    itsAttr[PSDUMPFRAME] = Attributes::makeString
+                                ("PSDUMPFRAME", "Controls the frame of phase space dump in stat file and h5 file. If 'GLOBAL' OPAL will dump in the lab (global) Cartesian frame; if 'BUNCH_MEAN' OPAL will dump in the local Cartesian frame of the beam mean; if 'REFERENCE'  OPAL will dump in the local Cartesian frame of the reference particle 0. Only aviable for OPAL-cycl, its default value is 'GLOBAL'");
 
     itsAttr[SPTDUMPFREQ] = Attributes::makeReal
                            ("SPTDUMPFREQ", "The frequency to dump single particle trajectory of particles with ID = 0 & 1, its default value is 1. ");
@@ -211,7 +217,8 @@ Option::Option(const std::string &name, Option *parent):
     Attributes::setReal(itsAttr[PSDUMPFREQ], psDumpFreq);
     Attributes::setReal(itsAttr[STATDUMPFREQ], statDumpFreq);
     Attributes::setBool(itsAttr[PSDUMPEACHTURN], psDumpEachTurn);
-    Attributes::setBool(itsAttr[PSDUMPLOCALFRAME], psDumpLocalFrame);
+    Attributes::setBool(itsAttr[PSDUMPLOCALFRAME], psDumpLocalFrame_m);
+    Attributes::setString(itsAttr[PSDUMPFRAME], psDumpFrame_m);
     Attributes::setReal(itsAttr[SPTDUMPFREQ], sptDumpFreq);
     Attributes::setReal(itsAttr[SCSOLVEFREQ], scSolveFreq);
     Attributes::setReal(itsAttr[MTSSUBSTEPS], mtsSubsteps);
@@ -258,7 +265,6 @@ void Option::execute() {
     verify    = Attributes::getBool(itsAttr[VERIFY]);
     warn      = Attributes::getBool(itsAttr[WARN]);
     psDumpEachTurn =   Attributes::getBool(itsAttr[PSDUMPEACHTURN]);
-    psDumpLocalFrame = Attributes::getBool(itsAttr[PSDUMPLOCALFRAME]);
     scan = Attributes::getBool(itsAttr[SCAN]);
     rhoDump = Attributes::getBool(itsAttr[RHODUMP]);
     ebDump = Attributes::getBool(itsAttr[EBDUMP]);
@@ -270,6 +276,10 @@ void Option::execute() {
     IpplInfo::Info->on(info);
     IpplInfo::Warn->on(warn);
 
+    psDumpLocalFrame_m = Attributes::getBool(itsAttr[PSDUMPLOCALFRAME]);
+    psDumpFrame_m = Attributes::getString(itsAttr[PSDUMPFRAME]);
+    handlePsDumpFrame();
+
     if(itsAttr[ASCIIDUMP]) {
         asciidump = Attributes::getBool(itsAttr[ASCIIDUMP]);
     }
@@ -372,4 +382,31 @@ void Option::execute() {
     if(Attributes::getBool(itsAttr[TELL])) {
         *gmsg << "\nCurrent settings of options:\n" << *this << endl;
     }
-}
\ No newline at end of file
+}
+
+void Option::handlePsDumpFrame() {
+    if (psDumpLocalFrame_m) {
+        if (psDumpFrame_m == "GLOBAL") {
+            psDumpFrame_m == "BUNCH_MEAN";
+        } else {
+            std::string msg = std::string("Either set 'PSDUMPLOCALFRAME' Option")+\
+                              std::string(" or 'PSDUMPFRAME' Option but not both."); 
+            throw OpalException("Option::handlePsDumpFrame", msg);
+        }
+    }
+    if (psDumpFrame_m == "GLOBAL") {
+        // do nothing; leave as defaults (this gets called for every option,
+        // so we have to implicitly take default otherwise we will overwrite
+        // other settings)
+    } else if (psDumpFrame_m == "BUNCH_MEAN") {
+        psDumpLocalFrame = BUNCH_MEAN;
+    } else if (psDumpFrame_m == "REFERENCE") {
+        psDumpLocalFrame = REFERENCE;
+    } else {
+        std::string msg = std::string("Did not recognise PSDUMPFRAME '")+\
+                    psDumpFrame_m+std::string("'. It should be one of 'GLOBAL',")+\
+                    std::string(" 'BUNCH_MEAN' or 'REFERENCE'");
+        throw OpalException("Option::handlePsDumpFrame", msg);
+    }
+}
+

src/BasicActions/Option.h

@@ -43,6 +43,7 @@ public:
     virtual void execute();
 
 private:
+    void handlePsDumpFrame();
 
     // Not implemented.
     Option(const Option &);
@@ -50,6 +51,9 @@ private:
 
     // Clone constructor.
     Option(const std::string &name, Option *parent);
+
+    bool psDumpLocalFrame_m = false;
+    std::string psDumpFrame_m = "GLOBAL";
 };
 
 #endif // OPAL_Option_HH

src/Classic/Utilities/OptionTypes.h

 namespace Options {
+    enum DumpFrame {
+        GLOBAL=0,
+        BUNCH_MEAN=1,
+        REFERENCE=2
+    };
 
     enum OPENMODE {
         WRITE,

src/Classic/Utilities/Options.cpp

@@ -30,7 +30,7 @@ namespace Options {
     bool verify = false;
     bool warn = true;
     bool psDumpEachTurn = false;
-    bool psDumpLocalFrame = false;
+    DumpFrame psDumpLocalFrame = GLOBAL;
     bool scan = false;
     bool rhoDump = false;
     bool ebDump = false;
@@ -94,4 +94,4 @@ namespace Options {
 
     // opal version of input file
     int version = 10000;
-}
\ No newline at end of file
+}

src/Classic/Utilities/Options.h

@@ -28,7 +28,6 @@
 #include "Utilities/ClassicRandom.h"
 
 namespace Options {
-
     /// Echo flag.
     //  If true, print an input echo.
     extern bool echo;
@@ -114,8 +113,10 @@ namespace Options {
     extern int boundpDestroyFreq;
 
     /// flag to decide in which coordinate frame the phase space will be dumped for OPAL-cycl
-    // if true, in local Cartesian frame, otherwise in global Cartesian frame
-    extern bool psDumpLocalFrame;
+    //  - GLOBAL, in Cartesian frame of the global particle
+    //  - BUNCH_MEAN, in Cartesian frame of the bunch mean
+    //  - REFERENCE, in Cartesian frame of the reference (0) particle
+    extern DumpFrame psDumpLocalFrame;
 
     /// The frequency to solve space charge fields.
     extern int scSolveFreq;
@@ -158,4 +159,4 @@ namespace Options {
     extern int version;
 }
 
-#endif // OPAL_Options_HH
\ No newline at end of file
+#endif // OPAL_Options_HH

src/Structure/H5PartWrapperForPC.cpp

@@ -310,7 +310,7 @@ void H5PartWrapperForPC::writeStepHeader(PartBunch& bunch, const std::map<std::s
     double mass = 1.0e-9 * bunch.getM();
     double charge = bunch.getCharge();
 
-    h5_int64_t localFrame = Options::psDumpLocalFrame? 1: 0;
+    h5_int64_t localFrame = Options::psDumpLocalFrame;
 
     double sposHead = 0.0;
     double sposRef = 0.0;
@@ -585,4 +585,4 @@ void H5PartWrapperForPC::writeStepData(PartBunch& bunch) {
                                                (h5_float64_t)bunch.get_hr()(1),
                                                (h5_float64_t)bunch.get_hr()(2)));
     }
-}
\ No newline at end of file
+}

tests/classic_src/AbsBeamline/RingTest.cpp

@@ -37,15 +37,6 @@
 #include <iostream>
 #include <sstream>
 
-namespace {
-    std::string burnAfterReading(std::ostringstream &ostr) {
-        std::string returnValue = ostr.str();
-        ostr.str("");
-
-        return returnValue;
-    }
-}
-
 // generate a set of weird, but closed, elements
 // reaches theta sum after 16 elements
 class OffsetFactory {

tests/opal_src/Distribution/GaussTest.cpp

@@ -25,15 +25,6 @@ Inform *gmsg;
 #include <cstring>
 #include <sstream>
 
-namespace {
-    std::string burnAfterReading(std::ostringstream &ostr) {
-        std::string returnValue = ostr.str();
-        ostr.str("");
-
-        return returnValue;
-    }
-}
-
 TEST(GaussTest, FullSigmaTest1) {
     OpalTestUtilities::SilenceTest silencer(true);
     char inputFileName[] = "GaussDistributionTest.in";