FIPRegionStatistics.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 FIP_REGION_STATISTICS_HPP
#define FIP_REGION_STATISTICS_HPP

#include <cstddef>
#include <functional>
#include <string>
#include <string_view>
#include <vector>


namespace Opm {
    class FieldPropsManager;
} // namespace Opm

namespace Opm {

    class FIPRegionStatistics
    {
    public:
        FIPRegionStatistics() = default;

        explicit FIPRegionStatistics(const std::size_t                      declaredMaxRegID,
                                     const FieldPropsManager&               fldPropsMgr,
                                     std::function<void(std::vector<int>&)> computeGlobalMax);

        bool operator==(const FIPRegionStatistics& that) const;

        static FIPRegionStatistics serializationTestObject();

        int declaredMaximumRegionID() const
        {
            return this->minimumMaximumRegionID_;
        }

        const std::vector<std::string>& regionSets() const
        {
            return this->regionSets_;
        }

        int maximumRegionID(std::string_view regionSet) const;

        template <typename Serializer>
        void serializeOp(Serializer& serializer)
        {
            serializer(this->minimumMaximumRegionID_);
            serializer(this->regionSets_);
            serializer(this->maxRegionID_);
        }

    private:
        int minimumMaximumRegionID_{};

        std::vector<std::string> regionSets_{};

        std::vector<int> maxRegionID_{};
    };
} // namespace Opm

#endif // FIP_REGION_STATISTICS_HPP