threadedentityiterator.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_THREADED_ENTITY_ITERATOR_HH
28 #define EWOMS_THREADED_ENTITY_ITERATOR_HH
29 
30 #include <ewoms/parallel/locks.hh>
31 
32 namespace Ewoms {
33 
40 template <class GridView, int codim>
42 {
43  typedef typename GridView::template Codim<codim>::Entity Entity;
44  typedef typename GridView::template Codim<codim>::Iterator EntityIterator;
45 public:
46  ThreadedEntityIterator(const GridView& gridView)
47  : gridView_(gridView)
48  , sequentialIt_(gridView_.template begin<codim>())
49  , sequentialEnd_(gridView.template end<codim>())
50  { }
51 
52  ThreadedEntityIterator(const ThreadedEntityIterator& other) = default;
53 
54  // begin iterating over the grid in parallel
55  EntityIterator beginParallel()
56  {
57  mutex_.lock();
58  auto tmp = sequentialIt_;
59  if (sequentialIt_ != sequentialEnd_)
60  ++sequentialIt_; // make the next thread look at the next element
61  mutex_.unlock();
62 
63  return tmp;
64  }
65 
66  // returns true if the last element was reached
67  bool isFinished(const EntityIterator& it) const
68  { return it == sequentialEnd_; }
69 
70  // prefix increment: goes to the next element which is not yet worked on by any
71  // thread
72  EntityIterator increment()
73  {
74  mutex_.lock();
75  auto tmp = sequentialIt_;
76  if (sequentialIt_ != sequentialEnd_)
77  ++sequentialIt_;
78  mutex_.unlock();
79 
80  return tmp;
81  }
82 
83 private:
84  GridView gridView_;
85  EntityIterator sequentialIt_;
86  EntityIterator sequentialEnd_;
87 
88  OmpMutex mutex_;
89 };
90 } // namespace Ewoms
91 
92 #endif
This file implements various objects which provide mutual exclusion capabilities for multi-threaded a...
Definition: baseauxiliarymodule.hh:37
Definition: locks.hh:54
Provides an STL-iterator like interface to iterate over the enties of a GridView in OpenMP threaded a...
Definition: threadedentityiterator.hh:41