Fieldmap.h

Go to the documentation of this file.

#ifndef CLASSIC_FIELDMAP_HH
#define CLASSIC_FIELDMAP_HH

#define READ_BUFFER_LENGTH 256

#include <string>
#include <map>
#include <vector>
#include "Algorithms/Vektor.h"
#include "Fields/Definitions.h"

#include "gsl/gsl_interp.h"
#include "gsl/gsl_spline.h"

enum MapType {
    UNKNOWN = 0,
    T1DDynamic,
    TAstraDynamic,
    T1DElectroStatic,
    TAstraElectroStatic,
    T1DMagnetoStatic,
    TAstraMagnetoStatic,
    T1DProfile1,
    T1DProfile2,
    T2DDynamic,
    T2DDynamic_cspline,
    T2DElectroStatic,
    T2DElectroStatic_cspline,
    T2DMagnetoStatic,
    T2DMagnetoStatic_cspline,
    T3DDynamic,
    T3DElectroStatic,
    T3DMagnetoStatic,
    T3DMagnetoStatic_Extended,
    T3DMagnetoStaticH5Block,
    T3DDynamicH5Block
};

enum SwapType {

    XZ = 0,
    ZX,
    XYZ = 10,
    XZMY,
    XMYMZ,
    XMZY,
    YMXZ,
    MXMYZ,
    MYXZ,
    ZYMX,
    MXYMZ,
    MZYX
};

enum DiffDirection {
    DX = 0,
    DY,
    DZ
};

class _Fieldmap {

public:

    static Fieldmap getFieldmap(std::string Filename, bool fast = false);
    static std::vector<std::string> getListFieldmapNames();
    static void deleteFieldmap(std::string Filename);
    static void clearDictionary();
    static MapType readHeader(std::string Filename);
    static void readMap(std::string Filename);
    static void freeMap(std::string Filename);

    static std::string typeset_msg(const std::string &msg, const std::string &title);

    // Note: getFieldstrength() returns true if R is outside of the field!
    virtual bool getFieldstrength(const Vector_t &R, Vector_t &E, Vector_t &B) const = 0;
    virtual bool getFieldDerivative(const Vector_t &R, Vector_t &E, Vector_t &B, const DiffDirection &dir) const = 0;
    virtual void getFieldDimensions(double &zBegin, double &zEnd) const = 0;
    virtual void getFieldDimensions(double &xIni, double &xFinal, double &yIni, double &yFinal, double &zIni, double &zFinal) const = 0;
    virtual void swap() = 0;
    virtual void getInfo(Inform *msg) = 0;
    virtual double getFrequency() const = 0;
    virtual void setFrequency(double freq) = 0;
    virtual void setEdgeConstants(const double &bendAngle, const double &entranceAngle, const double &exitAngle);
    virtual void setFieldLength(const double &);

    virtual void get1DProfile1EngeCoeffs(std::vector<double> &engeCoeffsEntry,
                                         std::vector<double> &engeCoeffsExit);
    virtual void get1DProfile1EntranceParam(double &entranceParameter1,
                                           double &entranceParameter2,
                                           double &entranceParameter3);
    virtual void get1DProfile1ExitParam(double &exitParameter1,
                                       double &exitParameter2,
                                       double &exitParameter3);
    virtual double getFieldGap();
    virtual void setFieldGap(double gap);

    MapType getType() { return Type;}

    virtual void getOnaxisEz(std::vector<std::pair<double, double> > & onaxis);

    virtual bool isInside(const Vector_t &/*r*/) const { return true; }

    virtual void readMap() = 0;
    virtual void freeMap() = 0;

protected:
    _Fieldmap () = delete;

    _Fieldmap(const std::string& filename)
        : Filename_m(filename),
        lines_read_m(0),
        normalize_m(true) { };

    virtual ~_Fieldmap() { ;};
    MapType Type;

    std::string Filename_m;
    int lines_read_m;

    bool normalize_m;
    void getLine(std::ifstream & in, std::string & buffer) {
        getLine(in, lines_read_m, buffer);
    }

    static void getLine(std::ifstream &in, int &lines_read, std::string &buffer);

    template<class S>
    bool interpretLine(std::ifstream &in, S &value, const bool &file_length_known = true);
    template<class S, class T>
    bool interpretLine(std::ifstream &in, S &value1, T &value2, const bool &file_length_known = true);
    template<class S, class T, class U>
    bool interpretLine(std::ifstream &in, S &value1, T &value2, U &value3, const bool &file_length_known = true);
    template<class S, class T, class U, class V>
    bool interpretLine(std::ifstream &in, S &value1, T &value2, U &value3, V &value4, const bool &file_length_known = true);
    template<class S>
    bool interpretLine(std::ifstream &in, S &value1, S &value2, S &value3, S &value4, S &value5, S &value6, const bool &file_length_known = true);

    bool interpreteEOF(std::ifstream &in);

    void interpretWarning(const std::ios_base::iostate &state,
                          const bool &read_all,
                          const std::string &error_msg,
                          const std::string &found);
    void missingValuesWarning();
    void exceedingValuesWarning();

    void disableFieldmapWarning();
    void noFieldmapWarning();

    void lowResolutionWarning(double squareError, double maxError);

    void checkMap(unsigned int accuracy,
                  std::pair<double, double> fieldDimensions,
                  double deltaZ,
                  const std::vector<double> &fourierCoefficients,
                  gsl_spline *splineCoefficients,
                  gsl_interp_accel *splineAccelerator);

    void checkMap(unsigned int accuracy,
                  double length,
                  const std::vector<double> &zSampling,
                  const std::vector<double> &fourierCoefficients,
                  gsl_spline *splineCoefficients,
                  gsl_interp_accel *splineAccelerator);

    void write3DField(unsigned int nx,
                      unsigned int ny,
                      unsigned int nz,
                      const std::pair<double, double> &xrange,
                      const std::pair<double, double> &yrange,
                      const std::pair<double, double> &zrange,
                      const std::vector<Vector_t> &ef,
                      const std::vector<Vector_t> &bf);

private:
    template<typename T>
    struct TypeParseTraits {
        static const char *name;
    };

    static char buffer_m[READ_BUFFER_LENGTH];
    static std::string alpha_numeric;

    struct FieldmapDescription {
        MapType Type;
        Fieldmap Map;
        unsigned int RefCounter;
        bool read;
        FieldmapDescription(MapType aType, Fieldmap aMap):
            Type(aType),
            Map(aMap),
            RefCounter(1),
            read(false)
        { }
    };

    static std::map<std::string, FieldmapDescription> FieldmapDictionary;

};

#endif