opm-simulators
vertexborderlistfromgrid.hh
Go to the documentation of this file.
1 // -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 // vi: set et ts=4 sw=4 sts=4:
3 /*
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 2 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 
19  Consult the COPYING file in the top-level source directory of this
20  module for the precise wording of the license and the list of
21  copyright holders.
22 */
27 #ifndef EWOMS_VERTEX_BORDER_LIST_FROM_GRID_HH
28 #define EWOMS_VERTEX_BORDER_LIST_FROM_GRID_HH
29 
30 #include "overlaptypes.hh"
31 #include "blacklist.hh"
32 
33 #include <dune/grid/common/datahandleif.hh>
34 #include <dune/grid/common/gridenums.hh>
35 #include <dune/common/version.hh>
36 
37 namespace Opm {
38 namespace Linear {
48 template <class GridView, class VertexMapper>
50  : public Dune::CommDataHandleIF<VertexBorderListFromGrid<GridView, VertexMapper>,
51  int>
52 {
53  static const int dimWorld = GridView::dimensionworld;
54 
55 public:
56  VertexBorderListFromGrid(const GridView& gridView, const VertexMapper& map)
57  : gridView_(gridView), map_(map)
58  {
59  gridView.communicate(*this,
60  Dune::InteriorBorder_InteriorBorder_Interface,
61  Dune::ForwardCommunication);
62 
63  auto vIt = gridView.template begin<dimWorld>();
64  const auto& vEndIt = gridView.template end<dimWorld >();
65  for (; vIt != vEndIt; ++vIt) {
66  if (vIt->partitionType() != Dune::InteriorEntity
67  && vIt->partitionType() != Dune::BorderEntity)
68  {
69  Index vIdx = static_cast<Index>(map_.index(*vIt));
70  blackList_.addIndex(vIdx);
71  }
72  }
73  }
74 
75  // data handle methods
76  bool contains(int dim, int codim) const
77  { return dim == codim; }
78 
79  bool fixedSize(int, int) const
80  { return true; }
81 
82  template <class EntityType>
83  size_t size(const EntityType&) const
84  { return 2; }
85 
86  template <class MessageBufferImp, class EntityType>
87  void gather(MessageBufferImp& buff, const EntityType& e) const
88  {
89  buff.write(static_cast<int>(gridView_.comm().rank()));
90  buff.write(static_cast<int>(map_.index(e)));
91  }
92 
93  template <class MessageBufferImp, class EntityType>
94  void scatter(MessageBufferImp& buff, const EntityType& e, size_t)
95  {
96  BorderIndex bIdx;
97 
98  bIdx.localIdx = static_cast<Index>(map_.index(e));
99  {
100  int tmp;
101  buff.read(tmp);
102  bIdx.peerRank = static_cast<ProcessRank>(tmp);
103  }
104  {
105  int tmp;
106  buff.read(tmp);
107  bIdx.peerIdx = static_cast<Index>(tmp);
108  }
109  bIdx.borderDistance = 0;
110 
111  borderList_.push_back(bIdx);
112  }
113 
114  // Access to the border list.
115  const BorderList& borderList() const
116  { return borderList_; }
117 
118  // Access to the black-list indices.
119  const BlackList& blackList() const
120  { return blackList_; }
121 
122 private:
123  const GridView gridView_;
124  const VertexMapper& map_;
125  BorderList borderList_;
126  BlackList blackList_;
127 };
128 
129 } // namespace Linear
130 } // namespace Opm
131 
132 #endif
A single index intersecting with the process boundary.
Definition: overlaptypes.hh:101
Expresses which degrees of freedom are blacklisted for the parallel linear solvers and which domestic...
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition: blackoilbioeffectsmodules.hh:45
Index peerIdx
Index of the entity for the peer process.
Definition: overlaptypes.hh:107
This files provides several data structures for storing tuples of indices of remote and/or local proc...
unsigned ProcessRank
The type of the rank of a process.
Definition: overlaptypes.hh:49
Expresses which degrees of freedom are blacklisted for the parallel linear solvers and which domestic...
Definition: blacklist.hh:48
Index localIdx
Index of the entity for the local process.
Definition: overlaptypes.hh:104
Uses communication on the grid to find the initial seed list of indices.
Definition: vertexborderlistfromgrid.hh:49
BorderDistance borderDistance
Distance to the process border for the peer (in hops)
Definition: overlaptypes.hh:113
ProcessRank peerRank
Rank of the peer process.
Definition: overlaptypes.hh:110
std::list< BorderIndex > BorderList
This class managages a list of indices which are on the border of a process&#39; partition of the grid...
Definition: overlaptypes.hh:120
int Index
The type of an index of a degree of freedom.
Definition: overlaptypes.hh:44