File: overlaptypes.hh

package info (click to toggle)
opm-models 2022.10%2Bds-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 6,216 kB
  • sloc: cpp: 37,910; ansic: 1,897; sh: 277; xml: 182; makefile: 10
file content (192 lines) | stat: -rw-r--r-- 4,630 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
  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 2 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/>.

  Consult the COPYING file in the top-level source directory of this
  module for the precise wording of the license and the list of
  copyright holders.
*/
/*!
 * \file
 *
 * \brief This files provides several data structures for storing
 *        tuples of indices of remote and/or local processes.
 */
#ifndef EWOMS_OVERLAP_TYPES_HH
#define EWOMS_OVERLAP_TYPES_HH

#include <set>
#include <list>
#include <vector>
#include <map>
#include <cstddef>

namespace Opm {
namespace Linear {

/*!
 * \brief The type of an index of a degree of freedom.
 */
using Index = int;

/*!
 * \brief The type of the rank of a process.
 */
using ProcessRank = unsigned;

/*!
 * \brief The type representing the distance of an index to the border.
 */
using BorderDistance = unsigned;

/*!
 * \brief This structure stores an index and a process rank
 */
struct IndexRank
{
    Index index;
    ProcessRank rank;
};

/*!
 * \brief This structure stores a local index on a peer process and a
 *        global index.
 */
struct PeerIndexGlobalIndex
{
    Index peerIdx;
    Index globalIdx;
};

/*!
 * \brief This structure stores an index, a process rank, and the
 *        distance of the degree of freedom to the process border.
 */
struct IndexRankDist
{
    Index index;
    ProcessRank peerRank;
    BorderDistance borderDistance;
};

/*!
 * \brief This structure stores an index, a process rank, and the
 *        number of processes which "see" the degree of freedom with
 *        the index.
 */
struct IndexDistanceNpeers
{
    Index index;
    BorderDistance borderDistance;
    unsigned numPeers;
};

/*!
 * \brief A single index intersecting with the process boundary.
 */
struct BorderIndex
{
    //! Index of the entity for the local process
    Index localIdx;

    //! Index of the entity for the peer process
    Index peerIdx;

    //! Rank of the peer process
    ProcessRank peerRank;

    //! Distance to the process border for the peer (in hops)
    BorderDistance borderDistance;
};

/*!
 * \brief This class managages a list of indices which are on the
 *        border of a process' partition of the grid
 */
using BorderList = std::list<BorderIndex>;

/*!
 * \brief The list of indices which are on the process boundary.
 */
class SeedList : public std::list<IndexRankDist>
{
public:
    void update(const BorderList& borderList)
    {
        this->clear();

        auto it = borderList.begin();
        const auto& endIt = borderList.end();
        for (; it != endIt; ++it) {
            IndexRankDist ird;
            ird.index = it->localIdx;
            ird.peerRank = it->peerRank;
            ird.borderDistance = it->borderDistance;

            this->push_back(ird);
        }
    }
};

/*!
 * \brief A set of process ranks
 */
class PeerSet : public std::set<ProcessRank>
{
public:
    void update(const BorderList& borderList)
    {
        this->clear();

        auto it = borderList.begin();
        const auto& endIt = borderList.end();
        for (; it != endIt; ++it)
            this->insert(it->peerRank);
    }
};

/*!
 * \brief The list of indices which overlap with a peer rank.
 */
using OverlapWithPeer = std::vector<IndexDistanceNpeers>;

/*!
 * \brief A type mapping the process rank to the list of indices
 *        shared with this peer.
 */
using OverlapByRank = std::map<ProcessRank, OverlapWithPeer>;

/*!
 * \brief Maps each index to a list of processes .
 */
using OverlapByIndex = std::vector<std::map<ProcessRank, BorderDistance> >;

/*!
 * \brief The list of domestic indices are owned by peer rank.
 */
using DomesticOverlapWithPeer = std::vector<Index>;

/*!
 * \brief A type mapping the process rank to the list of domestic indices
 *        which are owned by the peer.
 */
using DomesticOverlapByRank = std::map<ProcessRank, DomesticOverlapWithPeer>;

} // namespace Linear
} // namespace Opm

#endif