Skip to content

Commit

Permalink
Clarify that Intersection::indexInInside returns FaceDir non-NNC
Browse files Browse the repository at this point in the history
  • Loading branch information
blattms committed Nov 17, 2023
1 parent 7271299 commit 7fa451e
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions opm/grid/cpgrid/Intersection.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down

0 comments on commit 7fa451e

Please sign in to comment.