UDQSet.hpp

/*
  Copyright 2019 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 UDQSET_HPP
#define UDQSET_HPP

#include <opm/input/eclipse/Schedule/UDQ/UDQEnums.hpp>

#include <cstddef>
#include <optional>
#include <stdexcept>
#include <string>
#include <unordered_map>
#include <vector>

namespace Opm {
    class RegionSetMatchResult;
    class SegmentSet;
} // namespace Opm

namespace Opm {

class UDQScalar
{
public:
    UDQScalar() = default;

    explicit UDQScalar(const double value, const std::size_t num = 0);

    explicit UDQScalar(const std::string& wgname, const std::size_t num = 0);

    void operator+=(const UDQScalar& rhs);

    void operator+=(double rhs);

    void operator*=(const UDQScalar& rhs);

    void operator*=(double rhs);

    void operator/=(const UDQScalar& rhs);

    void operator/=(double rhs);

    void operator-=(const UDQScalar& rhs);

    void operator-=(double rhs);

    operator bool() const;

    void assign(const std::optional<double>& value);

    void assign(double value);

    bool defined() const;

    double get() const;

    const std::optional<double>& value() const { return this->m_value; }

    const std::string& wgname() const { return this->m_wgname; }

    std::size_t number() const { return this->m_num; }

    bool operator==(const UDQScalar& other) const;

public:
    std::optional<double> m_value{};

    std::string m_wgname{};

    std::size_t m_num = 0;
};


class UDQSet
{
public:
    // Connections and segments.
    struct EnumeratedItems
    {
        std::string name{};
        std::vector<std::size_t> numbers{};

        bool operator==(const EnumeratedItems& rhs) const;
        static EnumeratedItems serializationTestObject();

        template <class Serializer>
        void serializeOp(Serializer& serializer)
        {
            serializer(this->name);
            serializer(this->numbers);
        }
    };

    static std::vector<EnumeratedItems>
    enumerateItems(const RegionSetMatchResult& regionSet);

    static std::vector<EnumeratedItems>
    enumerateItems(const SegmentSet& segmentSet);

    UDQSet(const std::string& name, UDQVarType var_type);

    UDQSet(const std::string& name, UDQVarType var_type,
           const std::vector<std::string>& wgnames);

    UDQSet(const std::string& name, UDQVarType var_type,
           const std::vector<EnumeratedItems>& items);

    UDQSet(const std::string& name, UDQVarType var_type, std::size_t size);

    UDQSet(const std::string& name, std::size_t size);

    static UDQSet scalar(const std::string& name,
                         const std::optional<double>& scalar_value);

    static UDQSet scalar(const std::string& name, double value);

    static UDQSet empty(const std::string& name);

    static UDQSet wells(const std::string& name,
                        const std::vector<std::string>& wells);

    static UDQSet wells(const std::string& name,
                        const std::vector<std::string>& wells,
                        double scalar_value);

    static UDQSet groups(const std::string& name,
                         const std::vector<std::string>& groups);

    static UDQSet groups(const std::string& name,
                         const std::vector<std::string>& groups,
                         double scalar_value);

    static UDQSet field(const std::string& name, double scalar_value);

    static UDQSet segments(const std::string&                  name,
                           const std::vector<EnumeratedItems>& segments);
    static UDQSet segments(const std::string&                  name,
                           const std::vector<EnumeratedItems>& segments,
                           const double                        scalar_value);

    static UDQSet regions(const std::string&                  name,
                          const std::vector<EnumeratedItems>& regSetColl);
    static UDQSet regions(const std::string&                  name,
                          const std::vector<EnumeratedItems>& regSetColl,
                          const double                        scalar_value);

    void assign(const std::optional<double>& value);

    void assign(std::size_t index, const std::optional<double>& value);

    void assign(const std::string& wgname, const std::optional<double>& value);

    void assign(const std::string& wgname, std::size_t number, const std::optional<double>& value);

    void assign(double value);

    void assign(std::size_t index, double value);

    void assign(const std::string& wgname, double value);

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

    std::size_t size() const;

    void operator+=(const UDQSet& rhs);

    void operator+=(double rhs);

    void operator-=(const UDQSet& rhs);

    void operator-=(double rhs);

    void operator*=(const UDQSet& rhs);

    void operator*=(double rhs);

    void operator/=(const UDQSet& rhs);

    void operator/=(double rhs);

    const UDQScalar& operator[](std::size_t index) const;

    const UDQScalar& operator[](const std::string& wgname) const;

    const UDQScalar& operator()(const std::string& well, const std::size_t item) const;

    std::vector<UDQScalar>::const_iterator begin() const;

    std::vector<UDQScalar>::const_iterator end() const;

    std::vector<std::string> wgnames() const;

    std::vector<double> defined_values() const;

    std::size_t defined_size() const;

    const std::string& name() const;

    void name(const std::string& name);

    UDQVarType var_type() const;

    bool operator==(const UDQSet& other) const;

private:
    std::string m_name;

    UDQVarType m_var_type = UDQVarType::NONE;

    std::vector<UDQScalar> values;

    UDQSet() = default;
};


UDQScalar operator+(const UDQScalar& lhs, const UDQScalar& rhs);
UDQScalar operator+(const UDQScalar& lhs, double rhs);
UDQScalar operator+(double lhs, const UDQScalar& rhs);

UDQScalar operator-(const UDQScalar& lhs, const UDQScalar& rhs);
UDQScalar operator-(const UDQScalar& lhs, double rhs);
UDQScalar operator-(double lhs, const UDQScalar& rhs);

UDQScalar operator*(const UDQScalar& lhs, const UDQScalar& rhs);
UDQScalar operator*(const UDQScalar& lhs, double rhs);
UDQScalar operator*(double lhs, const UDQScalar& rhs);

UDQScalar operator/(const UDQScalar& lhs, const UDQScalar& rhs);
UDQScalar operator/(const UDQScalar& lhs, double rhs);
UDQScalar operator/(double lhs, const UDQScalar& rhs);

UDQSet operator+(const UDQSet& lhs, const UDQSet& rhs);
UDQSet operator+(const UDQSet& lhs, double rhs);
UDQSet operator+(double lhs, const UDQSet& rhs);

UDQSet operator-(const UDQSet& lhs, const UDQSet& rhs);
UDQSet operator-(const UDQSet& lhs, double rhs);
UDQSet operator-(double lhs, const UDQSet& rhs);

UDQSet operator*(const UDQSet& lhs, const UDQSet& rhs);
UDQSet operator*(const UDQSet& lhs, double rhs);
UDQSet operator*(double lhs, const UDQSet& rhs);

UDQSet operator/(const UDQSet& lhs, const UDQSet& rhs);
UDQSet operator/(const UDQSet& lhs, double rhs);
UDQSet operator/(double lhs, const UDQSet&rhs);

} // namespace Opm

#endif  // UDQSET_HPP