DumpEMFields.h

Go to the documentation of this file.

//
// Class DumpEMFields
//   DumpEMFields dumps the dynamically changing fields of a Ring in a user-
//   defined grid.
//
// Copyright (c) 2017, Chris Rogers
// 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 OPAL_BASICACTIONS_DUMPEMFIELDS_HH
#define OPAL_BASICACTIONS_DUMPEMFIELDS_HH
 
#include <memory>
#include <set>
#include <string>
#include <unordered_set>
#include "AbsBeamline/Component.h"
#include "AbstractObjects/Action.h"
#include "Fields/Interpolation/NDGrid.h"
 
namespace interpolation {
    class NDGrid;
}
class Component;
 
class DumpEMFields : public Action {
public:
    enum {
        FILE_NAME,
        COORDINATE_SYSTEM,
        X_START,
        DX,
        X_STEPS,
        Y_START,
        DY,
        Y_STEPS,
        Z_START,
        DZ,
        Z_STEPS,
        T_START,
        DT,
        T_STEPS,
        R_START,
        DR,
        R_STEPS,
        PHI_START,
        DPHI,
        PHI_STEPS,
        CYL_ORIGIN_X,
        CYL_ORIGIN_Y,
        CYL_ORIGIN_Z,
        SIZE
    };
 
    DumpEMFields();
 
    DumpEMFields(const std::string& name, DumpEMFields* parent);
 
    ~DumpEMFields() override = default;
 
    DumpEMFields* clone(const std::string& name) override;
 
    void execute() override;
 
    static void writeFields(const std::set<std::shared_ptr<Component>>& elements);
 
    void print(std::ostream& os) const override;
 
    /* For use only by unit tests, simulate a grid failures */
    static void failGrid() {
        for (auto& g : dumpsSet_m) {
            g->grid_m.reset();
        }
    }
    /* For use only by unit tests, simulate file write failures */
    static void failWrite() {
        for (auto& g : dumpsSet_m) {
            g->failWrite_m = true;
        }
    }
    /* For use only by unit tests, clear the set of dump objects */
    static void clearDumps() { dumpsSet_m.clear(); }
 
private:
    enum class CoordinateSystem : unsigned short { CARTESIAN, CYLINDRICAL };
 
    virtual void writeFieldThis(const std::set<std::shared_ptr<Component>>& elements);
    virtual void buildGrid();
    void parseCoordinateSystem();
    static void checkInt(double value, const std::string& name, double tolerance = 1e-9);
    void writeHeader(std::ofstream& fout) const;
    void writeFieldLine(
            const std::set<std::shared_ptr<Component>>& elements, const Vector_t<double, 3>& point,
            const double& time, std::ofstream& fout) const;
 
    std::unique_ptr<interpolation::NDGrid> grid_m{};
    Vector_t<double, 3> cylindricalOrigin_m{};
    std::string filename_m{};
 
    CoordinateSystem coordinates_m{CoordinateSystem::CARTESIAN};
 
    static std::unordered_set<std::unique_ptr<DumpEMFields>> dumpsSet_m;
 
    DumpEMFields(const DumpEMFields& dump)            = delete;
    DumpEMFields& operator=(const DumpEMFields& dump) = delete;
 
    // For use only by unit tests
    bool failWrite_m{false};
};
 
inline std::ostream& operator<<(std::ostream& os, const DumpEMFields& b) {
    b.print(os);
    return os;
}
 
#endif  // ifdef OPAL_BASICACTIONS_DUMPEMFIELDS_HH