OpalSimulation.h

Go to the documentation of this file.

//
// Class OpalSimulation
//   Concrete implementation of an Opal simulation wrapper.
//
// Copyright (c) 2017, Paul Scherrer Institute, Villigen PSI, Switzerland
// 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 __OPALSIMULATION_H__
#define __OPALSIMULATION_H__
 
#include <map>
#include <string>
 
#include "mpi.h"
 
#include "Simulation/GenerateOpalSimulation.h"
#include "Simulation/Simulation.h"
#include "Util/CmdArguments.h"
#include "Util/Types.h"
 
class OpalSimulation : public Simulation {
 
public:
 
    OpalSimulation(Expressions::Named_t objectives,
                   Expressions::Named_t constraints,
                   Param_t params, std::string name, MPI_Comm comm,
                   CmdArguments_t args,
                   std::map<std::string, std::string> uvars);
 
    virtual ~OpalSimulation();
 
    void run();
 
    std::map<std::string, std::vector<double> > getData(const std::vector<std::string>& statVariables);
 
    void collectResults();
 
    void cleanUp();
 
    void cleanUp(const std::vector<std::string>& keep);
 
    reqVarContainer_t getResults() { return requestedVars_; }
 
    void setFilename(int id) { id_m = id; }
 
private:
 
    std::string simulationName_;
    std::string simulationDirName_;
    std::string simTmpDir_;
 
    std::string pwd_;
 
    std::streambuf* strm_buffer_;
    std::streambuf* strm_err_;
 
    std::map<std::string, std::string> userVariables_;
 
    reqVarContainer_t requestedVars_;
 
    Expressions::Named_t objectives_;
    Expressions::Named_t constraints_;
    std::set<std::string> dvarNames_;
 
    MPI_Comm comm_;
 
    std::unique_ptr<GenerateOpalSimulation> gs_;
 
    int id_m;
 
    void invalidBunch();
 
    bool hasResultsAvailable();
 
    void createSymlink_m(const std::string& path);
 
    void copyH5_m();
 
    void setupSimulation();
 
    void setupFSStructure();
 
    void getVariableDictionary(variableDictionary_t& dictionary,
                               const std::string& filename,
                               const Expressions::Expr_t* const expression);
 
    void redirectOutToFile();
    void restoreOut();
};
 
#endif