Options.h

Go to the documentation of this file.

//
// Namespace Options
//   The global OPAL option flags.
//   This namespace contains the global option flags.
//
// Copyright (c) 200x - 2020, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#ifndef OPTIONS_HH
#define OPTIONS_HH

#include "Utilities/ClassicRandom.h"

#include <string>

enum class DumpFrame: unsigned short {
    GLOBAL,
    BUNCH_MEAN,
    REFERENCE
};

namespace Options {
    //  If true, print an input echo.
    extern bool echo;

    //  If true, print informative messages.
    extern bool info;
    extern int infoLevel;

    //  If true, print CPU time before and after each command.
    extern bool mtrace;

    //  If true, print warning messages.
    extern bool warn;
    extern int warnLevel;

    //  The global random generator.
    extern Random rangen;

    extern int seed;

    extern int psDumpFreq;

    extern int statDumpFreq;

    //  if true, dump phase space after each turn
    extern bool psDumpEachTurn;

    //  - 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 psDumpFrame;

    extern int sptDumpFreq;

    extern int repartFreq;

    extern int minBinEmitted;

    extern int minStepForRebin;

    extern int rebinFreq;

    extern int scSolveFreq;

    // How many small timesteps are inside the large timestep used in multiple time stepping (MTS) integrator
    extern int mtsSubsteps;

    // If the distance of a particle to bunch mass larger than remotePartDel times of the rms size of the bunch in any dimension,
    // the particle will be deleted artifically to hold the accuracy of space charge calculation. The default setting of -1 stands for no deletion.
    extern double remotePartDel;

    extern bool rhoDump;

    extern bool ebDump;

    extern bool csrDump;

    // the number of refinements of the search range for the phase with maximum energy
    // if eq 0 then no autophase
    // if true opal find the phases in the cavities, such that the energy gain is at maximum
    extern int autoPhase;

    // Options for the Belos solver
    extern int numBlocks;
    extern int recycleBlocks;
    extern int nLHS;

    extern bool cZero;

    extern std::string rngtype;

    extern bool enableHDF5;

    extern bool enableVTK;

    extern bool asciidump;

    // Governs how often boundp_destroy is called to destroy lost particles
    // Mainly used in the CyclotronTracker as of now -DW
    extern int boundpDestroyFreq;

    extern double beamHaloBoundary;

    extern bool cloTuneOnly;

    // Using hard edge model for calculation of path length
    extern bool idealized;

    extern bool writeBendTrajectories;

    extern int version;

    extern bool amr;

    extern int amrYtDumpFreq;

    extern int amrRegridFreq;

    extern bool memoryDump;

    extern double haloShift;

    extern unsigned int delPartFreq;

    extern bool computePercentiles;
   
    extern bool dumpBeamMatrix;

}

#endif // OPAL_Options_HH