Merge branch 'feature/box-scvf-num-outside-scvs' into 'master'

Feature/box scvf num outside scvs

See merge request !2469

dumux/discretization/box/subcontrolvolumeface.hh

@@ -172,7 +172,7 @@ public:
         return area_;
     }
 
-    //! returns bolean if the sub control volume face is on the boundary
+    //! returns true if the sub control volume face is on the boundary
     bool boundary() const
     {
         return boundary_;
@@ -183,20 +183,26 @@ public:
         return unitOuterNormal_;
     }
 
-    //! index of the inside sub control volume for spatial param evaluation
+    //! index of the inside sub control volume
     LocalIndexType insideScvIdx() const
     {
         return scvIndices_[0];
     }
 
-    //! index of the outside sub control volume for spatial param evaluation
-    // This results in undefined behaviour if boundary is true
-    LocalIndexType outsideScvIdx() const
+    //! Index of the i-th outside sub control volume or boundary scv index.
+    // Results in undefined behaviour if i >= numOutsideScvs()
+    LocalIndexType outsideScvIdx(int i = 0) const
     {
         assert(!boundary());
         return scvIndices_[1];
     }
 
+    //! The number of scvs on the outside of this face
+    std::size_t numOutsideScvs() const
+    {
+        return static_cast<std::size_t>(!boundary());
+    }
+
     //! The local index of this sub control volume face
     GridIndexType index() const
     {

dumux/discretization/cellcentered/mpfa/subcontrolvolumeface.hh

@@ -155,7 +155,7 @@ public:
     Scalar area() const
     { return area_; }
 
-    //! returns bolean if the sub control volume face is on the domain boundary
+    //! returns true if the sub control volume face is on the domain boundary
     bool boundary() const
     { return boundary_; }
 
@@ -175,12 +175,12 @@ public:
     GridIndexType insideScvIdx() const
     { return insideScvIdx_; }
 
-    //! The number of outside scvs connection via this scv face
+    //! The number of scvs on the outside of this scv face
     std::size_t numOutsideScvs() const
     { return outsideScvIndices_.size(); }
 
-    //! index of the outside sub control volume or boundary scv index
-    //! returns undefined behaviour if index exceeds numOutsideScvs
+    //! Index of the i-th outside sub control volume or boundary scv index.
+    // Results in undefined behaviour if i >= numOutsideScvs()
     GridIndexType outsideScvIdx(int i = 0) const
     { return outsideScvIndices_[i]; }
 

dumux/discretization/cellcentered/tpfa/subcontrolvolumeface.hh

@@ -155,7 +155,7 @@ public:
         return area_;
     }
 
-    //! returns bolean if the sub control volume face is on the boundary
+    //! returns true if the sub control volume face is on the boundary
     bool boundary() const
     {
         return boundary_;
@@ -167,20 +167,20 @@ public:
         return unitOuterNormal_;
     }
 
-    //! index of the inside sub control volume for spatial param evaluation
+    //! index of the inside sub control volume
     GridIndexType insideScvIdx() const
     {
         return scvIndices_[0];
     }
 
-    //! index of the outside sub control volume for spatial param evaluation
-    // This results in undefined behaviour if boundary is true
+    //! Index of the i-th outside sub control volume or boundary scv index.
+    // Results in undefined behaviour if i >= numOutsideScvs()
     GridIndexType outsideScvIdx(int i = 0) const
     {
         return scvIndices_[i+1];
     }
 
-    //! The number of outside scvs connection via this scv face
+    //! The number of scvs on the outside of this face
     std::size_t numOutsideScvs() const
     {
         return scvIndices_.size()-1;

dumux/multidomain/facet/box/subcontrolvolumeface.hh

@@ -131,11 +131,11 @@ public:
     Scalar area() const
     { return area_; }
 
-    //! returns bolean if the sub control volume face is on the boundary
+    //! returns true if the sub control volume face is on the boundary
     bool boundary() const
     { return boundary_; }
 
-    //! returns bolean if the sub control volume face is on an interior boundary
+    //! returns true if the sub control volume face is on an interior boundary
     bool interiorBoundary() const
     { return interiorBoundary_; }
 
@@ -144,7 +144,7 @@ public:
     const GlobalPosition& unitOuterNormal() const
     { return unitOuterNormal_; }
 
-    //! index of the inside sub control volume for spatial param evaluation
+    //! index of the inside sub control volume
     LocalIndexType insideScvIdx() const
     { return scvIndices_[0]; }
 
@@ -152,14 +152,20 @@ public:
     GridIndexType index() const
     { return scvfIndex_; }
 
-    //! index of the outside sub control volume for spatial param evaluation
-    //! This results in undefined behaviour if boundary is true
-    LocalIndexType outsideScvIdx() const
+    //! Index of the i-th outside sub control volume or boundary scv index.
+    // Results in undefined behaviour if i >= numOutsideScvs()
+    LocalIndexType outsideScvIdx(int i = 0) const
     {
-        assert(!boundary());
+        assert(!boundary() && !interiorBoundary());
         return scvIndices_[1];
     }
 
+    //! The number of scvs on the outside of this face
+    std::size_t numOutsideScvs() const
+    {
+        return static_cast<std::size_t>(!(boundary() || interiorBoundary()));
+    }
+
     //! returns the element-local index of the facet this scvf is embedded in.
     //! This is only valid to be called for scvfs on domain/interior boundaries.
     LocalIndexType facetIndexInElement() const

dumux/porousmediumflow/boxdfm/subcontrolvolumeface.hh

@@ -210,7 +210,7 @@ public:
     Scalar area() const
     { return area_; }
 
-    //! returns bolean if the sub control volume face is on the boundary
+    //! returns true if the sub control volume face is on the boundary
     bool boundary() const
     { return boundary_; }
 
@@ -234,18 +234,25 @@ public:
     typename BoundaryFlag::value_type boundaryFlag() const
     { return boundaryFlag_.get(); }
 
-    //! Index of the inside sub control volume for spatial param evaluation
+    //! index of the inside sub control volume
     LocalIndexType insideScvIdx() const
     { return scvIndices_[0]; }
 
-    //! Index of the outside sub control volume for spatial param evaluation
-    // This results in undefined behaviour if boundary is true
-    LocalIndexType outsideScvIdx() const
+    //! Index of the i-th outside sub control volume or boundary scv index.
+    // Results in undefined behaviour if i >= numOutsideScvs()
+    LocalIndexType outsideScvIdx(int i = 0) const
     {
         assert(!boundary());
         return scvIndices_[1];
     }
 
+    //! The number of scvs on the outside of this face
+    std::size_t numOutsideScvs() const
+    {
+        return static_cast<std::size_t>(!boundary());
+    }
+
+    //! Returns a corner of the sub control volume face
     const GlobalPosition& corner(unsigned int localIdx) const
     {
         assert(localIdx < corners_.size() && "provided index exceeds the number of corners");

test/discretization/box/test_boxfvgeometry.cc

@@ -107,6 +107,15 @@ int main (int argc, char *argv[])
                 ++boundaryCount;
                 std::cout << " (on boundary).";
             }
+
+            // verify that boundary faces have no neighbor
+            if (scvf.boundary() && scvf.numOutsideScvs() != 0)
+                DUNE_THROW(Dune::Exception, "Boundary face states that it has a neighbor");
+
+            // verify that non-boundary faces have a single neighbor
+            if (!scvf.boundary() && scvf.numOutsideScvs() != 1)
+                DUNE_THROW(Dune::Exception, "Expected non-boundary face to have a single neighbor");
+
             std::cout << std::endl;
         }