PvtxTable.hpp

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

#ifndef OPM_PARSER_PVTX_TABLE_HPP
#define OPM_PARSER_PVTX_TABLE_HPP

#include <opm/input/eclipse/EclipseState/Tables/ColumnSchema.hpp>
#include <opm/input/eclipse/EclipseState/Tables/SimpleTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/TableColumn.hpp>
#include <opm/input/eclipse/EclipseState/Tables/TableSchema.hpp>

#include <cstddef>
#include <string>
#include <utility>
#include <vector>

namespace Opm {

    class DeckKeyword;

} // namespace Opm

namespace Opm {

    class PvtxTable
    {
    public:
        static std::size_t numTables(const DeckKeyword& keyword);

        static std::vector<std::pair<std::size_t, std::size_t>>
        recordRanges(const DeckKeyword& keyword);

        PvtxTable() = default;

        explicit PvtxTable(const std::string& columnName);

        virtual ~PvtxTable() = default;

        static PvtxTable serializationTestObject();

        const SimpleTable& getSaturatedTable() const;

        const SimpleTable& getUnderSaturatedTable(std::size_t tableNumber) const;

        double getArgValue(std::size_t index) const;

        std::size_t size() const;

        auto begin() const { return this->m_underSaturatedTables.begin(); }

        auto cbegin() const { return this->m_underSaturatedTables.cbegin(); }

        auto end() const { return this->m_underSaturatedTables.end(); }

        auto cend() const { return this->m_underSaturatedTables.cend(); }

        bool operator==(const PvtxTable& data) const;

        template <class Serializer>
        void serializeOp(Serializer& serializer)
        {
            serializer(m_outerColumnSchema);
            serializer(m_outerColumn);
            serializer(m_underSaturatedSchema);
            serializer(m_saturatedSchema);
            serializer(m_underSaturatedTables);
            serializer(m_saturatedTable);
        }

    protected:
        ColumnSchema m_outerColumnSchema{};

        TableColumn m_outerColumn{};

        TableSchema m_underSaturatedSchema{};

        TableSchema m_saturatedSchema{};

        std::vector<SimpleTable> m_underSaturatedTables{};

        SimpleTable m_saturatedTable{};

        void init(const DeckKeyword& keyword, std::size_t tableIdx);

    private:
        void populateUndersaturatedTables(const DeckKeyword& keyword,
                                          const std::size_t  tableIdx,
                                          const std::size_t  first,
                                          const std::size_t  last);

        void populateSaturatedTable(const std::string& tableName);
    };

} // namespace Opm

#endif // OPM_PARSER_PVTX_TABLE_HPP