NNC.hpp

/*
  Copyright 2015 IRIS

  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_PARSER_NNC_HPP
#define OPM_PARSER_NNC_HPP

#include <opm/common/OpmLog/KeywordLocation.hpp>

#include <cstddef>
#include <map>
#include <optional>
#include <tuple>
#include <vector>

namespace Opm
{

class GridDims;

struct NNCdata {
    NNCdata(std::size_t c1, std::size_t c2, double t)
        : cell1(c1), cell2(c2), trans(t)
    {}
    NNCdata() = default;

    bool operator==(const NNCdata& data) const
    {
        return cell1 == data.cell1 &&
               cell2 == data.cell2 &&
               trans == data.trans;
    }

    template<class Serializer>
    void serializeOp(Serializer& serializer)
    {
        serializer(cell1);
        serializer(cell2);
        serializer(trans);
    }

    // Observe that the operator< is only for cell ordering and does not consider the
    // trans member
    bool operator<(const NNCdata& other) const
    {
        return std::tie(this->cell1, this->cell2) < std::tie(other.cell1, other.cell2);
    }

    std::size_t cell1{};
    std::size_t cell2{};
    double trans{};
};

class Deck;
class EclipseGrid;

/*
  This class is an internalization of the NNC and EDITNNC keywords. Because the
  opm-common codebase does not itself manage the simulation grid the purpose of
  the NNC class is mainly to hold on to the NNC/EDITNNC input and pass it on to
  the grid construction proper.

  The EDITNNC keywords can operate on two different types of NNCs.

    1. NNCs which have been explicitly entered using the NNC keyword.
    2. NNCs which are inderectly inferred from the grid - e.g. due to faults.

  When processing the EDITNNC keyword the class will search through the NNCs
  configured explicitly with the NNC keyword and apply the edit transformation
  on those NNCs, EDITNNCs which affect NNCs which are not configured explicitly
  are stored for later use by the simulator.

  The class guarantees the following ordering:

    1. For all NNC / EDITNNC records we will have cell1 <= cell2
    2. The vectors NNC::input() and NNC::edit() will be ordered in ascending
       order.

  While constructing from a deck NNCs connected to inactive cells will be
  silently ignored. Do observe though that the addNNC() function does not check
  the arguments and alas there is no guarantee that only active cells are
  involved.
*/

class NNC
{
public:
    NNC() = default;
    virtual ~NNC() = default;
    NNC(const EclipseGrid& grid, const Deck& deck);

    static NNC serializationTestObject();

    virtual bool addNNC(const std::size_t cell1, const std::size_t cell2, const double trans);

    virtual void merge(const std::vector<NNCdata>& nncs);
    const std::vector<NNCdata>& input() const { return m_input; }
    const std::vector<NNCdata>& edit() const { return m_edit; }
    const std::vector<NNCdata>& editr() const { return m_editr; }
    KeywordLocation input_location(const NNCdata& nnc) const;
    KeywordLocation edit_location(const NNCdata& nnc) const;
    KeywordLocation editr_location(const NNCdata& nnc) const;

    bool operator==(const NNC& data) const;

    template<class Serializer>
    void serializeOp(Serializer& serializer)
    {
        serializer(m_input);
        serializer(m_edit);
        serializer(m_editr);
        serializer(m_nnc_location);
        serializer(m_edit_location);
        serializer(m_editr_location);
    }

private:

    void load_input(const EclipseGrid& grid, const Deck& deck);
    void load_edit(const EclipseGrid& grid, const Deck& deck);
    void load_editr(const EclipseGrid& grid, const Deck& deck);
    void add_edit(const NNCdata& edit_node);

    std::vector<NNCdata> m_input;
    std::vector<NNCdata> m_edit;
    std::vector<NNCdata> m_editr;
    std::optional<KeywordLocation> m_nnc_location;
    std::optional<KeywordLocation> m_edit_location;
    std::optional<KeywordLocation> m_editr_location;

    friend class NNCDiffGrid;
};

class NNCDataContainer
{
    public:
    NNCDataContainer() = default;
    virtual ~NNCDataContainer() = default;

    virtual bool addNNC(const std::size_t cell1, const std::size_t cell2, const double trans);
    bool addNNC(const NNCdata nnc_data);

    const std::vector<NNCdata>& input() const { return nnc_container; }

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

    protected:
    std::vector<NNCdata> nnc_container;
};

/*
  NNCDiffGrid is derived class of NNC.  NNC Class as it does not preserve the
  order of NNC, therefore not suitable for storing NNC data from different grids.
*/
class NNCDataContainerDiffGrid : public NNCDataContainer
{
public:
    NNCDataContainerDiffGrid() = default;
    ~NNCDataContainerDiffGrid() override = default;

    bool addNNC(const std::size_t cell1, const std::size_t cell2,
                const double trans) override;

    void swap_adj(std::size_t grid1, std::size_t grid2);

    bool operator==(const NNCDataContainerDiffGrid& other) const;
};

class NNCCollection
{
public:
    NNCCollection();
    explicit NNCCollection(NNCDataContainer nnc_global);

    // ---- insertion --------------------------------------------------------

    void addNNC(std::size_t grid1, std::size_t grid2, NNCDataContainerDiffGrid nnc);

    void addNNC(std::size_t grid, NNCDataContainer nnc);

    void addNNC(NNCDataContainer nnc);

    // ---- cross-grid access ------------------------------------------------

    const NNCDataContainerDiffGrid& getNNC(std::size_t grid1, std::size_t grid2) const;
    NNCDataContainerDiffGrid&       getNNC(std::size_t grid1, std::size_t grid2);

    bool hasCrossGridNNC(std::size_t grid1, std::size_t grid2) const;

    bool empty() const
    {
        for (const auto& [grid, nnc] : m_sameGridNNCs)
            if (!nnc.input().empty()) return false;
        for (const auto& [grids, nnc] : m_diffGridNNCs)
            if (!nnc.input().empty()) return false;
        return true;
    }
    // ---- same-grid access -------------------------------------------------

    const NNCDataContainer& getNNC(std::size_t grid) const;
    NNCDataContainer&       getNNC(std::size_t grid);

    bool hasSameGridNNC(std::size_t grid) const;

    // ---- global (grid 0) access -------------------------------------------

    const NNCDataContainer& getGlobalNNC() const;
    NNCDataContainer&       getGlobalNNC();

    bool hasGlobalNNC() const { return !getGlobalNNC().input().empty(); }

    bool hasNNCForGrid(std::size_t grid_index) const
    {
        if (((grid_index == 0) && hasGlobalNNC()) || ((grid_index != 0) && hasSameGridNNC(grid_index)))
        {
            return true;
        }
        for (const auto& [grid, nnc] : m_diffGridNNCs) {
            if (const auto& [g1, g2] = grid;
                ((g1 == grid_index) || (g2 == grid_index)) && !nnc.input().empty())
            {
                return true;
            }
        }
        return false;
    }

    const std::map<std::size_t, NNCDataContainer>& same_grid_nnc() const
    {
        return m_sameGridNNCs;
    }

    const std::map<std::pair<std::size_t,std::size_t>, NNCDataContainerDiffGrid>& diff_grid_nnc() const
    {
        return m_diffGridNNCs;
    }

    // ---- factory ----------------------------------------------------------

    static NNCCollection fromLGROutputContainers(
        const std::vector<std::vector<NNCdata>>& outputNnc,
        const std::vector<std::vector<NNCdata>>& outputNncGlobalLocal,
        const std::vector<std::vector<std::vector<NNCdata>>>& outputAmalgamatedNnc);

    bool operator==(const NNCCollection& other) const
    {
        return m_sameGridNNCs == other.m_sameGridNNCs &&
               m_diffGridNNCs == other.m_diffGridNNCs;
    }

private:

    std::map<std::size_t, NNCDataContainer> m_sameGridNNCs;

    std::map<std::pair<std::size_t,std::size_t>, NNCDataContainerDiffGrid> m_diffGridNNCs;
};

} // namespace Opm

#endif // OPM_PARSER_NNC_HPP