From 0e363cb7406e7da59281d7bcca425c03bba9aed3 Mon Sep 17 00:00:00 2001 From: Markus Blatt Date: Wed, 15 Nov 2023 20:02:03 +0100 Subject: [PATCH] Clarify that Intersection::indexInInside returns FaceDir non-NNC --- opm/grid/cpgrid/Intersection.hpp | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/opm/grid/cpgrid/Intersection.hpp b/opm/grid/cpgrid/Intersection.hpp index e1cf057ab..84bd9930d 100644 --- a/opm/grid/cpgrid/Intersection.hpp +++ b/opm/grid/cpgrid/Intersection.hpp @@ -191,12 +191,28 @@ namespace Dune return geometry().type(); } - /// Local index of codim 1 entity in the inside() entity + /// \brief Local index of codim 1 entity in the inside() entity /// where intersection is contained in. + /// + /// Note that CpGrid does not support codim-1 entities and return + /// the index of the face of the underlying cartesian grid assuming that + /// all faces are perpendicular to the axis: + /// For faces perpendicular to x-axis: 0 (normal points contrary to axis) 1 (else) + /// For faces perpendicular to x-axis: 2 (normal points contrary to axis) 3 (else) + /// For faces perpendicular to x-axis: 4 (normal points contrary to axis) 5 (else) + /// For faces not connecting neighboring elements: -1 int indexInInside() const; - /// Local index of codim 1 entity in outside() entity + /// \brief Local index of codim 1 entity in outside() entity /// where intersection is contained in. + /// + /// Note that CpGrid does not support codim-1 entities and return + /// the index of the face of the underlying cartesian grid assuming that + /// all faces are perpendicular to the axis: + /// For faces perpendicular to x-axis: 0 (normal points contrary to axis) 1 (else) + /// For faces perpendicular to x-axis: 2 (normal points contrary to axis) 3 (else) + /// For faces perpendicular to x-axis: 4 (normal points contrary to axis) 5 (else) + /// For faces not connecting neighboring elements: -1 int indexInOutside() const { int in_inside = indexInInside();