GCC Code Coverage Report


Directory: ../../../builds/dumux-repositories/
File: dumux/dumux/discretization/box/subcontrolvolume.hh
Date: 2025-06-14 19:21:29
Exec Total Coverage
Lines: 24 24 100.0%
Functions: 21 22 95.5%
Branches: 171 209 81.8%

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/box/boxgeometryhelper.hh>
23
24 namespace Dumux {
25
26 /*!
27 * \ingroup BoxDiscretization
28 * \brief Default traits class to be used for the sub-control volumes
29 * for the box scheme
30 * \tparam GV the type of the grid view
31 */
32 template<class GridView>
33 struct BoxDefaultScvGeometryTraits
34 {
35 using Grid = typename GridView::Grid;
36
37 static const int dim = Grid::dimension;
38 static const int dimWorld = Grid::dimensionworld;
39
40 using GridIndexType = typename IndexTraits<GridView>::GridIndex;
41 using LocalIndexType = typename IndexTraits<GridView>::LocalIndex;
42 using Scalar = typename Grid::ctype;
43 using GeometryTraits = BoxMLGeometryTraits<Scalar>;
44 using Geometry = Dune::MultiLinearGeometry<Scalar, dim, dimWorld, GeometryTraits>;
45 using CornerStorage = typename GeometryTraits::template CornerStorage<dim, dimWorld>::Type;
46 using GlobalPosition = typename Geometry::GlobalCoordinate;
47 };
48
49 /*!
50 * \ingroup BoxDiscretization
51 * \brief the sub control volume for the box scheme
52 * \tparam GV the type of the grid view
53 * \tparam T the scvf geometry traits
54 */
55 template<class GV,
56 class T = BoxDefaultScvGeometryTraits<GV> >
57 class BoxSubControlVolume
58 {
59 using ThisType = BoxSubControlVolume<GV, T>;
60 using Geometry = typename T::Geometry;
61 using GridIndexType = typename T::GridIndexType;
62 using LocalIndexType = typename T::LocalIndexType;
63 using Scalar = typename T::Scalar;
64 static constexpr int dim = Geometry::mydimension;
65
66 public:
67 //! export the type used for global coordinates
68 using GlobalPosition = typename T::GlobalPosition;
69 //! state the traits public and thus export all types
70 using Traits = T;
71
72 //! The default constructor
73 18301988 BoxSubControlVolume() = default;
74
75 // the constructor in the box case
76 template<class Corners>
77 41620245 BoxSubControlVolume(const Corners& corners,
78 LocalIndexType scvIdx,
79 GridIndexType elementIndex,
80 GridIndexType dofIndex)
81 41620245 : dofPosition_(corners[0])
82 41620245 , center_(Dumux::center(corners))
83 41620245 , elementIndex_(elementIndex)
84 41620245 , localDofIdx_(scvIdx)
85 41620245 , dofIndex_(dofIndex)
86 {
87 // The corner list is defined such that the first entry is the vertex itself
88 43939899 volume_ = Dumux::convexPolytopeVolume<dim>(
89 Dune::GeometryTypes::cube(dim),
90 81249880 [&](unsigned int i){ return corners[i]; }
91 );
92 41620245 }
93
94 //! The center of the sub control volume
95 53539645 const GlobalPosition& center() const
96 {
97
12/12
✓ Branch 2 taken 16617854 times.
✓ Branch 3 taken 9290503 times.
✓ Branch 0 taken 20713090 times.
✓ Branch 1 taken 62221175 times.
✓ Branch 7 taken 6712710 times.
✓ Branch 8 taken 768666 times.
✓ Branch 4 taken 9700601 times.
✓ Branch 9 taken 646800 times.
✓ Branch 10 taken 269835 times.
✓ Branch 6 taken 6305372 times.
✓ Branch 5 taken 6407520 times.
✓ Branch 11 taken 632033 times.
711163109 return center_;
98 }
99
100 //! The volume of the sub control volume
101 627365539 Scalar volume() const
102 {
103
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.
594876539 return volume_;
104 }
105
106 //! The element-local index of the dof this scv is embedded in
107 1615037407 LocalIndexType localDofIndex() const
108 {
109
32/45
✓ Branch 1 taken 29030037 times.
✓ Branch 2 taken 5625949 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.
1589549556 return localDofIdx_;
110 }
111
112 //! The element-local index of this scv.
113 //! For the standard box scheme this is the local dof index.
114 9847452115 LocalIndexType indexInElement() const
115 {
116
40/42
✓ Branch 0 taken 244369396 times.
✓ Branch 1 taken 146013756 times.
✓ Branch 2 taken 249916572 times.
✓ Branch 3 taken 817331536 times.
✓ Branch 4 taken 101810456 times.
✓ Branch 5 taken 897216392 times.
✓ Branch 6 taken 269555720 times.
✓ Branch 7 taken 45829610 times.
✓ Branch 8 taken 4896466 times.
✓ Branch 9 taken 8509856 times.
✓ Branch 10 taken 9901683 times.
✓ Branch 11 taken 4577025 times.
✓ Branch 12 taken 10496464 times.
✓ Branch 13 taken 7241195 times.
✓ Branch 14 taken 6131031 times.
✓ Branch 15 taken 19500688 times.
✓ Branch 17 taken 291246 times.
✓ Branch 18 taken 61056 times.
✓ Branch 20 taken 4911695 times.
✓ Branch 21 taken 115521 times.
✓ Branch 23 taken 11433407 times.
✓ Branch 24 taken 5100848 times.
✓ Branch 30 taken 98328 times.
✓ Branch 31 taken 154160 times.
✗ Branch 32 not taken.
✓ Branch 33 taken 294984 times.
✓ Branch 35 taken 40 times.
✗ Branch 36 not taken.
✓ Branch 19 taken 1899648 times.
✓ Branch 16 taken 1359431 times.
✓ Branch 22 taken 745473 times.
✓ Branch 25 taken 3778896 times.
✓ Branch 26 taken 14460002 times.
✓ Branch 27 taken 372734 times.
✓ Branch 34 taken 1300 times.
✓ Branch 37 taken 2600 times.
✓ Branch 39 taken 400 times.
✓ Branch 40 taken 5784 times.
✓ Branch 41 taken 2913 times.
✓ Branch 42 taken 2871 times.
✓ Branch 43 taken 1 times.
✓ Branch 44 taken 37039 times.
9764216801 return localDofIdx_;
117 }
118
119 //! The index of the dof this scv is embedded in
120 453565057 GridIndexType dofIndex() const
121 {
122
54/68
✓ Branch 1 taken 7668870 times.
✓ Branch 2 taken 18256 times.
✓ Branch 4 taken 31003453 times.
✓ Branch 5 taken 1338269 times.
✓ Branch 7 taken 45745478 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 150666189 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 6104768 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.
451342095 return dofIndex_;
123 }
124
125 // The position of the dof this scv is embedded in
126 30288000 const GlobalPosition& dofPosition() const
127 {
128
18/19
✓ Branch 0 taken 2759153 times.
✓ Branch 1 taken 1080239 times.
✓ Branch 2 taken 3250986 times.
✓ Branch 3 taken 2304603 times.
✓ Branch 4 taken 1694900 times.
✓ Branch 5 taken 875795 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.
603115388 return dofPosition_;
129 }
130
131 //! The global index of the element this scv is embedded in
132 130296507 GridIndexType elementIndex() const
133 {
134
9/15
✓ Branch 1 taken 12755227 times.
✓ Branch 2 taken 114582508 times.
✓ Branch 4 taken 101040391 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.
440843749 return elementIndex_;
135 }
136
137 private:
138 GlobalPosition dofPosition_;
139 GlobalPosition center_;
140 Scalar volume_;
141 GridIndexType elementIndex_;
142 LocalIndexType localDofIdx_;
143 GridIndexType dofIndex_;
144 };
145
146 } // end namespace Dumux
147
148 #endif
149