From 4e278d256b514479bbf923e68720503748c37276 Mon Sep 17 00:00:00 2001
From: David Blum <dhblum@lbl.gov>
Date: Wed, 30 Nov 2022 18:01:45 -0500
Subject: [PATCH] Issue2510 main91x pipe autosize dh start (#3173)

* Copy changes from PR3163

* Add Documentation annotation to new Validation package

Co-authored-by: Michael Wetter <mwetter@lbl.gov>
---
 .../Combined/BaseClasses/PipeAutosize.mo      |  9 +-
 .../Combined/BaseClasses/Validation/Pipe.mo   | 96 +++++++++++++++++++
 .../BaseClasses/Validation/package.mo         | 12 +++
 .../BaseClasses/Validation/package.order      |  1 +
 .../Networks/Combined/BaseClasses/package.mo  |  1 +
 .../Combined/BaseClasses/package.order        |  1 +
 ...s_Combined_BaseClasses_Validation_Pipe.txt | 21 ++++
 .../Resources/Scripts/BuildingsPy/conf.yml    |  4 +
 .../Combined/BaseClasses/Validation/Pipe.mos  | 12 +++
 ...s.Combined.BaseClasses.Validation.Pipe.mos | 11 +++
 Buildings/package.mo                          | 19 ++++
 11 files changed, 185 insertions(+), 2 deletions(-)
 create mode 100644 Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/Pipe.mo
 create mode 100644 Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/package.mo
 create mode 100644 Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/package.order
 create mode 100644 Buildings/Resources/ReferenceResults/Dymola/Buildings_Experimental_DHC_Networks_Combined_BaseClasses_Validation_Pipe.txt
 create mode 100644 Buildings/Resources/Scripts/Dymola/Experimental/DHC/Networks/Combined/BaseClasses/Validation/Pipe.mos
 create mode 100644 Buildings/Resources/Scripts/OpenModelica/compareVars/Buildings.Experimental.DHC.Networks.Combined.BaseClasses.Validation.Pipe.mos
diff --git a/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/PipeAutosize.mo b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/PipeAutosize.mo
index 4900c00c71c..b5cec59431c 100644
--- a/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/PipeAutosize.mo
+++ b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/PipeAutosize.mo
@@ -6,7 +6,7 @@ model PipeAutosize "Pipe model parameterized with pressure drop per pipe length"
 
   parameter Modelica.Units.SI.Length dh(
     fixed=false,
-    start=0.05,
+    start=0.01,
     min=0.01) "Hydraulic diameter (assuming a round cross section area)";
 
   parameter Real dp_length_nominal(final unit="Pa/m") = 250
@@ -29,7 +29,7 @@ model PipeAutosize "Pipe model parameterized with pressure drop per pipe length"
     "Factor to take into account resistance of bends etc., fac=dp_nominal/dpStraightPipe_nominal";
 
   final parameter Modelica.Units.SI.PressureDifference dpStraightPipe_nominal(
-      displayUnit="Pa") =
+      displayUnit="Pa")=
     Modelica.Fluid.Pipes.BaseClasses.WallFriction.Detailed.pressureLoss_m_flow(
     m_flow=m_flow_nominal,
     rho_a=rho_default,
@@ -100,6 +100,11 @@ depends on <code>dp_nominal</code> and must be evaluated at compile time.
 </html>", revisions="<html>
 <ul>
 <li>
+November 18, 2022, by David Blum:<br/>
+Start attribute for parameter dh changed to 0.01.<br/>
+This is for <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/2510\">issue 2510</a>.
+</li>
+<li>
 February 23, 2021, by Antoine Gautier:<br/>
 First implementation.
 </li>
diff --git a/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/Pipe.mo b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/Pipe.mo
new file mode 100644
index 00000000000..5b2f78c58f9
--- /dev/null
+++ b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/Pipe.mo
@@ -0,0 +1,96 @@
+within Buildings.Experimental.DHC.Networks.Combined.BaseClasses.Validation;
+model Pipe "Validates the PipeAutosize model initialization"
+  extends Modelica.Icons.Example;
+  package Medium = Buildings.Media.Water "Medium model";
+  parameter Real dp1_length_nominal(final unit="Pa/m")=1000 "Pressure drop per unit length 1";
+  parameter Real dp2_length_nominal(final unit="Pa/m")=0.1 "Pressure drop per unit length 2";
+  parameter Modelica.Units.SI.MassFlowRate m1_flow_nominal=0.01 "Nominal mass flow rate 1";
+  parameter Modelica.Units.SI.MassFlowRate m2_flow_nominal=1000 "Nominal mass flow rate 2";
+  Buildings.Fluid.Sources.Boundary_pT sin(redeclare final package Medium =
+        Medium, nPorts=4) "Sink for water flow" annotation (Placement(
+        transformation(
+        extent={{-10,-10},{10,10}},
+        rotation=180,
+        origin={50,0})));
+  Buildings.Experimental.DHC.Networks.Combined.BaseClasses.PipeStandard pipSta1(
+    redeclare final package Medium = Medium,
+    m_flow_nominal=m1_flow_nominal,
+    dh=0.00548,
+    length=100) "Pipe 1 with standard hydraulic diameter"
+    annotation (Placement(transformation(extent={{-10,-30},{10,-10}})));
+  Buildings.Fluid.Sources.MassFlowSource_T souSta1(
+    redeclare final package Medium = Medium,
+    m_flow=m1_flow_nominal,
+    nPorts=1) "Source of water flow for standard pipe 1"
+    annotation (Placement(transformation(extent={{-60,-30},{-40,-10}})));
+  Buildings.Fluid.Sources.MassFlowSource_T souAut2(
+    redeclare final package Medium = Medium,
+    m_flow=m2_flow_nominal,
+    nPorts=1) "Source of water flow for autosized pipe 2"
+    annotation (Placement(transformation(extent={{-60,10},{-40,30}})));
+  Buildings.Experimental.DHC.Networks.Combined.BaseClasses.PipeAutosize pipAut2(
+    redeclare final package Medium = Medium,
+    m_flow_nominal=m2_flow_nominal,
+    dp_length_nominal=dp2_length_nominal,
+    length=100) "Pipe 2 with autosized hydraulic diameter"
+    annotation (Placement(transformation(extent={{-10,10},{10,30}})));
+  Fluid.Sources.MassFlowSource_T souAut1(
+    redeclare final package Medium = Medium,
+    m_flow=m1_flow_nominal,
+    nPorts=1) "Source of water flow for autosized pipe 1"
+    annotation (Placement(transformation(extent={{-60,50},{-40,70}})));
+  PipeAutosize pipAut1(
+    redeclare final package Medium = Medium,
+    m_flow_nominal=m1_flow_nominal,
+    dp_length_nominal=dp1_length_nominal,
+    length=100) "Pipe 1 with autosized hydraulic diameter"
+    annotation (Placement(transformation(extent={{-10,50},{10,70}})));
+  PipeStandard pipSta2(
+    redeclare final package Medium = Medium,
+    m_flow_nominal=m2_flow_nominal,
+    dh=2.943,
+    length=100) "Pipe 2 with standard hydraulic diameter"
+    annotation (Placement(transformation(extent={{-10,-70},{10,-50}})));
+  Fluid.Sources.MassFlowSource_T souSta2(
+    redeclare final package Medium = Medium,
+    m_flow=m2_flow_nominal,
+    nPorts=1) "Source of water flow for standard pipe 2"
+    annotation (Placement(transformation(extent={{-60,-70},{-40,-50}})));
+equation
+  connect(souSta1.ports[1], pipSta1.port_a)
+    annotation (Line(points={{-40,-20},{-10,-20}}, color={0,127,255}));
+  connect(souAut2.ports[1], pipAut2.port_a)
+    annotation (Line(points={{-40,20},{-10,20}}, color={0,127,255}));
+  connect(souAut1.ports[1], pipAut1.port_a)
+    annotation (Line(points={{-40,60},{-10,60}}, color={0,127,255}));
+  connect(souSta2.ports[1], pipSta2.port_a)
+    annotation (Line(points={{-40,-60},{-10,-60}}, color={0,127,255}));
+  connect(pipAut1.port_b, sin.ports[1])
+    annotation (Line(points={{10,60},{40,60},{40,1.5}}, color={0,127,255}));
+  connect(pipAut2.port_b, sin.ports[2]) annotation (Line(points={{10,20},{20,20},
+          {20,0.5},{40,0.5}}, color={0,127,255}));
+  connect(pipSta1.port_b, sin.ports[3]) annotation (Line(points={{10,-20},{20,-20},
+          {20,-0.5},{40,-0.5}}, color={0,127,255}));
+  connect(pipSta2.port_b, sin.ports[4])
+    annotation (Line(points={{10,-60},{40,-60},{40,-1.5}}, color={0,127,255}));
+  annotation (Documentation(info="<html>
+<p>
+Validation model for <a href=\"modelica://Buildings.Experimental.DHC.Networks.Combined.BaseClasses.PipeAutosize\">
+Buildings.Experimental.DHC.Networks.Combined.BaseClasses.PipeAutosize</a>
+for range of flow rates and pressure drops per unit length.
+</p>
+</html>", revisions="<html>
+<ul>
+<li>
+November 18, 2022 by David Blum:<br/>
+First implementation.<br/>
+This is for <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/2510\">issue 2510</a>.
+</li>
+</ul>
+</html>"),
+__Dymola_Commands(file="modelica://Buildings/Resources/Scripts/Dymola/Experimental/DHC/Networks/Combined/BaseClasses/Validation/Pipe.mos"
+        "Simulate and plot"),
+experiment(
+      StopTime=1,
+      Tolerance=1e-06));
+end Pipe;
diff --git a/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/package.mo b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/package.mo
new file mode 100644
index 00000000000..47e01d22145
--- /dev/null
+++ b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/package.mo
@@ -0,0 +1,12 @@
+within Buildings.Experimental.DHC.Networks.Combined.BaseClasses;
+package Validation "Validation models for BaseClasses"
+  extends Modelica.Icons.ExamplesPackage;
+
+annotation (preferredView="info", Documentation(info="<html>
+<p>
+This package contains validation cases for the BaseClasses found in
+<a href=\"modelica://Buildings.Experimental.DHC.Networks.Combined.BaseClasses\">
+Buildings.Experimental.DHC.Networks.Combined.BaseClasses</a>.
+</p>
+</html>"));
+end Validation;
diff --git a/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/package.order b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/package.order
new file mode 100644
index 00000000000..106c2b72228
--- /dev/null
+++ b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/Validation/package.order
@@ -0,0 +1 @@
+Pipe
diff --git a/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/package.mo b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/package.mo
index 1df69ab0b5f..9b103322109 100644
--- a/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/package.mo
+++ b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/package.mo
@@ -1,6 +1,7 @@
 within Buildings.Experimental.DHC.Networks.Combined;
 package BaseClasses "Package with base classes for Buildings.Experimental.DHC.Networks.Combined"
   extends Modelica.Icons.BasesPackage;
+
 annotation (preferredView="info", Documentation(info="<html>
 <p>
 This package contains base classes that are used to construct the models in
diff --git a/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/package.order b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/package.order
index ed2b1e3cef0..1342acba5e5 100644
--- a/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/package.order
+++ b/Buildings/Experimental/DHC/Networks/Combined/BaseClasses/package.order
@@ -4,3 +4,4 @@ ConnectionSeriesAutosize
 ConnectionSeriesStandard
 PipeAutosize
 PipeStandard
+Validation
diff --git a/Buildings/Resources/ReferenceResults/Dymola/Buildings_Experimental_DHC_Networks_Combined_BaseClasses_Validation_Pipe.txt b/Buildings/Resources/ReferenceResults/Dymola/Buildings_Experimental_DHC_Networks_Combined_BaseClasses_Validation_Pipe.txt
new file mode 100644
index 00000000000..6f3ed705dff
--- /dev/null
+++ b/Buildings/Resources/ReferenceResults/Dymola/Buildings_Experimental_DHC_Networks_Combined_BaseClasses_Validation_Pipe.txt
@@ -0,0 +1,21 @@
+last-generated=2022-11-18
+statistics-initialization=
+{
+  "nonlinear": "0, 1, 0, 1",
+  "numerical Jacobians": "0"
+}
+statistics-simulation=
+{
+  "linear": " ",
+  "nonlinear": " ",
+  "numerical Jacobians": "0"
+}
+time=[0e+00, 1e+00]
+pipSta1.dh=[5.47999981790781e-03, 5.47999981790781e-03]
+pipAut1.dh=[5.476676858961582e-03, 5.476676858961582e-03]
+pipSta2.dh=[2.943000078201294e+00, 2.943000078201294e+00]
+pipAut2.dh=[2.94313907623291e+00, 2.94313907623291e+00]
+pipSta1.dp=[1.053362734375e+05, 1.053362734375e+05]
+pipAut1.dp=[1.05657125e+05, 1.05657125e+05]
+pipSta2.dp=[1.000228691101074e+01, 1.000228691101074e+01]
+pipAut2.dp=[1e+01, 1e+01]
diff --git a/Buildings/Resources/Scripts/BuildingsPy/conf.yml b/Buildings/Resources/Scripts/BuildingsPy/conf.yml
index bc8c35c08d8..200e4be240c 100644
--- a/Buildings/Resources/Scripts/BuildingsPy/conf.yml
+++ b/Buildings/Resources/Scripts/BuildingsPy/conf.yml
@@ -140,6 +140,10 @@
   optimica:
     comment: The rootfinding function failed in an unrecoverable manner. At time 5959.741337. (Radau5ODE fails at 3540.029280) (but works locally)
     simulate: false
+- model_name: Buildings.Experimental.DHC.Networks.Combined.BaseClasses.Validation.Pipe
+  optimica:
+    comment: Could not solve initialization. Could not bracket the root. Iteration variable pipAut1.dh. Filed Modelon#2022112839000242
+    simulate: false
 - model_name: Buildings.Experimental.DHC.Plants.Cooling.Examples.ElectricChillerParallel
   openmodelica:
     comment: 'division by zero at time 0, (a=0) / (b=0), where divisor b expression is: 0.0'
diff --git a/Buildings/Resources/Scripts/Dymola/Experimental/DHC/Networks/Combined/BaseClasses/Validation/Pipe.mos b/Buildings/Resources/Scripts/Dymola/Experimental/DHC/Networks/Combined/BaseClasses/Validation/Pipe.mos
new file mode 100644
index 00000000000..ca316e104cc
--- /dev/null
+++ b/Buildings/Resources/Scripts/Dymola/Experimental/DHC/Networks/Combined/BaseClasses/Validation/Pipe.mos
@@ -0,0 +1,12 @@
+// Simulate
+simulateModel("Buildings.Experimental.DHC.Networks.Combined.BaseClasses.Validation.Pipe", 
+    stopTime=1, 
+    method="Cvode", 
+    tolerance=1e-06,
+    resultFile="Pipe");
+// Plot commands
+removePlots(false);
+createPlot(id=1, position={527, 3, 592, 648}, y={"pipSta1.dh", "pipAut1.dh"}, range={0.0, 1.0, 0.005476000000000001, 0.005482000000000001}, grid=true, subPlot=101, colors={{28,108,200}, {238,46,47}}, timeUnit="s", displayUnits={"m", "m"});
+createPlot(id=1, position={527, 3, 592, 648}, y={"pipSta2.dh", "pipAut2.dh"}, range={0.0, 1.0, 2.9429, 2.9432}, grid=true, subPlot=102, colors={{28,108,200}, {238,46,47}}, timeUnit="s", displayUnits={"m", "m"});
+createPlot(id=1, position={527, 3, 592, 648}, y={"pipSta1.dp", "pipAut1.dp"}, range={0.0, 1.0, 105200.0, 105800.0}, grid=true, subPlot=103, colors={{28,108,200}, {238,46,47}}, timeUnit="s", displayUnits={"Pa", "Pa"});
+createPlot(id=1, position={527, 3, 592, 648}, y={"pipSta2.dp", "pipAut2.dp"}, range={0.0, 1.0, 9.998, 10.004}, grid=true, subPlot=104, colors={{28,108,200}, {238,46,47}}, timeUnit="s", displayUnits={"Pa", "Pa"});
diff --git a/Buildings/Resources/Scripts/OpenModelica/compareVars/Buildings.Experimental.DHC.Networks.Combined.BaseClasses.Validation.Pipe.mos b/Buildings/Resources/Scripts/OpenModelica/compareVars/Buildings.Experimental.DHC.Networks.Combined.BaseClasses.Validation.Pipe.mos
new file mode 100644
index 00000000000..25d41fe5ce3
--- /dev/null
+++ b/Buildings/Resources/Scripts/OpenModelica/compareVars/Buildings.Experimental.DHC.Networks.Combined.BaseClasses.Validation.Pipe.mos
@@ -0,0 +1,11 @@
+compareVars :=
+  {
+    "pipSta1.dh",
+    "pipAut1.dh",
+    "pipSta2.dh",
+    "pipAut2.dh",
+    "pipSta1.dp",
+    "pipAut1.dp",
+    "pipSta2.dp",
+    "pipAut2.dp"
+  };
diff --git a/Buildings/package.mo b/Buildings/package.mo
index f08205314bc..2636d78f4f1 100644
--- a/Buildings/package.mo
+++ b/Buildings/package.mo
@@ -254,6 +254,16 @@ to <b style=\"color:blue\">existing</b> libraries:
                        <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/3125\">#3125</a>.
     </td>
   </tr>
+<tr><td colspan=\"2\"><b>Buildings.Experimental.DHC.Networks.Combined.BaseClasses</b>
+    </td>
+</tr>
+<tr><td valign=\"top\">Buildings.Experimental.DHC.Networks.Combined.BaseClasses.Validation.Pipe
+    </td>
+    <td valign=\"top\">Test for comparing <code>Buildings.Experimental.DHC.Networks.Combined.BaseClasses.PipeAutosize</code> <br/>
+                       initialization of <code>dh</code> to <code>Buildings.Experimental.DHC.Networks.Combined.BaseClasses.PipeStandard</code>.<br/>
+                       This is for <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/2510\">issue #2510</a>.
+    </td>
+</tr>
 </table>
 <!-- Backward compatible changes -->
 <p>
@@ -388,6 +398,15 @@ have been <b style=\"color:blue\">improved</b> in a
                        This is for <a href=\"https://github.com/ibpsa/modelica-ibpsa/pull/1640\">IBPSA, issue #1640</a>.
     </td>
 </tr>
+<tr><td colspan=\"2\"><b>Buildings.Experimental.DHC.Networks.Combined.BaseClasses</b>
+    </td>
+</tr>
+<tr><td valign=\"top\">Buildings.Experimental.DHC.Networks.Combined.BaseClasses.PipeAutosize
+    </td>
+    <td valign=\"top\">Start attribute for parameter <code>dh</code> changed to 0.01.<br/>
+                       This is for <a href=\"https://github.com/lbl-srg/modelica-buildings/issues/2510\">issue #2510</a>.
+    </td>
+</tr>
 </table>
 <!-- Non-backward compatible changes to existing components -->
 <p>
