Simulation.h

Go to the documentation of this file.

//
// Class Simulation
//   Abstract class every simulation has to implement to be able to
//   work with the optimization pilot.
//
//   To be supported the simulation code has to be called as a library taking
//   as an argument an MPI communicator specifying on which processors the
//   simulation runs.
//
//   TODO:
//     - formulate the 'simulation' part as a pipeline.. workers can simply put
//       together their own pipelines situation-dependent.
//
// Copyright (c) 2010 - 2013, Yves Ineichen, ETH Zürich
// All rights reserved
//
// Implemented as part of the PhD thesis
// "Toward massively parallel multi-objective optimization with application to
// particle accelerators" (https://doi.org/10.3929/ethz-a-009792359)
//
// 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 __SIMULATION_H__
#define __SIMULATION_H__
 
#include "Util/Types.h"
#include "Util/CmdArguments.h"
 
class Simulation {
 
public:
 
    Simulation(CmdArguments_t args)
        : args_(args)
    {}
 
    ~Simulation()
    {}
 
    CmdArguments_t getArgs() { return args_; }
 
    virtual void run() = 0;
 
    virtual void collectResults() = 0;
 
    virtual reqVarContainer_t getResults() = 0;
 
private:
    CmdArguments_t args_;
 
};
 
#endif