From 7e98a2c00c84ceaa89bc33ad4800ad5c56cabf1c Mon Sep 17 00:00:00 2001
From: andy <andy>
Date: Wed, 25 Sep 2013 12:27:45 +0100
Subject: [PATCH] ENH: effectivenessHeatExchangerSource - updated documentation

---
 .../effectivenessHeatExchangerSource.H        | 35 +++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
index d5ee68b61f..b60e7f8cb7 100644
--- a/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
+++ b/src/fvOptions/sources/derived/effectivenessHeatExchangerSource/effectivenessHeatExchangerSource.H
@@ -82,6 +82,41 @@ Description
     }
     \endverbatim
 
+    The effectiveness table is described in terms of the primary and secondary
+    mass flow rates.  For example, the table:
+
+                           secondary MFR
+                       |  0.1   0.2   0.3
+                  -----+-----------------
+                  0.02 |   A     B     C
+     primary MFR  0.04 |   D     E     F
+                  0.06 |   G     H     I
+
+
+    Is specified by the following:
+
+        (
+            0.02
+            (
+                (0.1    A)
+                (0.2    B)
+                (0.3    C)
+            ),
+            0.04
+            (
+                (0.1    D)
+                (0.2    E)
+                (0.3    F)
+            ),
+            0.06
+            (
+                (0.1    G)
+                (0.2    H)
+                (0.3    I)
+            )
+        );
+
+
 Note
 - the table with name "fileName" should have the same units as the
   secondary mass flow rate and kg/s for phi