Options.h

Go to the documentation of this file.

#ifndef OPTIONS_HH
#define OPTIONS_HH

// ------------------------------------------------------------------------
// $RCSfile: Options.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Struct: Options
//
// ------------------------------------------------------------------------
//
// $Date: 2000/03/27 09:33:48 $
// $Author: Andreas Adelmann $
//
// ------------------------------------------------------------------------


// Namespace Options.
// ------------------------------------------------------------------------
//  This namespace contains the global option flags.

#include "OptionTypes.h"
#include "Utilities/ClassicRandom.h"

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 warning messages.
    extern bool warn;

    extern int warnLevel;

    extern bool csrDump;

    //  If true, use special initial velocity distribution for parallel plate and print special debug output .
    extern bool ppdebug;

    extern bool cZero;

    extern bool enableHDF5;

    extern bool asciidump;

    // 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 double beamHaloBoundary;

    extern bool writeBendTrajectories;

    extern bool idealized;

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

    //  The global random generator.
    extern Random rangen;

    extern int seed;

    extern int psDumpFreq;

    extern int statDumpFreq;

    extern int sptDumpFreq;

    extern int repartFreq;

    extern int minBinEmitted;

    extern int minStepForRebin;

    extern int rebinFreq;

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

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

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

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

    extern bool rhoDump;

    extern bool ebDump;

    // if true opal find the phases in the cavities, such that the energy gain is at maximum
    extern int autoPhase;

    extern int surfDumpFreq;

    extern int numBlocks;

    extern int recycleBlocks;

    extern int nLHS;

    extern std::string rngtype;

    extern bool cloTuneOnly;

    extern int version;

#ifdef ENABLE_AMR
    extern bool amr;

    extern int amrYtDumpFreq;
    
    extern int amrRegridFreq;
#endif

    extern bool memoryDump;

    extern double haloShift;

    extern unsigned int delPartFreq;
}

#endif // OPAL_Options_HH