GSatProd.hpp

/*
  Copyright 2024 Equinor 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 GSATPROD_H
#define GSATPROD_H

#include <opm/input/eclipse/Deck/UDAValue.hpp>
#include <opm/input/eclipse/Units/UnitSystem.hpp>

#include <array>
#include <cstddef>
#include <map>
#include <string>

namespace Opm {

    class SummaryState;

    class GSatProd
    {
    public:
        struct GSatProdGroup
        {
            std::array<UDAValue, 5> rate{};

            double udq_undefined;

            bool operator==(const GSatProdGroup& data) const {
                return rate == data.rate &&
                       udq_undefined == data.udq_undefined;
            }

            template<class Serializer>
            void serializeOp(Serializer& serializer)
            {
                serializer(rate);
                serializer(udq_undefined);
            }
        };

        struct GSatProdGroupProp {
            enum Rate { Oil, Gas, Water, Resv, GLift, };

            std::array<double, 5> rate{};
        };

        static GSatProd serializationTestObject();

        void assign(const std::string& name,
                    const UDAValue&    oil_rate,
                    const UDAValue&    gas_rate,
                    const UDAValue&    water_rate,
                    const UDAValue&    resv_rate,
                    const UDAValue&    glift_rate,
                    double             udq_undefined);

        bool has(const std::string& name) const;

        const GSatProdGroup& get(const std::string& name) const;

        const GSatProdGroupProp get(const std::string& name,
                                    const SummaryState& st) const;

        bool empty() const { return this->size() == 0; }

        std::size_t size() const;

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

        template<class Serializer>
        void serializeOp(Serializer& serializer)
        {
            serializer(groups_);
        }

    private:
        std::map<std::string, GSatProdGroup> groups_;
    };

} // namespace Opm

#endif // GSATPROD_H