UDQConfig.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 UDQINPUT_HPP_
#define UDQINPUT_HPP_

#include <opm/input/eclipse/Schedule/UDQ/UDQAssign.hpp>
#include <opm/input/eclipse/Schedule/UDQ/UDQDefine.hpp>
#include <opm/input/eclipse/Schedule/UDQ/UDQEnums.hpp>
#include <opm/input/eclipse/Schedule/UDQ/UDQFunctionTable.hpp>
#include <opm/input/eclipse/Schedule/UDQ/UDQInput.hpp>
#include <opm/input/eclipse/Schedule/UDQ/UDQParams.hpp>
#include <opm/input/eclipse/Schedule/UDQ/UDT.hpp>

#include <opm/input/eclipse/EclipseState/Util/OrderedMap.hpp>
#include <opm/input/eclipse/EclipseState/Util/IOrderSet.hpp>

#include <array>
#include <cstddef>
#include <functional>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <unordered_map>
#include <unordered_set>
#include <utility>
#include <vector>

namespace Opm {

    class DeckRecord;
    class KeywordLocation;
    class GroupOrder;
    class RegionSetMatcher;
    class Schedule;
    class SegmentMatcher;
    class SummaryState;
    class UDQState;
    class WellMatcher;

} // namespace Opm

namespace Opm::RestartIO {
    struct RstState;
    class  RstUDQ;
} // namespace Opm::RestartIO

namespace Opm {

    class UDQConfig
    {
    public:
        class DynamicSelector
        {
        public:
            class StringRange
            {
            public:
                using Iter = std::vector<std::string>::const_iterator;

                StringRange() = default;

                StringRange(Iter first, Iter last)
                    : first_ { first }
                    , last_  { last }
                {}

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

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

                std::vector<std::string> asVector() const
                {
                    return { this->begin(), this->end() };
                }

            private:
                Iter first_{};

                Iter last_{};
            };

            DynamicSelector() = default;

            DynamicSelector& wells(std::vector<std::string>::const_iterator first,
                                   std::vector<std::string>::const_iterator last)
            {
                this->wells_.emplace(first, last);
                return *this;
            }

            DynamicSelector& wells(const StringRange& srange)
            {
                this->wells_.emplace(srange);
                return *this;
            }

            const std::optional<StringRange> wells() const
            {
                return this->wells_;
            }

        private:
            std::optional<StringRange> wells_{};
        };

        using RegionSetMatcherFactory = std::function<std::unique_ptr<RegionSetMatcher>()>;

        using SegmentMatcherFactory = std::function<std::unique_ptr<SegmentMatcher>()>;

        UDQConfig() = default;

        explicit UDQConfig(const UDQParams& params);

        UDQConfig(const UDQParams& params, const RestartIO::RstState& rst_state);

        static UDQConfig serializationTestObject();

        const std::string& unit(const std::string& key) const;

        bool has_unit(const std::string& keyword) const;

        bool has_keyword(const std::string& keyword) const;

        std::optional<std::string>
        add_record(SegmentMatcherFactory                 create_segment_matcher,
                   const DeckRecord&                     record,
                   const KeywordLocation&                location,
                   std::size_t                           report_step,
                   const std::optional<DynamicSelector>& dynamic_selector = std::nullopt);

        void add_unit(const std::string& keyword,
                      const std::string& unit);

        void add_update(const std::string&              keyword,
                        std::size_t                     report_step,
                        const KeywordLocation&          location,
                        const std::vector<std::string>& data);

        void add_assign(const std::string&                    quantity,
                        SegmentMatcherFactory                 create_segment_matcher,
                        const std::vector<std::string>&       selector,
                        double                                value,
                        std::size_t                           report_step,
                        const std::optional<DynamicSelector>& dynamic_selector = std::nullopt);

        void add_define(const std::string&              quantity,
                        const KeywordLocation&          location,
                        const std::vector<std::string>& expression,
                        std::size_t                     report_step);

        void add_table(const std::string& name, UDT udt);

        bool clear_pending_assignments();

        bool clear_update_next_for_new_report_step();

        void eval_assign(const WellMatcher&    wm,
                         const GroupOrder&     go,
                         SegmentMatcherFactory create_segment_matcher,
                         SummaryState&         st,
                         UDQState&             udq_state) const;

        void eval(std::size_t             report_step,
                  const WellMatcher&      wm,
                  const GroupOrder&       go,
                  SegmentMatcherFactory   create_segment_matcher,
                  RegionSetMatcherFactory create_region_matcher,
                  SummaryState&           st,
                  UDQState&               udq_state) const;

        const UDQDefine& define(const std::string& key) const;

        const UDQAssign& assign(const std::string& key) const;

        std::vector<UDQDefine> definitions() const;

        std::vector<UDQDefine> definitions(UDQVarType var_type) const;

        std::vector<UDQInput> input() const;

        void exportTypeCount(std::array<int, static_cast<std::size_t>(UDQVarType::NumTypes)>& count) const;

        std::size_t size() const;

        UDQInput operator[](const std::string& keyword) const;

        UDQInput operator[](std::size_t insert_index) const;

        std::vector<UDQAssign> assignments() const;

        std::vector<UDQAssign> assignments(UDQVarType var_type) const;

        const UDQParams& params() const;

        const UDQFunctionTable& function_table() const;

        const std::unordered_map<std::string, UDT>& tables() const;

        bool operator==(const UDQConfig& config) const;

        void required_summary(std::unordered_set<std::string>& summary_keys) const;

        template<class Serializer>
        void serializeOp(Serializer& serializer)
        {
            serializer(udq_params);
            serializer(m_definitions);
            serializer(m_assignments);
            serializer(m_tables);
            serializer(units);
            serializer(define_order);
            serializer(input_index);
            serializer(type_count);
            serializer(pending_assignments_);

            // The UDQFunction table is constant up to udq_params, so we can
            // just construct a new instance here.
            if (!serializer.isSerializing()) {
                udqft = UDQFunctionTable(udq_params);
            }
        }

    private:
        UDQParams udq_params;

        UDQFunctionTable udqft;

        // The following data structures are constrained by compatibility
        // requirements in our simulation restart files.  In particular we
        // need to control the keyword ordering.  In this class the ordering
        // is maintained mainly by the input_index map which tracks the
        // insertion order of each keyword and whether the keyword (UDQ
        // name) is currently DEFINE'ed or ASSIGN'ed.

        std::unordered_map<std::string, UDQDefine> m_definitions{};

        std::unordered_map<std::string, UDQAssign> m_assignments{};

        std::unordered_map<std::string, UDT> m_tables{};

        std::unordered_map<std::string, std::string> units{};

        IOrderSet<std::string> define_order;

        OrderedMap<UDQIndex> input_index;

        std::map<UDQVarType, std::size_t> type_count{};

        mutable std::vector<std::string> pending_assignments_{};

        void add_node(const std::string& quantity, UDQAction action);

        void add_assign(const RestartIO::RstUDQ& udq, const std::size_t report_step);

        void add_define(const RestartIO::RstUDQ& udq, const std::size_t report_step);

        void eval_assign(UDQContext& context) const;

        void eval_define(std::size_t     report_step,
                         const UDQState& udq_state,
                         UDQContext&     context) const;

        void add_enumerated_assign(const std::string&              quantity,
                                   SegmentMatcherFactory           create_segment_matcher,
                                   const std::vector<std::string>& selector,
                                   double                          value,
                                   std::size_t                     report_step);

        void add_assign_wellvar(const std::string&                    quantity,
                                const std::vector<std::string>&       selector,
                                double                                value,
                                std::size_t                           report_step,
                                const std::optional<DynamicSelector>& dynamic_selector);

        template <typename... Args>
        void add_assign_impl(const std::string& quantity,
                             Args&&...          args)
        {
            // Note: Duplicate 'quantity' arguments is intentional here.
            // The first is the key in 'm_assignments', while the second is
            // the first argument to the UDQAssign constructor.
            const auto& [asgnPos, inserted] =
                this->m_assignments.try_emplace(quantity, quantity, args...);

            if (! inserted) {
                // We already have an assignment object for 'quantity'.  Add
                // a new assignment record to that object.
                asgnPos->second.add_record(std::forward<Args>(args)...);
            }
        }
    };

} // namespace Opm

#endif // UDQINPUT_HPP_