DumpFields.h

Go to the documentation of this file.

//
// Class DumpFields
//   DumpFields dumps the static magnetic field of a Ring in a user-defined grid
//
// Copyright (c) 2016, 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_DUMPFIELDS_HH
#define OPAL_DUMPFIELDS_HH
 
#include "AbsBeamline/Component.h"
#include "AbstractObjects/Action.h"
 
#include <string>
#include <unordered_set>
 
namespace interpolation {
  class ThreeDGrid;
}
 
class Component;

class DumpFields: public Action {
 
public:
    enum {
        FILE_NAME,
        X_START,
        DX,
        X_STEPS,
        Y_START,
        DY,
        Y_STEPS,
        Z_START,
        DZ,
        Z_STEPS,
        SIZE
    };

    DumpFields();

    DumpFields(const std::string& name, DumpFields* parent);

    virtual ~DumpFields();

    virtual DumpFields* clone(const std::string& name);

    virtual void execute();

    static void writeFields(Component* field);

    void print(std::ostream& os) const;
 
private:
    virtual void writeFieldThis(Component* field);
    virtual void buildGrid();
 
    interpolation::ThreeDGrid* grid_m = nullptr;
 
    std::string filename_m;
 
    static std::unordered_set<DumpFields*> dumpsSet_m;
 
    DumpFields(const DumpFields& dump);  // disabled
    DumpFields& operator=(const DumpFields& dump);  // disabled
};
 
inline std::ostream& operator<<(std::ostream& os, const DumpFields& b) {
    b.print(os);
    return os;
}
 
#endif // ifdef OPAL_DUMPFIELDS_HH