From eb17ff1ea36ed9b485248a3adb3fe1e0d061df16 Mon Sep 17 00:00:00 2001
From: mattijs <mattijs>
Date: Sat, 18 May 2024 12:55:55 +0100
Subject: [PATCH] DOC: cyclicPeriodicAMI: bit of comment

---
 .../cyclicPeriodicAMIPolyPatch.H                          | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/meshTools/AMIInterpolation/patches/cyclicPeriodicAMI/cyclicPeriodicAMIPolyPatch/cyclicPeriodicAMIPolyPatch.H b/src/meshTools/AMIInterpolation/patches/cyclicPeriodicAMI/cyclicPeriodicAMIPolyPatch/cyclicPeriodicAMIPolyPatch.H
index 00fa19cd6b4..40fce017e76 100644
--- a/src/meshTools/AMIInterpolation/patches/cyclicPeriodicAMI/cyclicPeriodicAMIPolyPatch/cyclicPeriodicAMIPolyPatch.H
+++ b/src/meshTools/AMIInterpolation/patches/cyclicPeriodicAMI/cyclicPeriodicAMIPolyPatch/cyclicPeriodicAMIPolyPatch.H
@@ -29,6 +29,10 @@ Class
 Description
     Cyclic patch for periodic Arbitrary Mesh Interface (AMI)
 
+    Uses automated matching to fill all of the faces on owner and neighbour.
+    Can be used for translational periodic matching as well. Uses the
+    transforms from a specified periodic patch to transform the geometry.
+
 SourceFiles
     cyclicPeriodicAMIPolyPatch.C
 
@@ -59,7 +63,9 @@ private:
 
     // Private data
 
-        //- Current number of transformations (+ve forward, -ve backward)
+        //- Current number of transformations (+ve forward, -ve backward).
+        //- Used internally to stores the last state that gave a starting
+        //- match. Speeds up the automatic matching.
         mutable label nTransforms_;
 
         //- Number of sectors in a rotationally periodic geometry (optional)
-- 
GitLab