GCC Code Coverage Report


Directory: ../../../builds/dumux-repositories/
File: /builds/dumux-repositories/dumux/dumux/discretization/scvandscvfiterators.hh
Date: 2024-05-04 19:09:25
Exec Total Coverage
Lines: 26 31 83.9%
Functions: 42 129 32.6%
Branches: 224 240 93.3%

Line Branch Exec Source
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 // SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
5 // SPDX-License-Identifier: GPL-3.0-or-later
6 //
7 /*!
8 * \file
9 * \ingroup Discretization
10 * \brief Class providing iterators over sub control volumes and sub control volume faces of an element.
11 */
12 #ifndef DUMUX_SCV_AND_SCVF_ITERATORS_HH
13 #define DUMUX_SCV_AND_SCVF_ITERATORS_HH
14
15 #include <dune/common/iteratorrange.hh>
16 #include <dune/common/iteratorfacades.hh>
17
18 namespace Dumux {
19
20 /*!
21 * \ingroup Discretization
22 * \brief Iterators over sub control volumes
23 * \note usage: for(const auto& scv : scvs(fvGeometry))
24 */
25 template<class SubControlVolume, class Vector, class FVElementGeometry>
26 class ScvIterator : public Dune::ForwardIteratorFacade<ScvIterator<SubControlVolume,
27 Vector,
28 FVElementGeometry>,
29 const SubControlVolume>
30 {
31 using ThisType = ScvIterator<SubControlVolume, Vector, FVElementGeometry>;
32 using Iterator = typename Vector::const_iterator;
33 public:
34 ScvIterator(const Iterator& it, const FVElementGeometry& fvGeometry)
35 : it_(it), fvGeometryPtr_(&fvGeometry) {}
36
37 4 ScvIterator() : it_(Iterator()), fvGeometryPtr_(nullptr) {}
38
39 //! dereferencing yields a subcontrol volume
40 const SubControlVolume& dereference() const
41 {
42
36/44
✓ Branch 1 taken 1 times.
✓ Branch 2 taken 50476768 times.
✓ Branch 3 taken 144396030 times.
✓ Branch 4 taken 50476777 times.
✓ Branch 5 taken 144397558 times.
✓ Branch 6 taken 30418 times.
✓ Branch 7 taken 1189244 times.
✓ Branch 8 taken 50378 times.
✓ Branch 9 taken 2176572 times.
✓ Branch 10 taken 3384848 times.
✓ Branch 11 taken 1090492 times.
✓ Branch 12 taken 3367490 times.
✓ Branch 13 taken 137272 times.
✓ Branch 14 taken 2099 times.
✓ Branch 15 taken 2847715 times.
✓ Branch 16 taken 10357 times.
✓ Branch 17 taken 4884493 times.
✓ Branch 18 taken 2390944 times.
✓ Branch 19 taken 3594202 times.
✓ Branch 20 taken 906804 times.
✓ Branch 21 taken 9884298 times.
✗ Branch 22 not taken.
✓ Branch 23 taken 9845434 times.
✓ Branch 24 taken 8000 times.
✓ Branch 25 taken 18248 times.
✗ Branch 26 not taken.
✓ Branch 27 taken 17146 times.
✓ Branch 28 taken 596 times.
✓ Branch 29 taken 29312 times.
✗ Branch 30 not taken.
✓ Branch 31 taken 535690 times.
✓ Branch 32 taken 12166 times.
✗ Branch 33 not taken.
✓ Branch 34 taken 535690 times.
✓ Branch 35 taken 12381 times.
✗ Branch 36 not taken.
✓ Branch 37 taken 3471680 times.
✓ Branch 38 taken 12381 times.
✗ Branch 39 not taken.
✓ Branch 40 taken 3471680 times.
✓ Branch 41 taken 901500 times.
✗ Branch 42 not taken.
✓ Branch 44 taken 901500 times.
✗ Branch 45 not taken.
1127562994 return fvGeometryPtr_->scv(*it_);
43 }
44
45 bool equals(const ThisType& other) const
46 {
47 return it_ == other.it_;
48 }
49
50 void increment()
51 {
52 368781153 ++it_;
53 }
54
55 private:
56 Iterator it_;
57 const FVElementGeometry* fvGeometryPtr_;
58 };
59
60 /*!
61 * \ingroup Discretization
62 * \brief Iterators over sub control volume faces of an fv geometry
63 * \note usage: for(const auto& scvf : scvfs(fvGeometry))
64 */
65 template<class SubControlVolumeFace, class Vector, class FVElementGeometry>
66 class ScvfIterator : public Dune::ForwardIteratorFacade<ScvfIterator<SubControlVolumeFace,
67 Vector,
68 FVElementGeometry>,
69 const SubControlVolumeFace>
70 {
71 using ThisType = ScvfIterator<SubControlVolumeFace, Vector, FVElementGeometry>;
72 using Iterator = typename Vector::const_iterator;
73 public:
74 ScvfIterator(const Iterator& it, const FVElementGeometry& fvGeometry)
75 : it_(it), fvGeometryPtr_(&fvGeometry) {}
76
77 64 ScvfIterator() : it_(Iterator()), fvGeometryPtr_(nullptr) {}
78
79 //! dereferencing yields a subcontrol volume face
80 47564500 const SubControlVolumeFace& dereference() const
81 {
82
58/62
✓ Branch 0 taken 8 times.
✓ Branch 1 taken 196638 times.
✓ Branch 2 taken 40706 times.
✓ Branch 3 taken 933058 times.
✓ Branch 4 taken 5146718 times.
✓ Branch 5 taken 1941958 times.
✓ Branch 6 taken 6947645 times.
✓ Branch 7 taken 26748080 times.
✓ Branch 8 taken 3200595 times.
✓ Branch 9 taken 3007722 times.
✓ Branch 10 taken 23391148 times.
✓ Branch 11 taken 9878042 times.
✓ Branch 12 taken 53865825 times.
✓ Branch 13 taken 27270087 times.
✓ Branch 14 taken 47674245 times.
✓ Branch 15 taken 13168011 times.
✓ Branch 16 taken 17402454 times.
✓ Branch 17 taken 6856668 times.
✓ Branch 18 taken 5074098 times.
✓ Branch 19 taken 7870736 times.
✓ Branch 20 taken 36946739 times.
✓ Branch 21 taken 11895133 times.
✓ Branch 22 taken 36122361 times.
✓ Branch 23 taken 9087551 times.
✓ Branch 24 taken 7111066 times.
✓ Branch 25 taken 2567834 times.
✓ Branch 26 taken 4783652 times.
✓ Branch 27 taken 218048 times.
✓ Branch 28 taken 1202742 times.
✓ Branch 29 taken 543754 times.
✓ Branch 30 taken 2179198 times.
✓ Branch 31 taken 639038 times.
✓ Branch 32 taken 1865502 times.
✓ Branch 33 taken 590990 times.
✓ Branch 34 taken 592788 times.
✓ Branch 35 taken 561452 times.
✓ Branch 36 taken 39386 times.
✓ Branch 37 taken 642900 times.
✓ Branch 38 taken 22742 times.
✓ Branch 39 taken 249912 times.
✓ Branch 40 taken 330618 times.
✓ Branch 41 taken 562356 times.
✓ Branch 42 taken 391538 times.
✓ Branch 43 taken 443276 times.
✓ Branch 44 taken 461031 times.
✓ Branch 45 taken 174617 times.
✓ Branch 46 taken 97431 times.
✓ Branch 47 taken 58393 times.
✓ Branch 48 taken 6400 times.
✓ Branch 49 taken 281294 times.
✓ Branch 50 taken 37220 times.
✓ Branch 51 taken 407626 times.
✓ Branch 52 taken 31636 times.
✓ Branch 53 taken 140940 times.
✓ Branch 54 taken 22120 times.
✓ Branch 55 taken 18328 times.
✓ Branch 56 taken 22120 times.
✓ Branch 57 taken 18328 times.
✗ Branch 58 not taken.
✗ Branch 59 not taken.
✗ Branch 60 not taken.
✗ Branch 61 not taken.
2775127636 return fvGeometryPtr_->scvf(*it_);
83 }
84
85 bool equals(const ThisType& other) const
86 {
87
90/90
✓ Branch 0 taken 7484354 times.
✓ Branch 1 taken 1854524 times.
✓ Branch 2 taken 7484354 times.
✓ Branch 3 taken 1854524 times.
✓ Branch 4 taken 267524229 times.
✓ Branch 5 taken 67100258 times.
✓ Branch 6 taken 267524229 times.
✓ Branch 7 taken 67100258 times.
✓ Branch 8 taken 256767022 times.
✓ Branch 9 taken 65310420 times.
✓ Branch 10 taken 256767022 times.
✓ Branch 11 taken 65310420 times.
✓ Branch 12 taken 233865403 times.
✓ Branch 13 taken 42248989 times.
✓ Branch 14 taken 233865403 times.
✓ Branch 15 taken 42248989 times.
✓ Branch 16 taken 80702730 times.
✓ Branch 17 taken 16029511 times.
✓ Branch 18 taken 80702730 times.
✓ Branch 19 taken 16029511 times.
✓ Branch 20 taken 120815354 times.
✓ Branch 21 taken 19391294 times.
✓ Branch 22 taken 120815354 times.
✓ Branch 23 taken 19391294 times.
✓ Branch 24 taken 163576582 times.
✓ Branch 25 taken 32336127 times.
✓ Branch 26 taken 163576582 times.
✓ Branch 27 taken 32336127 times.
✓ Branch 28 taken 74143074 times.
✓ Branch 29 taken 9882239 times.
✓ Branch 30 taken 74143074 times.
✓ Branch 31 taken 9882239 times.
✓ Branch 32 taken 37571450 times.
✓ Branch 33 taken 7032068 times.
✓ Branch 34 taken 37571450 times.
✓ Branch 35 taken 7032068 times.
✓ Branch 36 taken 93278044 times.
✓ Branch 37 taken 12868592 times.
✓ Branch 38 taken 93278044 times.
✓ Branch 39 taken 12868592 times.
✓ Branch 40 taken 46655312 times.
✓ Branch 41 taken 6357599 times.
✓ Branch 42 taken 46655312 times.
✓ Branch 43 taken 6357599 times.
✓ Branch 44 taken 6481536 times.
✓ Branch 45 taken 759209 times.
✓ Branch 46 taken 6481536 times.
✓ Branch 47 taken 759209 times.
✓ Branch 48 taken 3334826 times.
✓ Branch 49 taken 755876 times.
✓ Branch 50 taken 3354826 times.
✓ Branch 51 taken 760876 times.
✓ Branch 52 taken 3329232 times.
✓ Branch 53 taken 499759 times.
✓ Branch 54 taken 4068220 times.
✓ Branch 55 taken 616599 times.
✓ Branch 56 taken 3019296 times.
✓ Branch 57 taken 599470 times.
✓ Branch 58 taken 2918816 times.
✓ Branch 59 taken 633362 times.
✓ Branch 60 taken 1367954 times.
✓ Branch 61 taken 305039 times.
✓ Branch 62 taken 1412806 times.
✓ Branch 63 taken 319035 times.
✓ Branch 64 taken 1519960 times.
✓ Branch 65 taken 379128 times.
✓ Branch 66 taken 1209200 times.
✓ Branch 67 taken 302294 times.
✓ Branch 68 taken 399600 times.
✓ Branch 69 taken 99894 times.
✓ Branch 70 taken 2270718 times.
✓ Branch 71 taken 296112 times.
✓ Branch 72 taken 2270718 times.
✓ Branch 73 taken 296112 times.
✓ Branch 74 taken 3575040 times.
✓ Branch 75 taken 893760 times.
✓ Branch 76 taken 3575040 times.
✓ Branch 77 taken 893760 times.
✓ Branch 78 taken 2021856 times.
✓ Branch 79 taken 505464 times.
✓ Branch 80 taken 2021856 times.
✓ Branch 81 taken 505464 times.
✓ Branch 82 taken 1648480 times.
✓ Branch 83 taken 412120 times.
✓ Branch 84 taken 1648480 times.
✓ Branch 85 taken 412120 times.
✓ Branch 86 taken 1024 times.
✓ Branch 87 taken 256 times.
✓ Branch 88 taken 1024 times.
✓ Branch 89 taken 256 times.
3395967146 return it_ == other.it_;
88 }
89
90 void increment()
91 {
92 1410329480 it_++;
93 }
94
95 private:
96 Iterator it_;
97 const FVElementGeometry* fvGeometryPtr_;
98 };
99
100 /*!
101 * \ingroup Discretization
102 * \brief Iterators over sub control volume faces of an fv geometry and a given sub control volume
103 * \note usage: for(const auto& scvf : scvfs(fvGeometry, scv))
104 */
105 template<class SubControlVolumeFace, class Vector, class FVElementGeometry>
106 class SkippingScvfIterator : public Dune::ForwardIteratorFacade<SkippingScvfIterator<SubControlVolumeFace,
107 Vector,
108 FVElementGeometry>,
109 const SubControlVolumeFace>
110 {
111 using ThisType = SkippingScvfIterator<SubControlVolumeFace, Vector, FVElementGeometry>;
112 using Iterator = typename Vector::const_iterator;
113 public:
114
115 12 SkippingScvfIterator() : it_(Iterator()), fvGeometryPtr_(nullptr) {}
116
117 98623131 static ThisType makeBegin(const Vector& vector, const FVElementGeometry& fvGeometry, const std::size_t scvIdx)
118 {
119 98623131 auto begin = vector.begin();
120 197246262 const auto end = vector.end();
121
122
7/10
✓ Branch 0 taken 551728371 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 551728371 times.
✗ Branch 3 not taken.
✗ Branch 4 not taken.
✓ Branch 5 taken 549256171 times.
✓ Branch 6 taken 443967968 times.
✓ Branch 7 taken 107760403 times.
✓ Branch 8 taken 443967968 times.
✓ Branch 9 taken 96150931 times.
1131620086 while (begin != end && fvGeometry.scvf(*begin).insideScvIdx() != scvIdx)
123 453105240 ++begin;
124
125 197246262 return SkippingScvfIterator(begin, end, fvGeometry, scvIdx);
126 }
127
128 static ThisType makeEnd(const Vector& vector, const FVElementGeometry& fvGeometry, const std::size_t scvIdx)
129 {
130 394492524 return SkippingScvfIterator(vector.end(), vector.end(), fvGeometry, scvIdx);
131 }
132
133 //! dereferencing yields a subcontrol volume face
134 893697462 const SubControlVolumeFace& dereference() const
135 {
136
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 870809680 times.
893697462 return fvGeometryPtr_->scvf(*it_);
137 }
138
139 bool equals(const ThisType& other) const
140 {
141
24/24
✓ Branch 0 taken 20604526 times.
✓ Branch 1 taken 676 times.
✓ Branch 2 taken 20604526 times.
✓ Branch 3 taken 676 times.
✓ Branch 4 taken 71789623 times.
✓ Branch 5 taken 23713390 times.
✓ Branch 6 taken 71789623 times.
✓ Branch 7 taken 23713390 times.
✓ Branch 8 taken 181725660 times.
✓ Branch 9 taken 60093330 times.
✓ Branch 10 taken 181725660 times.
✓ Branch 11 taken 60093330 times.
✓ Branch 12 taken 178746 times.
✓ Branch 13 taken 59208 times.
✓ Branch 14 taken 178746 times.
✓ Branch 15 taken 59208 times.
✓ Branch 16 taken 794893 times.
✓ Branch 17 taken 263135 times.
✓ Branch 18 taken 794893 times.
✓ Branch 19 taken 263135 times.
✓ Branch 20 taken 87 times.
✓ Branch 21 taken 29 times.
✓ Branch 22 taken 87 times.
✓ Branch 23 taken 29 times.
718446626 return it_ == other.it_;
142 }
143
144 275091891 void increment()
145 {
146 275091891 ++it_;
147
8/8
✓ Branch 0 taken 609426860 times.
✓ Branch 1 taken 84129766 times.
✓ Branch 2 taken 609426860 times.
✓ Branch 3 taken 84129766 times.
✓ Branch 5 taken 418464735 times.
✓ Branch 6 taken 190962125 times.
✓ Branch 7 taken 418464735 times.
✓ Branch 8 taken 190962125 times.
1387113252 while (it_ != itEnd_ && dereference().insideScvIdx() != scvIdx_)
148 418464735 ++it_;
149 275091891 }
150
151 private:
152
153 197246262 SkippingScvfIterator(const Iterator& itBegin, const Iterator& itEnd, const FVElementGeometry& fvGeometry, const std::size_t scvIdx)
154 197246262 : it_(itBegin), fvGeometryPtr_(&fvGeometry), itEnd_(itEnd), scvIdx_(scvIdx) {}
155
156 Iterator it_;
157 const FVElementGeometry* fvGeometryPtr_;
158 const Iterator itEnd_;
159 std::size_t scvIdx_;
160 };
161
162 } // end namespace Dumux
163
164 #endif
165