GCC Code Coverage Report


Directory: ../../../builds/dumux-repositories/
File: dumux/dumux/discretization/box/subcontrolvolume.hh
Date: 2025-05-03 19:19:02
Exec Total Coverage
Lines: 24 24 100.0%
Functions: 21 22 95.5%
Branches: 170 210 81.0%

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-FileCopyrightText: 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 BoxDiscretization
10 * \brief the sub control volume for the box scheme
11 */
12 #ifndef DUMUX_DISCRETIZATION_BOX_SUBCONTROLVOLUME_HH
13 #define DUMUX_DISCRETIZATION_BOX_SUBCONTROLVOLUME_HH
14
15 #include <dune/geometry/type.hh>
16 #include <dune/geometry/multilineargeometry.hh>
17
18 #include <dumux/common/math.hh>
19 #include <dumux/common/indextraits.hh>
20 #include <dumux/geometry/volume.hh>
21 #include <dumux/geometry/center.hh>
22 #include <dumux/discretization/subcontrolvolumebase.hh>
23 #include <dumux/discretization/box/boxgeometryhelper.hh>
24
25 namespace Dumux {
26
27 /*!
28 * \ingroup BoxDiscretization
29 * \brief Default traits class to be used for the sub-control volumes
30 * for the box scheme
31 * \tparam GV the type of the grid view
32 */
33 template<class GridView>
34 struct BoxDefaultScvGeometryTraits
35 {
36 using Grid = typename GridView::Grid;
37
38 static const int dim = Grid::dimension;
39 static const int dimWorld = Grid::dimensionworld;
40
41 using GridIndexType = typename IndexTraits<GridView>::GridIndex;
42 using LocalIndexType = typename IndexTraits<GridView>::LocalIndex;
43 using Scalar = typename Grid::ctype;
44 using GeometryTraits = BoxMLGeometryTraits<Scalar>;
45 using Geometry = Dune::MultiLinearGeometry<Scalar, dim, dimWorld, GeometryTraits>;
46 using CornerStorage = typename GeometryTraits::template CornerStorage<dim, dimWorld>::Type;
47 using GlobalPosition = typename Geometry::GlobalCoordinate;
48 };
49
50 /*!
51 * \ingroup BoxDiscretization
52 * \brief the sub control volume for the box scheme
53 * \tparam GV the type of the grid view
54 * \tparam T the scvf geometry traits
55 */
56 template<class GV,
57 class T = BoxDefaultScvGeometryTraits<GV> >
58 class BoxSubControlVolume
59 : public SubControlVolumeBase<BoxSubControlVolume<GV, T>, T>
60 {
61 using ThisType = BoxSubControlVolume<GV, T>;
62 using ParentType = SubControlVolumeBase<ThisType, T>;
63 using Geometry = typename T::Geometry;
64 using GridIndexType = typename T::GridIndexType;
65 using LocalIndexType = typename T::LocalIndexType;
66 using Scalar = typename T::Scalar;
67 static constexpr int dim = Geometry::mydimension;
68
69 public:
70 //! export the type used for global coordinates
71 using GlobalPosition = typename T::GlobalPosition;
72 //! state the traits public and thus export all types
73 using Traits = T;
74
75 //! The default constructor
76 18551700 BoxSubControlVolume() = default;
77
78 // the constructor in the box case
79 template<class Corners>
80 41914645 BoxSubControlVolume(const Corners& corners,
81 LocalIndexType scvIdx,
82 GridIndexType elementIndex,
83 GridIndexType dofIndex)
84 41914645 : dofPosition_(corners[0])
85 41914645 , center_(Dumux::center(corners))
86 41914645 , elementIndex_(elementIndex)
87 41914645 , localDofIdx_(scvIdx)
88 41914645 , dofIndex_(dofIndex)
89 {
90 // The corner list is defined such that the first entry is the vertex itself
91 44234299 volume_ = Dumux::convexPolytopeVolume<dim>(
92 Dune::GeometryTypes::cube(dim),
93 81838680 [&](unsigned int i){ return corners[i]; }
94 );
95 41914645 }
96
97 //! The center of the sub control volume
98 53539645 const GlobalPosition& center() const
99 {
100
12/12
✓ Branch 2 taken 16171737 times.
✓ Branch 3 taken 9616000 times.
✓ Branch 0 taken 20479498 times.
✓ Branch 1 taken 5279523 times.
✓ Branch 7 taken 6415348 times.
✓ Branch 8 taken 675332 times.
✓ Branch 4 taken 10243285 times.
✓ Branch 9 taken 28800 times.
✓ Branch 10 taken 16567 times.
✓ Branch 6 taken 6390666 times.
✓ Branch 5 taken 6322226 times.
✓ Branch 11 taken 632033 times.
661685122 return center_;
101 }
102
103 //! The volume of the sub control volume
104 629810339 Scalar volume() const
105 {
106
6/8
✓ Branch 1 taken 7212 times.
✓ Branch 2 taken 3 times.
✓ Branch 5 taken 40 times.
✗ Branch 6 not taken.
✓ Branch 3 taken 401425 times.
✓ Branch 4 taken 159176 times.
✓ Branch 7 taken 140000 times.
✗ Branch 8 not taken.
597321339 return volume_;
107 }
108
109 //! The element-local index of the dof this scv is embedded in
110 1622004767 LocalIndexType localDofIndex() const
111 {
112
32/45
✓ Branch 1 taken 29030037 times.
✓ Branch 2 taken 5760669 times.
✓ Branch 4 taken 1721444 times.
✓ Branch 5 taken 4107396 times.
✓ Branch 7 taken 5137112 times.
✓ Branch 8 taken 758582 times.
✓ Branch 10 taken 8216 times.
✓ Branch 11 taken 46656 times.
✗ Branch 13 not taken.
✓ Branch 14 taken 992 times.
✗ Branch 16 not taken.
✓ Branch 17 taken 78328 times.
✓ Branch 19 taken 71068 times.
✓ Branch 20 taken 6568 times.
✓ Branch 22 taken 476787 times.
✓ Branch 23 taken 3078000 times.
✓ Branch 25 taken 7344 times.
✓ Branch 26 taken 921 times.
✗ Branch 28 not taken.
✗ Branch 29 not taken.
✗ Branch 31 not taken.
✗ Branch 32 not taken.
✗ Branch 34 not taken.
✗ Branch 35 not taken.
✗ Branch 41 not taken.
✓ Branch 42 taken 24 times.
✗ Branch 44 not taken.
✓ Branch 45 taken 1024 times.
✗ Branch 47 not taken.
✓ Branch 48 taken 54560 times.
✓ Branch 50 taken 8 times.
✓ Branch 51 taken 24 times.
✓ Branch 52 taken 400 times.
✓ Branch 53 taken 848 times.
✓ Branch 54 taken 14288 times.
✓ Branch 55 taken 19360 times.
✓ Branch 21 taken 108765 times.
✓ Branch 3 taken 7054855 times.
✗ Branch 0 not taken.
✓ Branch 6 taken 116459 times.
✓ Branch 9 taken 18290 times.
✓ Branch 12 taken 202698 times.
✓ Branch 15 taken 585336 times.
✗ Branch 18 not taken.
✓ Branch 27 taken 25215 times.
1596516916 return localDofIdx_;
113 }
114
115 //! The element-local index of this scv.
116 //! For the standard box scheme this is the local dof index.
117 199801992 LocalIndexType indexInElement() const
118 {
119
39/43
✓ Branch 0 taken 244369398 times.
✓ Branch 1 taken 147279354 times.
✓ Branch 2 taken 249916572 times.
✓ Branch 3 taken 822393936 times.
✓ Branch 4 taken 101810456 times.
✓ Branch 5 taken 897216392 times.
✓ Branch 6 taken 269555720 times.
✓ Branch 7 taken 45820602 times.
✓ Branch 8 taken 3663520 times.
✓ Branch 9 taken 8518844 times.
✓ Branch 10 taken 11134629 times.
✓ Branch 11 taken 4573728 times.
✓ Branch 12 taken 7774744 times.
✓ Branch 13 taken 6634270 times.
✓ Branch 14 taken 6981043 times.
✓ Branch 15 taken 20110930 times.
✓ Branch 17 taken 291172 times.
✓ Branch 18 taken 61056 times.
✓ Branch 20 taken 152263 times.
✓ Branch 21 taken 1324121 times.
✓ Branch 27 taken 373342 times.
✗ Branch 28 not taken.
✓ Branch 34 taken 1300 times.
✗ Branch 35 not taken.
✗ Branch 36 not taken.
✓ Branch 37 taken 2600 times.
✓ Branch 39 taken 440 times.
✓ Branch 40 taken 5784 times.
✓ Branch 19 taken 691122 times.
✓ Branch 16 taken 3231139 times.
✓ Branch 22 taken 5504905 times.
✓ Branch 23 taken 11432799 times.
✓ Branch 30 taken 98328 times.
✓ Branch 31 taken 154160 times.
✓ Branch 24 taken 5100848 times.
✓ Branch 25 taken 3778896 times.
✓ Branch 26 taken 14460002 times.
✗ Branch 32 not taken.
✓ Branch 33 taken 294984 times.
✓ Branch 41 taken 2913 times.
✓ Branch 42 taken 2871 times.
✓ Branch 43 taken 1 times.
✓ Branch 44 taken 37039 times.
9789355357 return localDofIdx_;
120 }
121
122 //! The index of the dof this scv is embedded in
123 455257265 GridIndexType dofIndex() const
124 {
125
54/68
✓ Branch 1 taken 7668870 times.
✓ Branch 2 taken 18256 times.
✓ Branch 4 taken 31228717 times.
✓ Branch 5 taken 1338269 times.
✓ Branch 7 taken 46718278 times.
✓ Branch 8 taken 7385994 times.
✓ Branch 10 taken 31075971 times.
✓ Branch 11 taken 10046165 times.
✓ Branch 13 taken 461639 times.
✓ Branch 14 taken 63791 times.
✓ Branch 16 taken 1239397 times.
✓ Branch 17 taken 24121 times.
✓ Branch 19 taken 2396047 times.
✓ Branch 20 taken 1577463 times.
✓ Branch 22 taken 1276362 times.
✓ Branch 23 taken 216906 times.
✓ Branch 25 taken 149332 times.
✓ Branch 26 taken 48300 times.
✓ Branch 28 taken 7928 times.
✓ Branch 29 taken 9186 times.
✓ Branch 31 taken 995487 times.
✓ Branch 32 taken 8216 times.
✗ Branch 34 not taken.
✓ Branch 35 taken 4024 times.
✓ Branch 37 taken 114204 times.
✓ Branch 38 taken 3116236 times.
✓ Branch 40 taken 34815 times.
✗ Branch 41 not taken.
✓ Branch 43 taken 9600 times.
✗ Branch 44 not taken.
✓ Branch 49 taken 16 times.
✗ Branch 50 not taken.
✓ Branch 52 taken 96 times.
✗ Branch 53 not taken.
✗ Branch 55 not taken.
✗ Branch 56 not taken.
✓ Branch 58 taken 96 times.
✗ Branch 59 not taken.
✓ Branch 61 taken 792 times.
✗ Branch 62 not taken.
✓ Branch 64 taken 1836 times.
✗ Branch 65 not taken.
✗ Branch 67 not taken.
✗ Branch 68 not taken.
✓ Branch 70 taken 2112 times.
✗ Branch 71 not taken.
✓ Branch 73 taken 30832 times.
✗ Branch 74 not taken.
✓ Branch 76 taken 8 times.
✓ Branch 77 taken 24 times.
✓ Branch 78 taken 400 times.
✓ Branch 79 taken 848 times.
✓ Branch 80 taken 14288 times.
✓ Branch 81 taken 19360 times.
✓ Branch 0 taken 5324502 times.
✓ Branch 9 taken 150672589 times.
✓ Branch 21 taken 543075 times.
✓ Branch 27 taken 149314 times.
✓ Branch 30 taken 89265 times.
✓ Branch 33 taken 104256 times.
✓ Branch 36 taken 115176 times.
✓ Branch 3 taken 6129104 times.
✓ Branch 6 taken 10504169 times.
✓ Branch 18 taken 3944352 times.
✓ Branch 12 taken 2219032 times.
✓ Branch 15 taken 1425798 times.
✓ Branch 39 taken 921 times.
✓ Branch 24 taken 41604 times.
453066927 return dofIndex_;
126 }
127
128 // The position of the dof this scv is embedded in
129 30318264 const GlobalPosition& dofPosition() const
130 {
131
18/19
✓ Branch 0 taken 2759153 times.
✓ Branch 1 taken 1083127 times.
✓ Branch 2 taken 3250986 times.
✓ Branch 3 taken 2304603 times.
✓ Branch 4 taken 1716116 times.
✓ Branch 5 taken 878915 times.
✓ Branch 6 taken 1544259 times.
✓ Branch 7 taken 6398021 times.
✓ Branch 8 taken 3446691 times.
✓ Branch 9 taken 2232625 times.
✓ Branch 11 taken 314641 times.
✓ Branch 12 taken 19826 times.
✓ Branch 13 taken 125019 times.
✓ Branch 14 taken 72 times.
✗ Branch 15 not taken.
✓ Branch 16 taken 8 times.
✓ Branch 17 taken 34 times.
✓ Branch 18 taken 102 times.
✓ Branch 10 taken 69620 times.
603164852 return dofPosition_;
132 }
133
134 //! The global index of the element this scv is embedded in
135 66170438 GridIndexType elementIndex() const
136 {
137
9/15
✓ Branch 1 taken 12755227 times.
✓ Branch 2 taken 115555308 times.
✓ Branch 4 taken 101046791 times.
✓ Branch 5 taken 20119748 times.
✗ Branch 3 not taken.
✓ Branch 7 taken 95632 times.
✗ Branch 8 not taken.
✓ Branch 6 taken 303441 times.
✓ Branch 9 taken 2539570 times.
✗ Branch 10 not taken.
✗ Branch 0 not taken.
✓ Branch 12 taken 11050 times.
✗ Branch 13 not taken.
✓ Branch 15 taken 264784 times.
✗ Branch 16 not taken.
388194465 return elementIndex_;
138 }
139
140 private:
141 GlobalPosition dofPosition_;
142 GlobalPosition center_;
143 Scalar volume_;
144 GridIndexType elementIndex_;
145 LocalIndexType localDofIdx_;
146 GridIndexType dofIndex_;
147 };
148
149 } // end namespace Dumux
150
151 #endif
152