Added validation for bottom cycle (PR 4293)

.travis.yml

@@ -1,10 +1,10 @@
 os: Linux
-dist: focal
+dist: nobel
 
 language: python
 
 python:
-  - "3.8"
+  - "3.12"
 
 branches:
   only:
@@ -47,6 +47,9 @@ env:
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.{Air,Examples}\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.{Air,Examples}\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.{Air,Examples}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Controls\""
+    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Controls\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Controls\""
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.ThermalZones.EnergyPlus_24_2_0\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.ThermalZones.EnergyPlus_24_2_0\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.ThermalZones.EnergyPlus_24_2_0\""
@@ -83,18 +86,21 @@ env:
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.FixedResistances\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Fluid.FixedResistances\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.FixedResistances\""
-    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.{Geothermal,HeatExchangers,HeatPumps,Humidifiers,HydronicConfigurations,Interfaces}\""
-    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Fluid.{Geothermal,HeatExchangers,HeatPumps,Humidifiers,HydronicConfigurations,Interfaces}\""
-    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.{Geothermal,HeatExchangers,HeatPumps,Humidifiers,HydronicConfigurations,Interfaces}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.Geothermal\""
+    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Fluid.Geothermal\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.Geothermal\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.{HeatExchangers,HeatPumps,Humidifiers,HydronicConfigurations,Interfaces}\""
+    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Fluid.{HeatExchangers,HeatPumps,Humidifiers,HydronicConfigurations,Interfaces}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.{HeatExchangers,HeatPumps,Humidifiers,HydronicConfigurations,Interfaces}\""
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.{MassExchangers,MixingVolumes,Movers,Sensors,SolarCollectors,Sources,Storage,Utilities}\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Fluid.{MassExchangers,MixingVolumes,Movers,Sensors,SolarCollectors,Sources,Storage,Utilities}\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.{MassExchangers,MixingVolumes,Movers,Sensors,SolarCollectors,Sources,Storage,Utilities}\""
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Electrical\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.Electrical\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Electrical\""
-    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.{Airflow,BoundaryConditions,Controls}\""
-    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.{Airflow,BoundaryConditions,Controls}\""
-    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.{Airflow,BoundaryConditions,Controls}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.{Airflow,BoundaryConditions}\""
+    - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.{Airflow,BoundaryConditions}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.{Airflow,BoundaryConditions}\""
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.HeatTransfer\""
     - TEST_ARG="make test-openmodelica PACKAGE=\"Buildings.HeatTransfer\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.HeatTransfer\""
@@ -107,7 +113,9 @@ env:
     - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Templates\""
     - TEST_ARG="make test-openmodelica  PACKAGE=\"Buildings.Templates\""
     - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Templates\""
-    - TEST_ARG="make test-templates-dymola"
+    - TEST_ARG="make test-templates-dymola PACKAGE=\"Buildings.Templates.AirHandlersFans\" COVER=0.5"
+    - TEST_ARG="make test-templates-dymola PACKAGE=\"Buildings.Templates.Plants.HeatPumps\" COVER=0.2"
+    - TEST_ARG="make test-templates-dymola PACKAGE=\"Buildings.Templates.ZoneEquipment\""
 
 before_install:
   - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
@@ -156,12 +164,11 @@ before_install:
 install:
   - git lfs pull
   - pip3 install --upgrade pip wheel
-  - pip3 install --only-binary=numpy,scipy,matplotlib numpy==1.21.4 scipy==1.7.3 matplotlib==3.5.1
   - pip3 install git+https://github.com/lbl-srg/${BUILDINGSPY_VERSION}
   - if [[ "$TEST_ARG" == *test-energyplus* ]] || [[ "$TEST_ARG" == *test-templates* ]]; then
       export ENERGYPLUS_9_6_0=${ENERGYPLUS_9_6_0};
       export ENERGYPLUS_23_1_0=${ENERGYPLUS_23_1_0};
-      pip3 install pandas==1.3.5;
+      pip3 install pandas==2.3.2;
     fi;
   - if [[ "$TEST_ARG" == *EnergyPlus_24_2_0* ]] || [[ "$TEST_ARG" == *Buildings.{Obsolete* ]] || [[ "$TEST_ARG" == *Buildings.DHC.{ETS,Loads,Networks,Plants}* ]] || [[ "$TEST_ARG" == *spawn* ]]; then
       echo "Installing Spawn binaries";

Buildings/.copiedFiles.txt

@@ -4,6 +4,7 @@ Buildings/Airflow/Multizone/BaseClasses/Door.mo
 Buildings/Airflow/Multizone/BaseClasses/DoorDiscretized.mo
 Buildings/Airflow/Multizone/BaseClasses/ErrorControl.mo
 Buildings/Airflow/Multizone/BaseClasses/Examples/PowerLaw.mo
+Buildings/Airflow/Multizone/BaseClasses/Examples/PowerLaw05.mo
 Buildings/Airflow/Multizone/BaseClasses/Examples/PowerLawFixedM.mo
 Buildings/Airflow/Multizone/BaseClasses/Examples/WindPressureLowRise.mo
 Buildings/Airflow/Multizone/BaseClasses/Examples/WindPressureProfile.mo
@@ -17,6 +18,7 @@ Buildings/Airflow/Multizone/BaseClasses/ZonalFlow.mo
 Buildings/Airflow/Multizone/BaseClasses/package.mo
 Buildings/Airflow/Multizone/BaseClasses/package.order
 Buildings/Airflow/Multizone/BaseClasses/powerLaw.mo
+Buildings/Airflow/Multizone/BaseClasses/powerLaw05.mo
 Buildings/Airflow/Multizone/BaseClasses/powerLawFixedM.mo
 Buildings/Airflow/Multizone/BaseClasses/windPressureLowRise.mo
 Buildings/Airflow/Multizone/BaseClasses/windPressureProfile.mo
@@ -2912,6 +2914,7 @@ Buildings/Resources/Images/Utilities/Math/int.pdf
 Buildings/Resources/Images/Utilities/Math/int.png
 Buildings/Resources/Python-Sources/MakeORCFluidRecord.py
 Buildings/Resources/Scripts/Dymola/Airflow/Multizone/BaseClasses/Examples/PowerLaw.mos
+Buildings/Resources/Scripts/Dymola/Airflow/Multizone/BaseClasses/Examples/PowerLaw05.mos
 Buildings/Resources/Scripts/Dymola/Airflow/Multizone/BaseClasses/Examples/PowerLawFixedM.mos
 Buildings/Resources/Scripts/Dymola/Airflow/Multizone/BaseClasses/Examples/WindPressureLowRise.mos
 Buildings/Resources/Scripts/Dymola/Airflow/Multizone/BaseClasses/Examples/WindPressureProfile.mos

Buildings/Airflow/Multizone/BaseClasses/Door.mo

@@ -43,6 +43,9 @@ protected
   constant Real conTP = Buildings.Media.Air.dStp*Modelica.Media.IdealGases.Common.SingleGasesData.Air.R_s
     "Conversion factor for converting temperature difference to pressure difference";
 
+  final parameter Real sqrt_dp_turbulent(min=0) = sqrt(dp_turbulent)
+    "Square root of pressure difference where laminar and turbulent flow relation coincide";
+
   parameter Medium.ThermodynamicState sta_default=Medium.setState_pTX(
       T=Medium.T_default,
       p=Medium.p_default,
@@ -118,6 +121,13 @@ This is a partial model for the bi-directional air flow through a door.
 revisions="<html>
 <ul>
 <li>
+September 19, 2025, by Michael Wetter:<br/>
+Introduced protected parameter <code>sqrt_dp_turbulent</code>,
+which is needed to improve computing efficiency if flow exponent is <i>0.5</i>.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/2043\">IBPSA, #2043</a>.
+</li>
+<li>
 October 6, 2020, by Michael Wetter:<br/>
 First implementation for
 <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1353\">#1353</a>.

Buildings/Airflow/Multizone/BaseClasses/DoorDiscretized.mo

@@ -28,6 +28,9 @@ protected
   parameter Modelica.Units.SI.Density rho_default=Medium.density(sta_default)
     "Density, used to compute fluid volume";
 
+  final parameter Real sqrt_dp_turbulent(min=0) = sqrt(dp_turbulent)
+    "Square root of pressure difference where laminar and turbulent flow relation coincide";
+
   input Real hAg[nCom](each unit="m2/s2")=
     {Modelica.Constants.g_n*(hA - (i - 0.5)*dh) for i in 1:nCom}
     "Product g*h_i for each compartment";
@@ -118,6 +121,13 @@ using the model for a door that can be open or closed.
 revisions="<html>
 <ul>
 <li>
+September 19, 2025, by Michael Wetter:<br/>
+Introduced protected parameter <code>sqrt_dp_turbulent</code>,
+which is needed to improve computing efficiency if flow exponent is <i>0.5</i>.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/2043\">IBPSA, #2043</a>.
+</li>
+<li>
 October 29, 2024, by Klaas De Jonge:<br/>
 Unprotected <code>dh</code> and changed prefixes of <code>dh</code>,<code>hAg</code> and <code>hBg</code> to <code>input</code>.<br/>
 This is for <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1935\">#1935</a>.

Buildings/Airflow/Multizone/BaseClasses/Examples/PowerLaw05.mo

@@ -0,0 +1,73 @@
+within Buildings.Airflow.Multizone.BaseClasses.Examples;
+model PowerLaw05
+  "Test model for power law function with constant exponent of 0.5"
+  extends Modelica.Icons.Example;
+  parameter Real C = 2/10^m "Flow coefficient, C = V_flow/ dp^m";
+
+  constant Real m(min=0.5, max=1) = 0.5
+    "Flow exponent, m=0.5 for turbulent, m=1 for laminar";
+  parameter Modelica.Units.SI.PressureDifference dp_turbulent(min=0) = 5
+    "Pressure difference where regularization starts";
+  final parameter Real sqrt_dp_turbulent(min=0) = sqrt(dp_turbulent)
+    "Square root of pressure difference where regularization starts";
+
+  Modelica.Units.SI.PressureDifference dp "Pressure difference";
+  Modelica.Units.SI.VolumeFlowRate V_flow
+    "Volume flow rate computed with model powerLaw";
+  Modelica.Units.SI.VolumeFlowRate VFixed_flow
+    "Volume flow rate computed with model powerLawFixed";
+
+  constant Real gamma(min=1) = 1.5
+    "Normalized flow rate where dphi(0)/dpi intersects phi(1)";
+  constant Real a = gamma
+    "Polynomial coefficient for regularized implementation of flow resistance";
+  constant Real b = 1/8*m^2 - 3*gamma - 3/2*m + 35.0/8
+    "Polynomial coefficient for regularized implementation of flow resistance";
+  constant Real c = -1/4*m^2 + 3*gamma + 5/2*m - 21.0/4
+    "Polynomial coefficient for regularized implementation of flow resistance";
+  constant Real d = 1/8*m^2 - gamma - m + 15.0/8
+    "Polynomial coefficient for regularized implementation of flow resistance";
+
+equation
+  dp = 10*(-1+2*time);
+  V_flow = Buildings.Airflow.Multizone.BaseClasses.powerLaw(
+    dp=dp,
+    C=C,
+    m=m,
+    dp_turbulent=dp_turbulent);
+  VFixed_flow = Buildings.Airflow.Multizone.BaseClasses.powerLaw05(
+    C=C,
+    dp=dp,
+    a=a,
+    b=b,
+    c=c,
+    d=d,
+    dp_turbulent=dp_turbulent,
+    sqrt_dp_turbulent=sqrt_dp_turbulent);
+  assert(abs(V_flow-VFixed_flow) < 1E-10, "Error: The two implementations of the power law model need to give identical results");
+  annotation (
+experiment(Tolerance=1e-6, StopTime=1.0),
+  __Dymola_Commands(file="modelica://Buildings/Resources/Scripts/Dymola/Airflow/Multizone/BaseClasses/Examples/PowerLaw05.mos"
+        "Simulate and plot"), Documentation(info="<html>
+<p>
+This examples demonstrates the
+<a href=\"modelica://Buildings.Airflow.Multizone.BaseClasses.powerLaw\">
+Buildings.Airflow.Multizone.BaseClasses.powerLaw</a>
+and
+<a href=\"modelica://Buildings.Airflow.Multizone.BaseClasses.powerLaw05\">
+Buildings.Airflow.Multizone.BaseClasses.powerLaw05</a>
+functions.
+They need to return the same function value.
+This is verified by an <code>assert</code> statement.
+</p>
+</html>", revisions="<html>
+<ul>
+<li>
+September 19. 2025, by Michael Wetter:<br/>
+First implementation.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/2043\">IBPSA, #2043</a>.
+</li>
+</ul>
+</html>"));
+end PowerLaw05;

Buildings/Airflow/Multizone/BaseClasses/Examples/package.order

@@ -1,4 +1,5 @@
 PowerLaw
+PowerLaw05
 PowerLawFixedM
 WindPressureLowRise
 WindPressureProfile

Buildings/Airflow/Multizone/BaseClasses/PartialOneWayFlowElement.mo

@@ -31,13 +31,15 @@ protected
     Medium.dynamicViscosity(sta_default)
     "Dynamic viscosity at the medium default properties";
 
+  final parameter Real sqrt_dp_turbulent(min=0) = sqrt(dp_turbulent)
+    "Square root of pressure difference where laminar and turbulent flow relation coincide";
+
   Medium.ThermodynamicState sta "State of the medium in the component";
   Modelica.Units.SI.DynamicViscosity dynVis "Dynamic viscosity";
-  Real mExc(quantity="Mass", final unit="kg")
+  Modelica.Units.SI.Mass mExc(start=0, fixed=true, unbounded=true)
     "Air mass exchanged (for purpose of error control only)";
 
 initial equation
-  mExc=0;
   assert(homotopyInitialization, "In " + getInstanceName() +
     ": The constant homotopyInitialization has been modified from its default value. This constant will be removed in future releases.",
     level = AssertionLevel.warning);
@@ -110,6 +112,25 @@ not in the equation section since this model sets both
 revisions="<html>
 <ul>
 <li>
+September 22, 2025, by Michael Wetter:<br/>
+Set <code>unbounded=true</code> for <code>mExc_flow</code>.
+This is to have the same implementation as in
+<a href=\"modelica://Buildings.Airflow.Multizone.BaseClasses.TwoWayFlowElement\">
+Buildings.Airflow.Multizone.BaseClasses.TwoWayFlowElement</a>
+where this change was done to avoid spikes in <code>port_a.m_flow</code> in
+<a href=\"modelica://Buildings.Airflow.Multizone.Examples.OneOpenDoor\">
+Buildings.Airflow.Multizone.Examples.OneOpenDoor</a>.<br/>
+This is for
+<a href=\"https://github.com/lbl-srg/modelica-buildings/issues/4360\">Buildings, #4360</a>.
+</li>
+<li>
+September 19, 2025, by Michael Wetter:<br/>
+Introduced protected parameter <code>sqrt_dp_turbulent</code>,
+which is needed to improve computing efficiency if flow exponent is <i>0.5</i>.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/2043\">IBPSA, #2043</a>.
+</li>
+<li>
 February 2, 2022, by Michael Wetter:<br/>
 Revised implementation.<br/>
 This is for

Buildings/Airflow/Multizone/BaseClasses/TwoWayFlowElement.mo

@@ -41,9 +41,9 @@ protected
   Modelica.Units.SI.VolumeFlowRate VZer_flow(fixed=false)
     "Minimum net volume flow rate to prevent zero flow";
 
-  Modelica.Units.SI.Mass mExcAB(start=0, fixed=true)
+  Modelica.Units.SI.Mass mExcAB(start=0, fixed=true, unbounded=true)
     "Air mass exchanged (for purpose of error control only)";
-  Modelica.Units.SI.Mass mExcBA(start=0, fixed=true)
+  Modelica.Units.SI.Mass mExcBA(start=0, fixed=true, unbounded=true)
     "Air mass exchanged (for purpose of error control only)";
 
   Medium.MassFraction Xi_a1_inflow[Medium1.nXi]
@@ -55,8 +55,8 @@ equation
   // gives higher robustness. The reason may be that for bi-directional flow,
   // (VAB_flow - VBA_flow) may be close to zero.
   if forceErrorControlOnFlow then
-    der(mExcAB) = mAB_flow;
-    der(mExcBA) = mBA_flow;
+    der(mExcAB) = port_a1.m_flow;
+    der(mExcBA) = port_a2.m_flow;
   else
     der(mExcAB) = 0;
     der(mExcBA) = 0;
@@ -82,14 +82,14 @@ equation
 
   VZer_flow = vZer*A;
 
-  mAB_flow = rho_a1_inflow*VAB_flow;
-  mBA_flow = rho_a2_inflow*VBA_flow;
+  mAB_flow = port_a1.m_flow;
+  mBA_flow = port_a2.m_flow;
   // Average velocity (using the whole orifice area)
   vAB = VAB_flow/A;
   vBA = VBA_flow/A;
 
-  port_a1.m_flow = mAB_flow;
-  port_a2.m_flow = mBA_flow;
+  port_a1.m_flow = rho_a1_inflow*VAB_flow;
+  port_a2.m_flow = rho_a2_inflow*VBA_flow;
 
   // Energy balance (no storage, no heat loss/gain)
   port_a1.h_outflow = inStream(port_b1.h_outflow);
@@ -135,6 +135,26 @@ for doors that can be open or closed as a function of an input signal.
 revisions="<html>
 <ul>
 <li>
+September 22, 2025, by Michael Wetter:<br/>
+Set <code>unbounded=true</code> for <code>mExcAB_flow</code> and <code>mExcBA_flow</code>
+to avoid spikes in <code>port_a.m_flow</code> in
+<a href=\"modelica://Buildings.Airflow.Multizone.Examples.OneOpenDoor\">
+Buildings.Airflow.Multizone.Examples.OneOpenDoor</a>.<br/>
+This is for
+<a href=\"https://github.com/lbl-srg/modelica-buildings/issues/4360\">Buildings, #4360</a>.
+</li>
+<li>
+September 19, 2025, by Michael Wetter:<br/>
+Refactored implementation of underlying function that computes the flow rate
+to allow function to be inlined.
+This leads to a 20% faster simulation of
+<a href=\"modelica://Buildings.Airflow.Multizone.Examples.OneOpenDoor\">
+Buildings.Airflow.Multizone.Examples.OneOpenDoor</a> compared to the previous
+implementation.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/2043\">IBPSA, #2043</a>.
+</li>
+<li>
 May 12, 2020, by Michael Wetter:<br/>
 Changed assignment of <code>m1_flow_small</code> and
 <code>m2_flow_small</code> to <code>final</code>.

Buildings/Airflow/Multizone/BaseClasses/package.order

@@ -7,6 +7,7 @@ TwoWayFlowElement
 TwoWayFlowElementBuoyancy
 ZonalFlow
 powerLaw
+powerLaw05
 powerLawFixedM
 windPressureLowRise
 windPressureProfile