From 33d6015686afae21c77f280b7a862af80991e347 Mon Sep 17 00:00:00 2001
From: andy <andy>
Date: Tue, 30 Oct 2012 08:25:44 +0000
Subject: [PATCH] ENH: Updated IOMRFZoneList header documentation
---
.../cfdTools/general/MRF/IOMRFZoneList.H | 19 ++++++++++++++++++-
1 file changed, 18 insertions(+), 1 deletion(-)
diff --git a/src/finiteVolume/cfdTools/general/MRF/IOMRFZoneList.H b/src/finiteVolume/cfdTools/general/MRF/IOMRFZoneList.H
index 4ac60263fdc..09b65913136 100644
--- 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
--
GitLab