Merged master #2293 [ci skip]

lbl-srg · May 13, 2021 · 8360545 · 8360545
1 parent f21c377
commit 8360545
Show file tree

Hide file tree

Showing 615 changed files with 16,753 additions and 5,958 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -156,4 +156,5 @@ after_failure:
       echo "*** Content of $ff"
       cat $ff
       echo "*** End of $ff"
-    done
+    done
+    
diff --git a/Buildings/Air/Systems/SingleZone/VAV/ChillerDXHeatingEconomizer.mo b/Buildings/Air/Systems/SingleZone/VAV/ChillerDXHeatingEconomizer.mo
@@ -1,6 +1,6 @@
 within Buildings.Air.Systems.SingleZone.VAV;
 model ChillerDXHeatingEconomizer
-  "HVAC system model with a dry cooling coil, air-cooled chiller, electric heating coil, 
+  "HVAC system model with a dry cooling coil, air-cooled chiller, electric heating coil,
    variable speed fan, and mixing box with economizer control."
   replaceable package MediumA = Buildings.Media.Air "Medium model for air"
       annotation (choicesAllMatching = true);
@@ -162,7 +162,7 @@ model ChillerDXHeatingEconomizer
     final dp1_nominal=0,
     final dp2_nominal=0,
     final m2_flow_nominal=mAir_flow_nominal,
-    final Q_flow_nominal=-QCoo_flow_nominal,
+    final Q_flow_nominal=QCoo_flow_nominal,
     final configuration=Buildings.Fluid.Types.HeatExchangerConfiguration.CounterFlow,
     final allowFlowReversal1=false,
     final allowFlowReversal2=false,
@@ -627,6 +627,10 @@ feedback control of damper positions. The cooling coil is a dry coil model.
 </html>", revisions="<html>
 <ul>
 <li>
+February 25, 2021, by Baptiste Ravache:<br/>
+Inverse the sign of <code>cooCoi.Q_flow_nominal</code> to respect the heat flow convention.
+</li>
+<li>
 September 08, 2017, by Thierry S. Nouidui:<br/>
 Removed experiment annotation.
 </li>

diff --git a/Buildings/Air/Systems/SingleZone/package.mo b/Buildings/Air/Systems/SingleZone/package.mo
@@ -1,7 +1,6 @@
 within Buildings.Air.Systems;
 package SingleZone "Package with pre-configured system models that serve a single thermal zone"
   extends Modelica.Icons.Package;
-
 annotation (preferredView="info", Documentation(info="<html>
 <p>
 This package contains pre-configured system models for

diff --git a/Buildings/Air/Systems/package.mo b/Buildings/Air/Systems/package.mo
@@ -1,7 +1,6 @@
 within Buildings.Air;
 package Systems "Package with pre-configured HVAC systems"
   extends Modelica.Icons.Package;
-
 annotation (preferredView="info", Documentation(info="<html>
 <p>
 This package contains pre-configured system models of

diff --git a/Buildings/Air/package.mo b/Buildings/Air/package.mo
@@ -1,7 +1,6 @@
 within Buildings;
 package Air "Package with models that are configured to use with air-based HVAC systems"
   extends Modelica.Icons.Package;
-
 annotation (preferredView="info", Documentation(info="<html>
 <p>
 This package contains models that are configured to be used

diff --git a/Buildings/Airflow/Multizone/BaseClasses/PowerLawResistance.mo b/Buildings/Airflow/Multizone/BaseClasses/PowerLawResistance.mo
@@ -142,7 +142,7 @@ Hence there is no need for the user to change the value.
 April 14, 2020, by Michael Wetter:<br/>
 Changed <code>homotopyInitialization</code> to a constant.<br/>
 This is for
-<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1341\">Buildings, #1341</a>.
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1341\">IBPSA, #1341</a>.
 </li>
 <li>
 June 24, 2018, by Michael Wetter:<br/>
@@ -156,7 +156,7 @@ the Reynolds number, and the Reynolds number is not used by this model.
 Also removed the variable <code>Re</code> for the Reynolds number.<br/>
 This change is non-backward compatible.<br/>
 This is for
-<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/932\">Buildings, #932</a>.
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/932\">IBPSA, #932</a>.
 </li>
 <li>
 May 1, 2018, by Filip Jorissen:<br/>

diff --git a/Buildings/Airflow/Multizone/EffectiveAirLeakageArea.mo b/Buildings/Airflow/Multizone/EffectiveAirLeakageArea.mo
@@ -137,12 +137,12 @@ Changed base class to remove the parameters <code>A</code> and <code>CD</code>
 which are not used by this model.<br/>
 This change is non-backward compatible.<br/>
 This is for
-<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/932\">Buildings, #932</a>.
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/932\">IBPSA, #932</a>.
 </li>
 <li>
 May 30, 2018, by Michael Wetter:<br/>
 Improved documentation for
-<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/546\">Buildings, #546</a>.
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/546\">IBPSA, #546</a>.
 </li>
 <li>
 April 24, 2017, by Filip Jorissen:<br/>

diff --git a/Buildings/Airflow/Multizone/Examples/CO2TransportStep.mo b/Buildings/Airflow/Multizone/Examples/CO2TransportStep.mo
@@ -1,5 +1,5 @@
 within Buildings.Airflow.Multizone.Examples;
-model CO2TransportStep "Model that transport CO2 through buoyancy driven flow"
+model CO2TransportStep "Model with transport of CO2 through buoyancy driven flow"
   extends Buildings.Airflow.Multizone.Validation.ThreeRoomsContam(
     volWes(nPorts=5),
     volTop(nPorts=3),
@@ -18,7 +18,7 @@ model CO2TransportStep "Model that transport CO2 through buoyancy driven flow"
     amplitude=8.18E-6,
     width=1/24/10,
     period=86400,
-    startTime=3600)
+    startTime=3600) "Pulse signal for CO2 flow source"
     annotation (Placement(transformation(extent={{-140,-80},{-120,-60}})));
   Buildings.Fluid.Sources.TraceSubstancesFlowSource sou(
     redeclare package Medium = Medium,
@@ -66,6 +66,11 @@ the other rooms, and eventually its concentration decays.
 </html>", revisions="<html>
 <ul>
 <li>
+March 26, 2021 by Michael Wetter:<br/>
+Updated comments for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/515\">IBPSA, #515</a>.
+</li>
+<li>
 November 10, 2011, by Michael Wetter:<br/>
 Extended model from
 <a href=\"modelica://Buildings.Airflow.Multizone.Validation.ThreeRoomsContam\">

diff --git a/Buildings/Airflow/Multizone/Examples/ChimneyShaftNoVolume.mo b/Buildings/Airflow/Multizone/Examples/ChimneyShaftNoVolume.mo
@@ -1,6 +1,6 @@
 within Buildings.Airflow.Multizone.Examples;
 model ChimneyShaftNoVolume
-  "Model that demonstrates the chimney effect with a steady-state model of a shaft"
+  "Model with chimney effect and a steady-state model of a shaft"
   extends Modelica.Icons.Example;
   package Medium = Modelica.Media.Air.SimpleAir;
 
@@ -17,27 +17,30 @@ model ChimneyShaftNoVolume
   Buildings.Airflow.Multizone.Orifice oriChiTop(
     m=0.5,
     redeclare package Medium = Medium,
-    A=0.01) annotation (Placement(transformation(
+    A=0.01) "Orifice at top"
+            annotation (Placement(transformation(
         origin={70,11},
         extent={{-10,-10},{10,10}},
         rotation=90)));
   Buildings.Fluid.Sources.MassFlowSource_T boundary(
     redeclare package Medium = Medium,
     use_m_flow_in=true,
     T=293.15,
-    nPorts=1)
+    nPorts=1) "Mass flow rate boundary condition"
     annotation (Placement(transformation(extent={{-40,-90},{-20,-70}})));
   Buildings.Fluid.Sources.Boundary_pT bou0(
     redeclare package Medium = Medium,
     T=273.15,
-    nPorts=2) annotation (Placement(transformation(
+    nPorts=2) "Pressure boundary condition"
+              annotation (Placement(transformation(
         extent={{-10,-10},{10,10}},
         rotation=270,
         origin={90,50})));
   Buildings.Airflow.Multizone.Orifice oriBot(
     m=0.5,
     redeclare package Medium = Medium,
-    A=0.01) annotation (Placement(transformation(
+    A=0.01) "Orifice"
+            annotation (Placement(transformation(
         origin={110,-20},
         extent={{10,-10},{-10,10}},
         rotation=90)));
@@ -53,12 +56,14 @@ model ChimneyShaftNoVolume
   Buildings.Airflow.Multizone.Orifice oriChiBot(
     m=0.5,
     redeclare package Medium = Medium,
-    A=0.01) annotation (Placement(transformation(
+    A=0.01) "Orifice at bottom"
+            annotation (Placement(transformation(
         origin={70,-49},
         extent={{-10,-10},{10,10}},
         rotation=90)));
   Modelica.Thermal.HeatTransfer.Sources.PrescribedHeatFlow preHea
-    "Prescribed heat flow" annotation (Placement(transformation(
+    "Prescribed heat flow rate"
+                           annotation (Placement(transformation(
         extent={{-10,-10},{10,10}},
         rotation=270,
         origin={0,10})));
@@ -76,7 +81,7 @@ model ChimneyShaftNoVolume
     "Temperature sensor" annotation (Placement(transformation(
         extent={{-10,-10},{10,10}},
         origin={-80,0})));
-  Modelica.Blocks.Math.Gain gain(k=3000)
+  Modelica.Blocks.Math.Gain gain(k=3000) "Gain for heat flow rate"
     annotation (Placement(transformation(extent={{-28,20},{-8,40}})));
   Buildings.Airflow.Multizone.MediumColumn sha(redeclare package Medium = Medium,
       densitySelection=Buildings.Airflow.Multizone.Types.densitySelection.actual) "Shaft of chimney"
@@ -114,8 +119,7 @@ equation
           -50}},
       color={191,0,0}));
   connect(roo.heatPort, temSen.port) annotation (Line(
-      points={{20,-50},{-40,-50},{-40,-20},{-96,-20},{-96,6.10623e-16},{-90,
-          6.10623e-16}},
+      points={{20,-50},{-94,-50},{-94,6.10623e-16},{-90,6.10623e-16}},
       color={191,0,0}));
   connect(bou0.ports[1], oriChiTop.port_b)  annotation (Line(
       points={{92,40},{88,40},{88,34},{70,34},{70,21}},
@@ -195,6 +199,11 @@ up the other flow path.
 </html>", revisions="<html>
 <ul>
 <li>
+March 26, 2021 by Michael Wetter:<br/>
+Updated comments for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/515\">IBPSA, #515</a>.
+</li>
+<li>
 February 24, 2015 by Michael Wetter:<br/>
 Changed media to
 <a href=\"modelica://Modelica.Media.Air.SimpleAir\">

diff --git a/Buildings/Airflow/Multizone/Examples/ChimneyShaftWithVolume.mo b/Buildings/Airflow/Multizone/Examples/ChimneyShaftWithVolume.mo
@@ -1,6 +1,6 @@
 within Buildings.Airflow.Multizone.Examples;
 model ChimneyShaftWithVolume
-  "Model that demonstrates the chimney effect with a dynamic model of a shaft"
+  "Model with chimney effect and a dynamic model of a shaft"
   extends Modelica.Icons.Example;
   package Medium = Buildings.Media.Air;
 
@@ -17,27 +17,30 @@ model ChimneyShaftWithVolume
   Buildings.Airflow.Multizone.Orifice oriChiTop(
     m=0.5,
     redeclare package Medium = Medium,
-    A=0.01) annotation (Placement(transformation(
+    A=0.01) "Orifice at top"
+            annotation (Placement(transformation(
         origin={70,11},
         extent={{-10,-10},{10,10}},
         rotation=90)));
   Buildings.Fluid.Sources.MassFlowSource_T boundary(
     redeclare package Medium = Medium,
     use_m_flow_in=true,
     T=293.15,
-    nPorts=1)
+    nPorts=1) "Mass flow rate boundary condition"
     annotation (Placement(transformation(extent={{-40,-90},{-20,-70}})));
   Buildings.Fluid.Sources.Boundary_pT bou0(
     redeclare package Medium = Medium,
     T=273.15,
-    nPorts=2) annotation (Placement(transformation(
+    nPorts=2) "Pressure boundary condition"
+              annotation (Placement(transformation(
         extent={{-10,-10},{10,10}},
         rotation=270,
         origin={90,50})));
   Buildings.Airflow.Multizone.Orifice oriBot(
     m=0.5,
     redeclare package Medium = Medium,
-    A=0.01) annotation (Placement(transformation(
+    A=0.01) "Orifice"
+            annotation (Placement(transformation(
         origin={110,-20},
         extent={{10,-10},{-10,10}},
         rotation=90)));
@@ -53,7 +56,8 @@ model ChimneyShaftWithVolume
   Buildings.Airflow.Multizone.Orifice oriChiBot(
     m=0.5,
     redeclare package Medium = Medium,
-    A=0.01) annotation (Placement(transformation(
+    A=0.01) "Orifice at bottom"
+            annotation (Placement(transformation(
         origin={70,-49},
         extent={{-10,-10},{10,10}},
         rotation=90)));
@@ -76,7 +80,7 @@ model ChimneyShaftWithVolume
     "Temperature sensor" annotation (Placement(transformation(
         extent={{-10,-10},{10,10}},
         origin={-80,0})));
-  Modelica.Blocks.Math.Gain gain(k=3000)
+  Modelica.Blocks.Math.Gain gain(k=3000) "Gain for heat flow rate"
     annotation (Placement(transformation(extent={{-28,20},{-8,40}})));
   Buildings.Airflow.Multizone.MediumColumnDynamic sha(
     redeclare package Medium = Medium,
@@ -117,8 +121,7 @@ equation
           -50}},
       color={191,0,0}));
   connect(roo.heatPort, temSen.port) annotation (Line(
-      points={{20,-50},{-40,-50},{-40,-20},{-96,-20},{-96,6.10623e-16},{-90,
-          6.10623e-16}},
+      points={{20,-50},{-94,-50},{-94,0},{-92,0},{-92,6.10623e-16},{-90,6.10623e-16}},
       color={191,0,0}));
   connect(bou0.ports[1], oriChiTop.port_b)  annotation (Line(
       points={{92,40},{88,40},{88,34},{70,34},{70,21}},
@@ -162,6 +165,11 @@ connected in series.)
 </html>", revisions="<html>
 <ul>
 <li>
+March 26, 2021 by Michael Wetter:<br/>
+Updated comments for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/515\">IBPSA, #515</a>.
+</li>
+<li>
 January 8, 2019, by Michael Wetter:<br/>
 Removed parameter assignment for <code>sha.m_flow_nominal</code>.<br/>
 This is for

diff --git a/Buildings/Airflow/Multizone/Examples/ClosedDoors.mo b/Buildings/Airflow/Multizone/Examples/ClosedDoors.mo
@@ -15,29 +15,31 @@ model ClosedDoors "Model with three closed doors"
     nPorts=4,
     energyDynamics=Modelica.Fluid.Types.Dynamics.FixedInitial,
     massDynamics=Modelica.Fluid.Types.Dynamics.FixedInitial,
-    m_flow_nominal=0.01)
+    m_flow_nominal=0.01) "Control volume"
     annotation (Placement(transformation(extent={{-80,0},{-60,20}})));
   Buildings.Fluid.MixingVolumes.MixingVolume volB(
     redeclare package Medium = Medium,
     V=2.5*5*5,
     nPorts=4,
     energyDynamics=Modelica.Fluid.Types.Dynamics.FixedInitial,
     massDynamics=Modelica.Fluid.Types.Dynamics.FixedInitial,
-    m_flow_nominal=0.01)
+    m_flow_nominal=0.01) "Control volume"
     annotation (Placement(transformation(extent={{40,40},{60,60}})));
-  Modelica.Thermal.HeatTransfer.Sources.PrescribedHeatFlow PrescribedHeatFlow1
+  Modelica.Thermal.HeatTransfer.Sources.PrescribedHeatFlow preHeaFlo
+    "Prescribed heat flow rate boundary condition"
     annotation (Placement(transformation(extent={{4,40},{24,60}})));
-  Modelica.Blocks.Sources.Sine Sine1(freqHz=1/3600) annotation (Placement(
-        transformation(extent={{-68,40},{-48,60}})));
-  Modelica.Blocks.Math.Gain Gain1(k=100) annotation (Placement(transformation(
-          extent={{-28,40},{-8,60}})));
+  Modelica.Blocks.Sources.Sine sinBou(freqHz=1/3600)
+    "Signal for heat flow rate boundary condition"
+    annotation (Placement(transformation(extent={{-68,40},{-48,60}})));
+  Modelica.Blocks.Math.Gain gai(k=100) "Gain for heat flow boundary condition"
+    annotation (Placement(transformation(extent={{-28,40},{-8,60}})));
   Buildings.Fluid.MixingVolumes.MixingVolume volC(
     redeclare package Medium = Medium,
     V=2.5*5*5,
     nPorts=4,
     energyDynamics=Modelica.Fluid.Types.Dynamics.FixedInitial,
     massDynamics=Modelica.Fluid.Types.Dynamics.FixedInitial,
-    m_flow_nominal=0.01)
+    m_flow_nominal=0.01) "Control volume"
     annotation (Placement(transformation(extent={{70,-40},{90,-20}})));
   Buildings.Airflow.Multizone.DoorDiscretizedOperable dooAC(
     redeclare package Medium = Medium,
@@ -53,9 +55,9 @@ model ClosedDoors "Model with three closed doors"
     forceErrorControlOnFlow=true) "Discretized door"
     annotation (Placement(transformation(extent={{10,-90},{30,-70}})));
 equation
-  connect(Gain1.y, PrescribedHeatFlow1.Q_flow)
+  connect(gai.y, preHeaFlo.Q_flow)
     annotation (Line(points={{-7,50},{4,50}}, color={0,0,255}));
-  connect(Sine1.y, Gain1.u)
+  connect(sinBou.y, gai.u)
     annotation (Line(points={{-47,50},{-30,50}}, color={0,0,255}));
   connect(yDoor.y, dooAB.y)
                            annotation (Line(points={{-39,-80},{-34,-80},{-34,-20},
@@ -66,9 +68,8 @@ equation
   connect(yDoor.y, dooBC.y)
     annotation (Line(points={{-39,-80},{-16,-80},{9,-80}},
                                                          color={0,0,255}));
-  connect(PrescribedHeatFlow1.port, volB.heatPort) annotation (Line(
-      points={{24,50},{40,50}},
-      color={191,0,0}));
+  connect(preHeaFlo.port, volB.heatPort)
+    annotation (Line(points={{24,50},{40,50}}, color={191,0,0}));
   connect(volC.ports[1], dooAC.port_b1) annotation (Line(
       points={{77,-40},{76,-40},{76,-44},{74,-44},{74,-44},{30,-44}},
       color={0,127,255}));
@@ -129,6 +130,11 @@ does not account for expansion if air the air is heated.
 </html>", revisions="<html>
 <ul>
 <li>
+March 26, 2021 by Michael Wetter:<br/>
+Updated comments for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/515\">IBPSA, #515</a>.
+</li>
+<li>
 December 22, 2014 by Michael Wetter:<br/>
 Removed <code>Modelica.Fluid.System</code>
 to address issue
-Original file line number
+Diff line change
@@ Expand Up / @@ -156,4 +156,5 @@ after_failure: @@
           echo "*** Content of $ff"
           cat $ff
           echo "*** End of $ff"
-        done
+        done