Added missing causality (#3715)

This merges IBPSA 1853
lbl-srg · Mar 21, 2024 · 75455c3 · 75455c3
1 parent 35bec49
commit 75455c3
Show file tree

Hide file tree

Showing 7 changed files with 83 additions and 50 deletions.
diff --git a/Buildings/Fluid/FMI/Adaptors/Inlet.mo b/Buildings/Fluid/FMI/Adaptors/Inlet.mo
@@ -35,14 +35,14 @@ model Inlet "Adaptor for connecting a fluid inlet to the FMI interface"
         rotation=270,
         origin={0,-110})));
 protected
-  Buildings.Fluid.FMI.Interfaces.FluidProperties bacPro_internal(
+  input Buildings.Fluid.FMI.Interfaces.FluidProperties bacPro_internal(
     redeclare final package Medium = Medium)
     "Internal connector for fluid properties for back flow";
   Buildings.Fluid.FMI.Interfaces.PressureOutput p_in_internal
     "Internal connector for pressure";
-  Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_in_internal
+  output Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_in_internal
     "Internal connector for mass fraction of forward flow properties";
-  Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_out_internal
+  output Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_out_internal
     "Internal connector for mass fraction of backward flow properties";
 initial equation
    assert(Medium.nXi < 2,
@@ -170,6 +170,11 @@ for how to use this model.
 </html>", revisions="<html>
 <ul>
 <li>
+March 18, 2024, by Michael Wetter:<br/>
+Added causality.<br/>
+See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1853\">IBPSA, #1853</a>.
+</li>
+<li>
 January 18, 2019, by Jianjun Hu:<br/>
 Limited the media choice to moist air and water.
 See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1050\">#1050</a>.

diff --git a/Buildings/Fluid/FMI/Adaptors/Outlet.mo b/Buildings/Fluid/FMI/Adaptors/Outlet.mo
@@ -36,15 +36,15 @@ model Outlet "Adaptor for connecting a fluid outlet to the FMI interface"
         rotation=90,
         origin={0,-120})));
 protected
-  Buildings.Fluid.FMI.Interfaces.FluidProperties bacPro_internal(
+  output Buildings.Fluid.FMI.Interfaces.FluidProperties bacPro_internal(
     redeclare final package Medium = Medium)
     "Internal connector for fluid properties for back flow";
   Buildings.Fluid.FMI.Interfaces.PressureOutput p_in_internal
     "Internal connector for pressure";
 
-  Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_in_internal
+  input Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_in_internal
     "Internal connector for mass fraction of forward flow properties";
-  Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_out_internal
+  output Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_out_internal
     "Internal connector for mass fraction of backward flow properties";
 initial equation
    assert(Medium.nXi < 2,
@@ -153,6 +153,11 @@ for how to use this model.
 </html>", revisions="<html>
 <ul>
 <li>
+March 18, 2024, by Michael Wetter:<br/>
+Added causality.<br/>
+See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1853\">IBPSA, #1853</a>.
+</li>
+<li>
 June 29, 2023, by Michael Wetter:<br/>
 Corrected dimension of <code>X</code> in function call.<br/>
 See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1768\">#1768</a>.

diff --git a/Buildings/Fluid/FMI/FlowSplitter_u.mo b/Buildings/Fluid/FMI/FlowSplitter_u.mo
@@ -44,10 +44,10 @@ protected
   final parameter Modelica.Units.SI.MassFlowRate mAve_flow_nominal=sum(
       m_flow_nominal)/nout "Average nominal mass flow rate";
 protected
-  Buildings.Fluid.FMI.Interfaces.FluidProperties bacPro_internal(
+  input Buildings.Fluid.FMI.Interfaces.FluidProperties bacPro_internal(
     redeclare final package Medium = Medium)
     "Internal connector for fluid properties for back flow";
-  Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_out_internal = 0
+  output Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_out_internal = 0
     "Internal connector for mass fraction of backward flow properties";
 
 initial equation
@@ -145,6 +145,11 @@ the model stops with an error.
 </html>", revisions="<html>
 <ul>
 <li>
+March 18, 2024, by Michael Wetter:<br/>
+Added causality.<br/>
+See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1853\">IBPSA, #1853</a>.
+</li>
+<li>
 January 18, 2019, by Jianjun Hu:<br/>
 Limited the media choice.
 See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1050\">#1050</a>.

diff --git a/Buildings/Fluid/FMI/Sink_T.mo b/Buildings/Fluid/FMI/Sink_T.mo
@@ -46,7 +46,7 @@ model Sink_T
         rotation=180,
         origin={-120,-80})));
 protected
-  Buildings.Fluid.FMI.Interfaces.FluidProperties bacPro_internal(
+  input Buildings.Fluid.FMI.Interfaces.FluidProperties bacPro_internal(
     redeclare final package Medium = Medium)
     "Internal connector for fluid properties for back flow";
   Buildings.Fluid.FMI.Interfaces.PressureOutput p_in_internal
@@ -115,6 +115,11 @@ may be needed to iteratively solve for the mass flow rate.
 </html>", revisions="<html>
 <ul>
 <li>
+March 18, 2024, by Michael Wetter:<br/>
+Added causality.<br/>
+See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1853\">IBPSA, #1853</a>.
+</li>
+<li>
 January 18, 2019, by Jianjun Hu:<br/>
 Limited the media choice to moist air and water.
 See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1050\">#1050</a>.

diff --git a/Buildings/Fluid/FMI/Source_T.mo b/Buildings/Fluid/FMI/Source_T.mo
@@ -47,7 +47,7 @@ model Source_T
 protected
   Buildings.Fluid.FMI.Interfaces.PressureOutput p_in_internal
     "Internal connector for pressure";
-  Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_in_internal
+  input Buildings.Fluid.FMI.Interfaces.MassFractionConnector X_w_in_internal
     "Internal connector for mass fraction of forward flow properties";
 initial equation
    assert(Medium.nXi < 2,
@@ -102,6 +102,11 @@ and the mass flow rate of the system.
 </html>", revisions="<html>
 <ul>
 <li>
+March 18, 2024, by Michael Wetter:<br/>
+Added causality.<br/>
+See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1853\">IBPSA, #1853</a>.
+</li>
+<li>
 January 18, 2019, by Jianjun Hu:<br/>
 Limited the media choice to moist air only.
 See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1050\">#1050</a>.

diff --git a/...renceResults/Dymola/Buildings_Fluid_FMI_ExportContainers_Examples_FMUs_FlowSplitter_u.txt b/...renceResults/Dymola/Buildings_Fluid_FMI_ExportContainers_Examples_FMUs_FlowSplitter_u.txt
@@ -1,63 +1,65 @@
-last-generated=2016-12-22
+last-generated=2024-03-20
 statistics-fmu-dependencies=
 {
-  "Outputs": {
+  "Derivatives": {},
+  "InitialUnknowns": {
+    "X_w_out_internal": [],
+    "inlet.backward.T": [],
+    "inlet.backward.X_w": [],
+    "outlet[1].forward.T": [
+      "inlet.forward.T"
+    ],
+    "outlet[1].forward.X_w": [
+      "inlet.forward.X_w"
+    ],
     "outlet[1].m_flow": [
+      "m_flow_nominal[1]",
       "u[1]"
-    ], 
+    ],
     "outlet[1].p": [
       "inlet.p"
-    ], 
+    ],
     "outlet[2].forward.T": [
       "inlet.forward.T"
-    ], 
-    "inlet.backward.T": [], 
-    "outlet[1].forward.T": [
-      "inlet.forward.T"
-    ], 
+    ],
+    "outlet[2].forward.X_w": [
+      "inlet.forward.X_w"
+    ],
     "outlet[2].m_flow": [
+      "m_flow_nominal[2]",
       "u[2]"
-    ], 
-    "inlet.backward.X_w": [], 
-    "outlet[1].forward.X_w": [
-      "inlet.forward.X_w"
-    ], 
+    ],
     "outlet[2].p": [
       "inlet.p"
-    ], 
-    "outlet[2].forward.X_w": [
-      "inlet.forward.X_w"
     ]
-  }, 
-  "InitialUnknowns": {
+  },
+  "Outputs": {
+    "X_w_out_internal": [],
+    "inlet.backward.T": [],
+    "inlet.backward.X_w": [],
+    "outlet[1].forward.T": [
+      "inlet.forward.T"
+    ],
+    "outlet[1].forward.X_w": [
+      "inlet.forward.X_w"
+    ],
     "outlet[1].m_flow": [
-      "m_flow_nominal[1]", 
       "u[1]"
-    ], 
+    ],
     "outlet[1].p": [
       "inlet.p"
-    ], 
+    ],
     "outlet[2].forward.T": [
       "inlet.forward.T"
-    ], 
-    "inlet.backward.T": [], 
-    "outlet[1].forward.T": [
-      "inlet.forward.T"
-    ], 
+    ],
+    "outlet[2].forward.X_w": [
+      "inlet.forward.X_w"
+    ],
     "outlet[2].m_flow": [
-      "m_flow_nominal[2]", 
       "u[2]"
-    ], 
-    "inlet.backward.X_w": [], 
-    "outlet[1].forward.X_w": [
-      "inlet.forward.X_w"
-    ], 
+    ],
     "outlet[2].p": [
       "inlet.p"
-    ], 
-    "outlet[2].forward.X_w": [
-      "inlet.forward.X_w"
     ]
-  }, 
-  "Derivatives": {}
+  }
 }
diff --git a/Buildings/package.mo b/Buildings/package.mo
@@ -263,11 +263,17 @@ have been <b style=\"color:blue\">improved</b> in a
     </td>
     </tr>
     <tr><td valign=\"top\">Buildings.Fluid.FMI.AirToOutlet<br/>
-                           Buildings.Fluid.FMI.InletToAir
+                           Buildings.Fluid.FMI.InletToAir<br/>
+                           Buildings.Fluid.FMI.FlowSplitter_u<br/>
+                           Buildings.Fluid.FMI.Sink_T<br/>
+                           Buildings.Fluid.FMI.Source_T<br/>
+                           Buildings.Fluid.FMI.Adaptors.Inlet<br/>
+                           Buildings.Fluid.FMI.Adaptors.Outlet
     </td>
     <td valign=\"top\">Added missing causality which is required for language compliance and for
                        Wolfram System Modeler.<br/>
-                       This is for <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1829\">IBPSA, #1829</a>.
+                       This is for <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1829\">IBPSA, #1829</a> and
+		       <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1853\">IBPSA, #1853</a>.
     </td>
     <tr><td colspan=\"2\"><b>Buildings.Fluid.Sensors.Examples</b>
     </td>