DumpFields.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2016, 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 OPAL_DUMPFIELDS_HH
#define OPAL_DUMPFIELDS_HH

#include <unordered_set>
#include <string>
#include "AbstractObjects/Action.h"

namespace interpolation {
  class ThreeDGrid;
}

class Component;

class DumpFields : public Action {
  public:
    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);

  private:
    virtual void writeFieldThis(Component* field);
    virtual void buildGrid();
    static void checkInt(double value, std::string name, double tolerance = 1e-9);

    interpolation::ThreeDGrid* grid_m = NULL;
    std::string filename_m = "";

    static std::unordered_set<DumpFields*> dumpsSet_m;
    static std::string dumpfields_docstring;

    DumpFields(const DumpFields& dump);  // disabled
    DumpFields& operator=(const DumpFields& dump);  // disabled
};

#endif // ifdef OPAL_DUMPFIELDS_HH