OutputWriter.hpp

Go to the documentation of this file.

/*
  Copyright (c) 2013 Uni Research AS

  This file is part of the Open Porous Media project (OPM).

  OPM 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.

  OPM is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef OPM_OUTPUT_WRITER_HPP
#define OPM_OUTPUT_WRITER_HPP

#include <memory>  // unique_ptr, shared_ptr
#include <opm/core/simulator/SimulatorTimerInterface.hpp>

struct UnstructuredGrid;

namespace Opm {

// forward declaration
class EclipseState;
namespace parameter { class ParameterGroup; }
class SimulatorState;
class WellState;
struct PhaseUsage;

class OutputWriter {
public:
    virtual ~OutputWriter () { }

    virtual void writeInit(const SimulatorTimerInterface &timer) = 0;

    virtual void writeTimeStep(const SimulatorTimerInterface& timer,
                               const SimulatorState& reservoirState,
                               const WellState& wellState,
                               bool  isSubstep) = 0;

    static std::unique_ptr <OutputWriter>
    create (const parameter::ParameterGroup& params,
            std::shared_ptr <const EclipseState> eclipseState,
            const Opm::PhaseUsage &phaseUsage,
            std::shared_ptr <const UnstructuredGrid> grid);
};

} // namespace Opm

#endif /* OPM_OUTPUT_WRITER_HPP */