SectorMagneticFieldMap.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2012, Chris Rogers
 *  All rights reserved.
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *  3. Neither the name of STFC nor the names of its contributors may be used to
 *     endorse or promote products derived from this software without specific
 *     prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _CLASSIC_FIELDS_SECTORMAGNETICFIELDMAP_HH_
#define _CLASSIC_FIELDS_SECTORMAGNETICFIELDMAP_HH_

#include <string>
#include <vector>
#include <map>
#include <iostream>

#include "Fields/SectorField.h"

namespace interpolation {
    class VectorMap;
    class ThreeDGrid;
}

class SectorMagneticFieldMap : public SectorField {
  public:
    SectorMagneticFieldMap(std::string file_name,
                           std::string symmetry,
                           double length_units,
                           double field_units,
                           int polynomial_order,
                           int smoothing_order);

    SectorMagneticFieldMap(const SectorMagneticFieldMap& field);

    ~SectorMagneticFieldMap();

    bool getFieldstrengthPolar
                  (const Vector_t &R_p, Vector_t &E_p, Vector_t &B_p) const;

    bool getFieldstrength
                  (const Vector_t &R_c, Vector_t &E_c, Vector_t &B_c) const;

    interpolation::VectorMap* getInterpolator();

    void setInterpolator(interpolation::VectorMap* interpolator);


    std::string getFieldMapFileName() const {return filename_m;}

    std::string getSymmetry() const;

    void setSymmetry(std::string name);

    static void clearFieldCache();

    bool getFieldDerivative(const Vector_t &R, Vector_t &E,
                                  Vector_t &B, const DiffDirection &dir) const;

    void swap();

    void getInfo(Inform* msg);

    void print(std::ostream& out);

    void readMap();

    void freeMap();

    double getFrequency() const {return 0;}

    void setFrequency(double) {}

    double getPhiOffset() const {return phiOffset_m;}

    void setPhiOffset(double dphi) {phiOffset_m = dphi;}

    double getDeltaPhi() const;

    friend class FieldMap;

  private:
    enum symmetry {none, dipole};

    bool applySymmetry(double* R_temp) const;

    static symmetry StringToSymmetry(std::string name);
    static std::string SymmetryToString(symmetry sym);

    void Rotate(double* value, double angle);

    interpolation::VectorMap* interpolator_m;
    symmetry symmetry_m;
    std::vector<double> units_m;
    const std::string filename_m;
    double phiOffset_m;
    int poly_order_m;
    int smoothing_order_m;

    static const double fractionalBBPhiTolerance_m;
    static std::map<std::string, SectorMagneticFieldMap*> _fields;
    friend class SectorMagneticFieldMapIO;

    // disabled - dont use
    SectorMagneticFieldMap& operator=(const SectorMagneticFieldMap& field);

    class IO;
};


class SectorMagneticFieldMap::IO {
  public:
    static interpolation::VectorMap* readMap(std::string file_name,
                                           std::vector<double> units,
                                           SectorMagneticFieldMap::symmetry sym,
                                           int poly_order,
                                           int smoothing_order);

  private:
    static const double floatTolerance_m;
    static const int sortOrder_m[3];

    // read and sort the lines of the map file
    static std::vector< std::vector<double> > readLines
                             (std::string file_name, std::vector<double> units);

    // generate a grid based on the input map file
    static interpolation::ThreeDGrid* generateGrid(
                         const std::vector< std::vector<double> > field_points,
                         SectorMagneticFieldMap::symmetry sym);

    // get the interpolator based on field points and grid information
    static interpolation::VectorMap* getInterpolator(
                         const std::vector< std::vector<double> > field_points,
                         interpolation::ThreeDGrid* grid,
                         SectorMagneticFieldMap::symmetry sym);

    static interpolation::VectorMap* getInterpolatorPolyPatch(
                         const std::vector< std::vector<double> > field_points,
                         interpolation::ThreeDGrid* grid,
                         SectorMagneticFieldMap::symmetry sym,
                         int poly_order,
                         int smoothing_order);

    // Compare two floats are same within tolerance
    static bool floatGreaterEqual(double in1, double in2);

    // comparator for sorting field_points by r, y, phi. Sort order is given by
    // sort_order variable
    static bool comparator
             (std::vector<double> field_item1, std::vector<double> field_item2);

    // private constructor i.e. disabled
    IO();
    // private copy constructor i.e. disabled
    IO(const IO& map);

    // private destructor i.e. disabled
    ~IO();

    static const std::string errMsg1;
};

#endif