Correct typo in heating ETS

lbl-srg · Jan 8, 2024 · dda6836 · dda6836
1 parent 8097276
commit dda6836
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 15 deletions.
diff --git a/Buildings/Experimental/DHC/EnergyTransferStations/Heating/Direct.mo b/Buildings/Experimental/DHC/EnergyTransferStations/Heating/Direct.mo
@@ -1,5 +1,5 @@
 within Buildings.Experimental.DHC.EnergyTransferStations.Heating;
-model Direct "Direct cooling ETS model for district energy systems with in-building 
+model Direct "Direct heating ETS model for district energy systems with in-building 
   pumping and deltaT control"
   extends
     Buildings.Experimental.DHC.EnergyTransferStations.BaseClasses.PartialDirect(
@@ -21,12 +21,12 @@ equation
     defaultComponentName="etsCoo",
     Documentation(info="<html>
 <p>
-Direct cooling energy transfer station (ETS) model with in-building pumping and 
-deltaT control. The design is based on a typical district cooling ETS described 
-in ASHRAE's <a href=\"https://www.ashrae.org/technical-resources/bookstore/district-heating-and-cooling-guides\">District Cooling Guide</a>. 
+Direct heating energy transfer station (ETS) model with in-building pumping and 
+deltaT control. The design is based on a typical district heating ETS described 
+in ASHRAE's <a href=\"https://www.ashrae.org/technical-resources/bookstore/district-heating-and-cooling-guides\">District Heating Guide</a>. 
 As shown in the figure below, the district and building piping are hydronically 
 coupled. The control valve ensures that the return temperature to the district 
-cooling network is at or above the minimum specified value. This configuration 
+heating network is at or below the maximum specified value. This configuration 
 naturally results in a fluctuating building supply tempearture. 
 </p>
 <p align=\"center\">
@@ -35,14 +35,19 @@ naturally results in a fluctuating building supply tempearture.
 <h4>
 Reference
 </h4>
-<p>American Society of Heating, Refrigeration and Air-Conditioning Engineers. (2019). 
-Chapter 5: End User Interface. In <i>District Cooling Guide</i>, Second Edition and 
-<i>Owner's Guide for Buildings Served by District Cooling</i>. 
+<p>
+American Society of Heating, Refrigeration and Air-Conditioning Engineers. (2013). 
+Chapter 5: Consumer Interconnection. In <i>District Heating Guide</i>. 
 </p>
 </html>",
       revisions="<html>
 <ul>
 <li>
+January 8, 2024, by David Blum:<br/>
+Correct documentation to describe heating.
+This is for xxxx.
+</li>
+<li>
 April 7, 2023, by David Blum:<br/>
 First implementation.
 </li>

diff --git a/Buildings/Experimental/DHC/EnergyTransferStations/Heating/Indirect.mo b/Buildings/Experimental/DHC/EnergyTransferStations/Heating/Indirect.mo
@@ -1,6 +1,6 @@
 within Buildings.Experimental.DHC.EnergyTransferStations.Heating;
 model Indirect
-  "Indirect cooling energy transfer station for district energy systems"
+  "Indirect heating energy transfer station for district energy systems"
   extends
     Buildings.Experimental.DHC.EnergyTransferStations.BaseClasses.PartialIndirect(
       QHeaWat_flow_nominal=Q_flow_nominal,
@@ -23,10 +23,10 @@ equation
     defaultComponentName="etsCoo",
     Documentation(info="<html>
 <p>
-Indirect cooling energy transfer station (ETS) model that controls the
+Indirect heating energy transfer station (ETS) model that controls the
 building chilled water supply temperature by modulating a primary control valve 
-on the district supply side. The design is based on a typical district cooling 
-ETS described in ASHRAE's <a href=\"https://www.ashrae.org/technical-resources/bookstore/district-heating-and-cooling-guides\">District Cooling Guide</a>. 
+on the district supply side. The design is based on a typical district heating 
+ETS described in ASHRAE's <a href=\"https://www.ashrae.org/technical-resources/bookstore/district-heating-and-cooling-guides\">District Heating Guide</a>. 
 As shown in the figure below, the building pumping design (constant/variable) 
 is specified on the building side and not within the ETS. 
 </p>
@@ -35,14 +35,18 @@ is specified on the building side and not within the ETS.
 </p>
 <h4>Reference</h4>
 <p>
-American Society of Heating, Refrigeration and Air-Conditioning Engineers. (2019).
-Chapter 5: End User Interface. In <i>District Cooling Guide</i>, Second Edition and 
-<i>Owner's Guide for Buildings Served by District Cooling</i>. 
+American Society of Heating, Refrigeration and Air-Conditioning Engineers. (2013). 
+Chapter 5: Consumer Interconnection. In <i>District Heating Guide</i>. 
 </p>
 </html>",
       revisions="<html>
 <ul>
 <li>
+January 8, 2024, by David Blum:<br/>
+Correct documentation to describe heating.
+This is for xxxx.
+</li>
+<li>
 April 7, 2023, by David Blum:<br/>
 First implementation.
 </li>

diff --git a/Buildings/package.mo b/Buildings/package.mo
@@ -339,6 +339,23 @@ have been <b style=\"color:blue\">improved</b> in a
                      This is for <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1781\">IBPSA, #1781</a>.
     </td>
 </tr>
+<tr><td colspan=\"2\"><b>Buildings.Experimental.DHC.EnergyTransferStations.Heating</b>
+    </td>
+</tr>
+<tr><td valign=\"top\">Buildings.Experimental.DHC.EnergyTransferStations.Heating.Direct
+    </td>
+    <td valign=\"top\">Documentation corrected for heating.
+                       This is for
+                       <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/xxxx\">issue xxxx</a>.
+    </td>
+</tr>
+<tr><td valign=\"top\">Buildings.Experimental.DHC.EnergyTransferStations.Heating.Indirect
+    </td>
+    <td valign=\"top\">Documentation corrected for heating.
+                       This is for
+                       <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/xxxx\">issue xxxx</a>.
+    </td>
+</tr>    
 <tr><td colspan=\"2\"><b>Buildings.Templates</b>
     </td>
 </tr>