ConnectionEconLimits.hpp

/*
  Copyright 2026 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 OPM_CONNECTION_ECON_LIMITS_HPP
#define OPM_CONNECTION_ECON_LIMITS_HPP

#include <optional>
#include <string>

namespace Opm {

    class DeckRecord;

    struct ConnectionEconLimits
    {
        enum class EconWorkover {
            CON  = 1, // CON
            CONP = 2, // +CON
            WELL = 3,
            PLUG = 4,
        };

        static EconWorkover EconWorkoverFromString(const std::string& stringValue);

        double max_water_cut{0.0};

        double max_gas_oil_ratio{0.0};

        double max_water_gas_ratio{0.0};

        EconWorkover workover{EconWorkover::CON};

        bool check_stopped_wells{false};

        std::optional<double> min_oil_rate{};

        std::optional<double> min_gas_rate{};

        std::string followon_well{};

        ConnectionEconLimits() = default;

        explicit ConnectionEconLimits(const DeckRecord& record);

        bool operator==(const ConnectionEconLimits& other) const;
        bool operator!=(const ConnectionEconLimits& other) const
        {
            return !(*this == other);
        }

        bool onAnyEffectiveLimit() const;
        bool onMaxWaterCut() const     { return this->max_water_cut       > 0.0; }
        bool onMaxGasOilRatio() const  { return this->max_gas_oil_ratio   > 0.0; }
        bool onMaxWaterGasRatio() const{ return this->max_water_gas_ratio > 0.0; }
        bool onMinOilRate() const      { return this->min_oil_rate.has_value(); }
        bool onMinGasRate() const      { return this->min_gas_rate.has_value(); }

        static ConnectionEconLimits serializationTestObject();

        template <class Serializer>
        void serializeOp(Serializer& serializer)
        {
            serializer(this->max_water_cut);
            serializer(this->max_gas_oil_ratio);
            serializer(this->max_water_gas_ratio);
            serializer(this->workover);
            serializer(this->check_stopped_wells);
            serializer(this->min_oil_rate);
            serializer(this->min_gas_rate);
            serializer(this->followon_well);
        }
    };

} // namespace Opm

#endif // OPM_CONNECTION_ECON_LIMITS_HPP