WelspecsWrapper.hpp

Go to the documentation of this file.

/*
  Copyright (C) 2014 by Andreas Lauser

  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_PARSER_WELSPECS_WRAPPER_HPP
#define OPM_PARSER_WELSPECS_WRAPPER_HPP

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

#include <vector>
#include <algorithm>

namespace Opm {
    class WelspecsWrapper {
    public:
        WelspecsWrapper(Opm::DeckKeywordConstPtr keyword)
            : m_keyword(keyword)
        {
        }

        int numWells() const
        { return m_keyword->size(); }

        const std::string wellName(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(0)->getString(0); }

        const std::string groupName(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(1)->getString(0); }

        int coordinateI(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(2)->getInt(0); }

        int coordinateJ(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(3)->getInt(0); }

        double referenceDepth(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(4)->getSIDouble(0); }

        const std::string preferredPhase(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(5)->getString(0); }

        double drainageRadius(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(6)->getSIDouble(0); }

        const std::string inflowEquation(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(7)->getString(0); }

        bool isShut(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(8)->getString(0) == "SHUT"; }

        bool allowCrossflow(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(9)->getString(0) == "YES"; }

        int pressureTableNumber(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(10)->getInt(0); }

        const std::string hydrostaticCalculation(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(11)->getString(0); }

        int inPlaceRegionNumber(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(12)->getInt(0); }

        // items 14 and 15 are "reserved for FrontSim"

        const std::string wellModel(int wellIdx) const
        { return m_keyword->getRecord(wellIdx)->getItem(15)->getString(0); }

    private:
        Opm::DeckKeywordConstPtr m_keyword;
    };
}

#endif  // OPM_PARSER_WELSPECS_WRAPPER_HPP