From 3b6bb55bcf8059a775dbd9be5852262896470f5f Mon Sep 17 00:00:00 2001
From: mattijs <mattijs>
Date: Tue, 31 Jan 2012 12:28:45 +0000
Subject: [PATCH] STYLE: tetIndices.H: additional comment in header

---
 .../polyMeshTetDecomposition/tetIndices.H      | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/src/OpenFOAM/meshes/polyMesh/polyMeshTetDecomposition/tetIndices.H b/src/OpenFOAM/meshes/polyMesh/polyMeshTetDecomposition/tetIndices.H
index f0dea9aad8b..4eb21b6ac9e 100644
--- a/src/OpenFOAM/meshes/polyMesh/polyMeshTetDecomposition/tetIndices.H
+++ b/src/OpenFOAM/meshes/polyMesh/polyMeshTetDecomposition/tetIndices.H
@@ -28,6 +28,24 @@ Description
     Storage and named access for the indices of a tet which is part of
     the decomposition of a cell.
 
+    Tets are designated by
+    - cell (of course)
+    - face on cell
+    - three points on face (faceBasePt, facePtA, facePtB)
+      When constructing from a mesh and index in the face (tetPtI):
+        - faceBasePt is the mesh.tetBasePtIs() base point
+        - facePtA is tetPtI away from faceBasePt
+        - facePtB is next one after/before facePtA
+        e.g.:
+
+            +---+
+            |2 /|
+            | / |
+            |/ 1|  <- tetPt (so 1 for first triangle, 2 for second)
+            +---+
+            ^
+           faceBasePt
+
 SourceFiles
     tetIndicesI.H
     tetIndices.C
-- 
GitLab