Updated user guide regarding scaling

ibpsa · May 3, 2024 · fb3c61f · fb3c61f
1 parent d9f33d4
commit fb3c61f
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 2 deletions.
diff --git a/IBPSA/Fluid/Chillers/ModularReversible/RefrigerantCycle/TableData2D.mo b/IBPSA/Fluid/Chillers/ModularReversible/RefrigerantCycle/TableData2D.mo
@@ -161,7 +161,13 @@ equation
 <h4>Scaling factor</h4>
 <p>
 For the scaling factor, the table data for evaporator heat flow rate
-is evaluated at nominal conditions. Then, the table data is scaled linearly.
+is evaluated at nominal conditions. Hence, the scaling factor is</p>
+<pre>
+scaFac = QEva_flow_nominal/QUse_flow_nominal(TEva_nominal, TCon_nominal).
+
+</pre>
+<p>
+Using <code>scaFac</code>, the table data is scaled linearly.
 This implies a constant COP over different design sizes:
 </p>
 <p><code>QEva_flow = scaFac * tabQEva_flow.y</code> </p>

diff --git a/IBPSA/Fluid/HeatPumps/ModularReversible/RefrigerantCycle/TableData2D.mo b/IBPSA/Fluid/HeatPumps/ModularReversible/RefrigerantCycle/TableData2D.mo
@@ -163,7 +163,14 @@ equation
 <h4>Scaling factor</h4>
 <p>
 For the scaling factor, the table data for condenser heat flow rate
-is evaluated at nominal conditions. Then, the table data is scaled linearly.
+is evaluated at nominal conditions. Hence, the scaling factor is
+</p>
+<pre>
+scaFac = QCon_flow_nominal/QUse_flow_nominal(TEva_nominal, TCon_nominal).
+
+</pre>
+<p>
+Using <code>scaFac</code>, the table data is scaled linearly.
 This implies a constant COP over different design sizes:
 </p>
 <p><code>QCon_flow = scaFac * tabQCon_flow.y</code> </p>

diff --git a/IBPSA/Fluid/HeatPumps/ModularReversible/UsersGuide.mo b/IBPSA/Fluid/HeatPumps/ModularReversible/UsersGuide.mo
@@ -413,6 +413,18 @@ The following tables summarizes the possible options.
   are similar between heating and cooling. The pre-configured models
   warn about deviations if they are too large.
 </p>
+<p>
+  To change the capacity of the model, users should change
+  <code>QHea_flow_nominal</code> for heating operation and
+  <code>QCoo_flow_nominal</code> for cooling operation. This will then also
+  update the electricity use <code>PEle_nominal</code>.<br/>
+  For models with table-based performance curves, changing these values will also scale
+  the design mass flow rates and pressure drops.
+  The documentation of
+  <a href=\"modelica://IBPSA.Fluid.HeatPumps.ModularReversible.TableData2D\">
+  IBPSA.Fluid.HeatPumps.ModularReversible.TableData2D</a>
+  further explains the scaling.
+</p>
 
 <h4>Safety controls</h4>