EclipseWriter.hpp

Go to the documentation of this file.

/*
  Copyright (c) 2013 Andreas Lauser
  Copyright (c) 2013 Uni Research AS
  Copyright (c) 2014 IRIS 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_ECLIPSE_WRITER_HPP
#define OPM_ECLIPSE_WRITER_HPP

#include <opm/core/io/OutputWriter.hpp>
#include <opm/core/props/BlackoilPhases.hpp>
#include <opm/core/wells.h> // WellType
#include <opm/core/simulator/SimulatorTimerInterface.hpp>

#include <opm/parser/eclipse/EclipseState/EclipseState.hpp>

#include <string>
#include <vector>
#include <array>
#include <memory>

struct UnstructuredGrid;

namespace Opm {

// forward declarations
namespace EclipseWriterDetails {
class Summary;
}

class SimulatorState;
class WellState;

namespace parameter { class ParameterGroup; }

class EclipseWriter : public OutputWriter
{
public:
    EclipseWriter(const parameter::ParameterGroup& params,
                  Opm::EclipseStateConstPtr eclipseState,
                  const Opm::PhaseUsage &phaseUsage,
                  int numCells,
                  const int* compressedToCartesianCellIdx);

    virtual ~EclipseWriter ();

    virtual void writeInit(const SimulatorTimerInterface &timer);

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


    static int eclipseWellTypeMask(WellType wellType, WellInjector::TypeEnum injectorType);
    static int eclipseWellStatusMask(WellCommon::StatusEnum wellStatus);
    static ert_ecl_unit_enum convertUnitTypeErtEclUnitEnum(UnitSystem::UnitType unit);

private:
    Opm::EclipseStateConstPtr eclipseState_;
    int numCells_;
    std::array<int, 3> cartesianSize_;
    const int* compressedToCartesianCellIdx_;
    std::vector< int > gridToEclipseIdx_;
    double deckToSiPressure_;
    double deckToSiTemperatureFactor_;
    double deckToSiTemperatureOffset_;
    bool enableOutput_;
    int writeStepIdx_;
    int reportStepIdx_;
    std::string outputDir_;
    std::string baseName_;
    PhaseUsage phaseUsage_; // active phases in the input deck
    std::shared_ptr<EclipseWriterDetails::Summary> summary_;

    void init(const parameter::ParameterGroup& params);
};

typedef std::shared_ptr<EclipseWriter> EclipseWriterPtr;
typedef std::shared_ptr<const EclipseWriter> EclipseWriterConstPtr;

} // namespace Opm


#endif // OPM_ECLIPSE_WRITER_HPP