Merge pull request #3629 from lbl-srg/issue3628_cleanDHC

Closes #3628
lbl-srg · Jan 9, 2024 · d9c5cd3 · d9c5cd3
2 parents 259f6a4 + aedc08c
commit d9c5cd3
Show file tree

Hide file tree

Showing 11 changed files with 69 additions and 30 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,21 @@ 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
+<a href=\"https://github.com/lbl-srg/modelica-buildings/issues/3628\">
+issue 3628</a>.
+</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,20 @@ 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
+<a href=\"https://github.com/lbl-srg/modelica-buildings/issues/3628\">
+issue 3628</a>.
+</li>
+<li>
 April 7, 2023, by David Blum:<br/>
 First implementation.
 </li>

diff --git a/...imental/DHC/Plants/Reservoir/BoreField.mo → ...xamples/Combined/BaseClasses/BoreField.mo b/...imental/DHC/Plants/Reservoir/BoreField.mo → ...xamples/Combined/BaseClasses/BoreField.mo
@@ -1,4 +1,4 @@
-within Buildings.Experimental.DHC.Plants.Reservoir;
+within Buildings.Experimental.DHC.Examples.Combined.BaseClasses;
 model BoreField "Geothermal borefield model"
   extends Buildings.Fluid.Geothermal.Borefields.TwoUTubes(
     final energyDynamics=Modelica.Fluid.Types.Dynamics.FixedInitial,
@@ -79,6 +79,13 @@ double U-tube parallel configuration.
 </html>", revisions="<html>
 <ul>
 <li>
+January 8, 2024, by David Blum:<br/>
+Moved to <code>Buildings.Experimental.DHC.Examples.Combined.BaseClasses.BoreField</code>.
+This is for
+<a href=\"https://github.com/lbl-srg/modelica-buildings/issues/3628\">
+issue 3628</a>.
+</li>
+<li>
 May 31, 2023, by Michael Wetter:<br/>
 Removed <code>final</code> modifier for <code>borFieDat</code> to allow record to be replaced
 in models that extend this model.

diff --git a/Buildings/Experimental/DHC/Examples/Combined/BaseClasses/PartialSeries.mo b/Buildings/Experimental/DHC/Examples/Combined/BaseClasses/PartialSeries.mo
@@ -22,8 +22,8 @@ partial model PartialSeries "Partial model for series network"
     datDes(final mCon_flow_nominal=bui.ets.mSerWat_flow_nominal) "Design data"
     annotation (Placement(transformation(extent={{-340,220},{-320,240}})));
   // COMPONENTS
-  Buildings.Experimental.DHC.Plants.Reservoir.BoreField
-    borFie(redeclare final package Medium = Medium) "Bore field" annotation (
+  Buildings.Experimental.DHC.Examples.Combined.BaseClasses.BoreField borFie(
+      redeclare final package Medium = Medium) "Bore field" annotation (
       Placement(transformation(
         extent={{-10,-10},{10,10}},
         rotation=0,

diff --git a/Buildings/Experimental/DHC/Examples/Combined/BaseClasses/package.order b/Buildings/Experimental/DHC/Examples/Combined/BaseClasses/package.order
@@ -1,2 +1,3 @@
+BoreField
 PartialSeries
 DesignDataSeries
diff --git a/Buildings/Experimental/DHC/Plants/Heating/package.mo b/Buildings/Experimental/DHC/Plants/Heating/package.mo
@@ -1,6 +1,6 @@
 within Buildings.Experimental.DHC.Plants;
 package Heating "Package of models for central heating production"
-  extends Modelica.Icons.Package;
+  extends Modelica.Icons.VariantsPackage;
 annotation (preferredView="info", Documentation(info="<html>
 <p>
 This package contains models for central plants producing hot water.

diff --git a/Buildings/Experimental/DHC/Plants/Reservoir/package.mo b/Buildings/Experimental/DHC/Plants/Reservoir/package.mo
diff --git a/Buildings/Experimental/DHC/Plants/Reservoir/package.order b/Buildings/Experimental/DHC/Plants/Reservoir/package.order
diff --git a/Buildings/Experimental/DHC/Plants/package.order b/Buildings/Experimental/DHC/Plants/package.order
@@ -1,6 +1,5 @@
 Combined
 Cooling
 Heating
-Reservoir
 Steam
 BaseClasses
diff --git a/Buildings/Resources/Scripts/Conversion/ConvertBuildings_from_10_to_11.0.0.mos b/Buildings/Resources/Scripts/Conversion/ConvertBuildings_from_10_to_11.0.0.mos
@@ -45,3 +45,7 @@ convertClass("Buildings.Controls.OBC.CDL.Logical.ZeroCrossing",
 // Conversion for https://github.com/lbl-srg/modelica-buildings/issues/3596
 convertClass("Buildings.Controls.OBC.CDL.Reals.Sources.ModelTime",
              "Buildings.Controls.OBC.CDL.Reals.Sources.CivilTime");
+
+// Conversion for https://github.com/lbl-srg/modelica-buildings/issues/xxxx
+convertClass("Buildings.Experimental.DHC.Plants.Reservoir.Borefield",
+             "Buildings.Experimental.DHC.Examples.Combined.BaseClasses.BoreField");
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/3628\">issue 3628</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/3628\">issue 3628</a>.
+    </td>
+</tr>    
 <tr><td colspan=\"2\"><b>Buildings.Templates</b>
     </td>
 </tr>
@@ -475,6 +492,14 @@ have been <b style=\"color:blue\">improved</b> in a
                      This change is supported in the conversion script.
     </td>
 </tr>
+<tr><td valign=\"top\">Buildings.Experimental.DHC.Plants.Reservoir.Borefield
+    </td>
+    <td valign=\"top\">Moved to Buildings.Experimental.DHC.Examples.Combined.BaseClasses.BoreField
+                       <a href=\"Modelica://Buildings.Experimental.DHC.Examples.Combined.BaseClasses.BoreField\"></a>.<br/>
+                     This is for <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/3628\">#3628</a>.<br/>
+                     This change is supported in the conversion script.
+    </td>
+</tr>
 <tr><td colspan=\"2\"><b>Buildings.Fluid.SolarCollectors</b>
     </td>
 </tr>