ENH: Updated IOMRFZoneList header documentation

2025-11-28 03:28:01 +00:00 · 2012-10-30 08:25:44 +00:00
parent dec670d2f3
commit 33d6015686
1 changed files with 18 additions and 1 deletions
--- a/src/finiteVolume/cfdTools/general/MRF/IOMRFZoneList.H
+++ b/src/finiteVolume/cfdTools/general/MRF/IOMRFZoneList.H
@ -25,7 +25,24 @@ Class
    Foam::IOMRFZoneList

 Description
-    List of MRF zones with IO functionality
+    List of MRF zones with IO functionality.  MRF zones are specified by a list
+    of dictionary entries, e.g.
+
+    \verbatim
+    zone1
+    {
+        cellZone    rotor1;
+        active      yes;
+        ...
+    }
+
+    zone2
+    {
+        cellZone    rotor2;
+        active      yes;
+        ...
+    }
+    \endverbatim

 SourceFiles
    IOMRFZoneList.C