SgofTable.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_SGOF_TABLE_HPP
#define OPM_PARSER_SGOF_TABLE_HPP

#include "SimpleTable.hpp"

namespace Opm {
    // forward declaration
    class TableManager;

    class SgofTable : public SimpleTable {
        friend class TableManager;

        void init(Opm::DeckItemConstPtr item)
        {
            SimpleTable::init(item,
                              std::vector<std::string>{"SG", "KRG", "KROG", "PCOG"});

            SimpleTable::checkNonDefaultable("SG");
            SimpleTable::checkMonotonic("SG", /*isAscending=*/true);
            SimpleTable::applyDefaultsLinear("KRG");
            SimpleTable::applyDefaultsLinear("KROG");
            SimpleTable::applyDefaultsLinear("PCOG");
        }

    public:
        SgofTable() = default;

#ifdef BOOST_TEST_MODULE
        // DO NOT TRY TO CALL THIS METHOD! it is only for the unit tests!
        void initFORUNITTESTONLY(Opm::DeckItemConstPtr item)
        { init(item); }
#endif

        using SimpleTable::numTables;
        using SimpleTable::numRows;
        using SimpleTable::numColumns;
        using SimpleTable::evaluate;

        const std::vector<double> &getSgColumn() const
        { return SimpleTable::getColumn(0); }

        const std::vector<double> &getKrgColumn() const
        { return SimpleTable::getColumn(1); }

        const std::vector<double> &getKrogColumn() const
        { return SimpleTable::getColumn(2); }

        // this column is p_g - p_o (non-wetting phase pressure minus
        // wetting phase pressure for a given gas saturation. the name
        // is inconsistent, but it is the one used in the Eclipse
        // manual...)
        const std::vector<double> &getPcogColumn() const
        { return SimpleTable::getColumn(3); }
    };
}

#endif