opm-common/opm/parser/eclipse/EclipseState/Tables/TableManager.cpp

/*
  Copyright 2015 Statoil ASA.

  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/>.
 */

#include <opm/parser/eclipse/Parser/ParserKeywords.hpp>
#include <opm/parser/eclipse/Deck/Deck.hpp>
#include <opm/parser/eclipse/EclipseState/Tables/Tables.hpp>
#include <opm/parser/eclipse/OpmLog/OpmLog.hpp>

namespace Opm {

    Tables::Tables( const Deck& deck ) {
        initTabdims( deck );
        initSimpleTables(deck, "SWOF", m_swofTables);
        initSimpleTables(deck, "SGOF", m_sgofTables);
        initSimpleTables(deck, "SLGOF", m_slgofTables);
        initSimpleTables(deck, "SOF2", m_sof2Tables);
        initSimpleTables(deck, "SOF3", m_sof3Tables);
        initSimpleTables(deck, "PVDG", m_pvdgTables);
        initSimpleTables(deck, "PVDO", m_pvdoTables);
        initSimpleTables(deck, "SWFN", m_swfnTables);
        initSimpleTables(deck, "SGFN", m_sgfnTables);
        initSimpleTables(deck, "SSFN", m_ssfnTables);
        initSimpleTables(deck, "PVDS", m_pvdsTables);
        initSimpleTables(deck, "PLYADS", m_plyadsTables);
        initSimpleTables(deck, "PLYMAX", m_plymaxTables);
        initSimpleTables(deck, "PLYROCK", m_plyrockTables);
        initSimpleTables(deck, "PLYVISC", m_plyviscTables);
        initSimpleTables(deck, "PLYDHFLF", m_plydhflfTables);
        initSimpleTables(deck, "OILVISCT", m_oilvisctTables);
        initSimpleTables(deck, "WATVISCT", m_watvisctTables);

        initRocktabTables(deck);
    }


    void Tables::initTabdims(const Deck& deck) {
        /*
          The default values for the various number of tables is
          embedded in the ParserKeyword("TABDIMS") instance; however
          the EclipseState object does not have a dependency on the
          Parser classes, have therefor decided not to add an explicit
          dependency here, and instead duplicated all the default
          values.
        */
        size_t ntsfun = 1;
        size_t ntpvt = 1;
        size_t nssfun = 1;
        size_t nppvt = 1;
        size_t ntfip = 1;
        size_t nrpvt = 1;

        if (deck.hasKeyword("TABDIMS")) {
            auto keyword = deck.getKeyword("TABDIMS");
            auto record = keyword->getRecord(0);
            ntsfun = record->getItem("NTSFUN")->getInt(0);
            ntpvt  = record->getItem("NTPVT")->getInt(0);
            nssfun = record->getItem("NSSFUN")->getInt(0);
            nppvt  = record->getItem("NPPVT")->getInt(0);
            ntfip  = record->getItem("NTFIP")->getInt(0);
            nrpvt  = record->getItem("NRPVT")->getInt(0);
        }
        m_tabdims = std::make_shared<Tabdims>(ntsfun , ntpvt , nssfun , nppvt , ntfip , nrpvt);
    }


    void Tables::initRocktabTables(const Deck& deck) {
        if (!deck.hasKeyword("ROCKTAB"))
            return; // ROCKTAB is not featured by the deck...

        if (deck.numKeywords("ROCKTAB") > 1) {
            complainAboutAmbiguousKeyword(deck, "ROCKTAB");
            return;
        }

        const auto rocktabKeyword = deck.getKeyword("ROCKTAB");

        bool isDirectional = deck.hasKeyword("RKTRMDIR");
        bool useStressOption = false;
        if (deck.hasKeyword("ROCKOPTS")) {
            const auto rockoptsKeyword = deck.getKeyword("ROCKOPTS");
            useStressOption = (rockoptsKeyword->getRecord(0)->getItem("METHOD")->getTrimmedString(0) == "STRESS");
        }

        for (size_t tableIdx = 0; tableIdx < rocktabKeyword->size(); ++tableIdx) {
            if (rocktabKeyword->getRecord(tableIdx)->getItem(0)->size() == 0) {
                // for ROCKTAB tables, an empty record indicates that the previous table
                // should be copied...
                if (tableIdx == 0)
                    throw std::invalid_argument("The first table for keyword ROCKTAB"
                                                " must be explicitly defined!");
                m_rocktabTables[tableIdx] = m_rocktabTables[tableIdx - 1];
                continue;
            }

            m_rocktabTables.push_back(RocktabTable());
            m_rocktabTables[tableIdx].init(rocktabKeyword,
                                           isDirectional,
                                           useStressOption,
                                           tableIdx);
        }
    }


    std::shared_ptr<const Tabdims> Tables::getTabdims() const {
        return m_tabdims;
    }


    const std::vector<SwofTable>& Tables::getSwofTables() const {
        return m_swofTables;
    }


    const std::vector<SlgofTable>& Tables::getSlgofTables() const {
        return m_slgofTables;
    }


    const std::vector<SgofTable>& Tables::getSgofTables() const {
        return m_sgofTables;
    }

    const std::vector<Sof2Table>& Tables::getSof2Tables() const {
        return m_sof2Tables;
    }

    const std::vector<Sof3Table>& Tables::getSof3Tables() const {
        return m_sof3Tables;
    }

    const std::vector<PvdgTable>& Tables::getPvdgTables() const {
        return m_pvdgTables;
    }

    const std::vector<PvdoTable>& Tables::getPvdoTables() const {
        return m_pvdoTables;
    }

    const std::vector<SwfnTable>& Tables::getSwfnTables() const {
        return m_swfnTables;
    }

    const std::vector<SgfnTable>& Tables::getSgfnTables() const {
        return m_sgfnTables;
    }

    const std::vector<SsfnTable>& Tables::getSsfnTables() const {
        return m_ssfnTables;
    }

    const std::vector<PvdsTable>& Tables::getPvdsTables() const {
        return m_pvdsTables;
    }

    const std::vector<OilvisctTable>& Tables::getOilvisctTables() const {
        return m_oilvisctTables;
    }

    const std::vector<WatvisctTable>& Tables::getWatvisctTables() const {
        return m_watvisctTables;
    }

    const std::vector<PlyadsTable>& Tables::getPlyadsTables() const {
        return m_plyadsTables;
    }

    const std::vector<PlymaxTable>& Tables::getPlymaxTables() const {
        return m_plymaxTables;
    }

    const std::vector<PlyrockTable>& Tables::getPlyrockTables() const {
        return m_plyrockTables;
    }

    const std::vector<PlyviscTable>& Tables::getPlyviscTables() const {
        return m_plyviscTables;
    }

    const std::vector<PlydhflfTable>& Tables::getPlydhflfTables() const {
        return m_plydhflfTables;
    }

    const std::vector<RocktabTable>& Tables::getRocktabTables() const {
        return m_rocktabTables;
    }


    void Tables::complainAboutAmbiguousKeyword(const Deck& deck, const std::string& keywordName) const {
        OpmLog::addMessage(Log::MessageType::Error, "The " + keywordName + " keyword must be unique in the deck. Ignoring all!");
        auto keywords = deck.getKeywordList(keywordName);
        for (size_t i = 0; i < keywords.size(); ++i) {
            std::string msg = "Ambiguous keyword "+keywordName+" defined here";
            OpmLog::addMessage(Log::MessageType::Error , Log::fileMessage( keywords[i]->getFileName(), keywords[i]->getLineNumber(),msg));
        }
    }
}