NameOrder.hpp

/*
  Copyright 2021 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 NAME_ORDER_HPP
#define NAME_ORDER_HPP

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

namespace Opm {

// The purpose of this small class is to ensure that well and group name
// always come in the order they are defined in the deck.

class NameOrder
{
public:
    NameOrder() = default;
    explicit NameOrder(std::initializer_list<std::string> names);
    explicit NameOrder(const std::vector<std::string>& names);

    void add(const std::string& name);
    std::vector<std::string> sort(std::vector<std::string> names) const;
    const std::vector<std::string>& names() const;
    bool has(const std::string& wname) const;

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

    static NameOrder serializationTestObject();

    const std::string& operator[](std::size_t index) const;
    bool operator==(const NameOrder& other) const;

    auto begin() const { return this->m_name_list.begin(); }
    auto end()   const { return this->m_name_list.end(); }
    auto size()  const { return this->m_name_list.size(); }

private:
    std::unordered_map<std::string, std::size_t> m_index_map;
    std::vector<std::string> m_name_list;
};

class GroupOrder
{
public:
    GroupOrder() = default;

    explicit GroupOrder(std::size_t max_groups);

    static GroupOrder serializationTestObject();

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

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

    std::vector<std::string> names(const std::string& pattern) const;

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

    bool anyGroupMatches(const std::string& pattern) const;

    std::vector<std::optional<std::string>> restart_groups() const;

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

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

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

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

private:
    std::size_t max_groups_{};

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

} // namespace Opm

#endif // NAME_ORDER_HPP