From b27e9f7941e55dd1bca7dc588e00b6f46a46c32c Mon Sep 17 00:00:00 2001
From: Michael Wetter <mwetter@lbl.gov>
Date: Wed, 29 Nov 2023 08:26:25 -0500
Subject: [PATCH] Corrected wrong use of getInstanceName (#3585)

* Corrected wrong use of getInstanceName

This integrates IBPSA, issue 1814. The use of this function is not allowed inside other functions, and causes OpenModelica to fail during translation
---
 .../Validation/InternalResistancesOneUTube.mo   | 10 +++++++++-
 .../InternalResistancesOneUTubeNegative.mo      | 10 +++++++++-
 .../Validation/InternalResistancesTwoUTube.mo   | 10 +++++++++-
 .../InternalResistancesTwoUTubeNegative.mo      | 10 +++++++++-
 .../Functions/internalResistancesOneUTube.mo    |  9 ++++++++-
 .../Functions/internalResistancesTwoUTube.mo    |  9 ++++++++-
 .../Functions/partialInternalResistances.mo     |  9 +++++++++
 .../BaseClasses/InternalHEXOneUTube.mo          | 10 +++++++++-
 .../BaseClasses/InternalHEXTwoUTube.mo          | 10 +++++++++-
 Buildings/package.mo                            | 17 +++++++++++------
 10 files changed, 90 insertions(+), 14 deletions(-)
diff --git a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesOneUTube.mo b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesOneUTube.mo
index 8abb23979c0..4903667333d 100644
--- a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesOneUTube.mo
+++ b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesOneUTube.mo
@@ -57,7 +57,8 @@ initial equation
       kMed=kMed,
       muMed=muMed,
       cpMed=cpMed,
-      m_flow_nominal=m_flow_nominal);
+      m_flow_nominal=m_flow_nominal,
+      instanceName=getInstanceName());
 
   annotation (
     __Dymola_Commands(file=
@@ -75,6 +76,13 @@ borehole.
 </html>", revisions="<html>
 <ul>
 <li>
+November 22, 2023, by Michael Wetter:<br/>
+Corrected use of <code>getInstanceName()</code> which was called inside a function which
+is not allowed.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1814\">IBPSA, #1814</a>.
+</li>
+<li>
 June 21, 2018, by Massimo Cimmino:<br/>
 First implementation.
 </li>
diff --git a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesOneUTubeNegative.mo b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesOneUTubeNegative.mo
index 00a8d1b1baf..97199a6225d 100644
--- a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesOneUTubeNegative.mo
+++ b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesOneUTubeNegative.mo
@@ -56,7 +56,8 @@ initial equation
       kMed=kMed,
       muMed=muMed,
       cpMed=cpMed,
-      m_flow_nominal=m_flow_nominal);
+      m_flow_nominal=m_flow_nominal,
+      instanceName=getInstanceName());
 
   annotation (
     __Dymola_Commands(file=
@@ -79,6 +80,13 @@ capacity location <code>x</code> is then automatically set to zero.
 </html>", revisions="<html>
 <ul>
 <li>
+November 22, 2023, by Michael Wetter:<br/>
+Corrected use of <code>getInstanceName()</code> which was called inside a function which
+is not allowed.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1814\">IBPSA, #1814</a>.
+</li>
+<li>
 June 21, 2018, by Massimo Cimmino:<br/>
 First implementation.
 </li>
diff --git a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesTwoUTube.mo b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesTwoUTube.mo
index cd309b57a05..98fbe9e92f2 100644
--- a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesTwoUTube.mo
+++ b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesTwoUTube.mo
@@ -58,7 +58,8 @@ initial equation
       kMed=kMed,
       muMed=muMed,
       cpMed=cpMed,
-      m_flow_nominal=m_flow_nominal);
+      m_flow_nominal=m_flow_nominal,
+      instanceName=getInstanceName());
 
   annotation (
     __Dymola_Commands(file=
@@ -76,6 +77,13 @@ borehole.
 </html>", revisions="<html>
 <ul>
 <li>
+November 22, 2023, by Michael Wetter:<br/>
+Corrected use of <code>getInstanceName()</code> which was called inside a function which
+is not allowed.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1814\">IBPSA, #1814</a>.
+</li>
+<li>
 June 21, 2018, by Massimo Cimmino:<br/>
 First implementation.
 </li>
diff --git a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesTwoUTubeNegative.mo b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesTwoUTubeNegative.mo
index 474e0e1094b..d7a98e8dcec 100644
--- a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesTwoUTubeNegative.mo
+++ b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/Validation/InternalResistancesTwoUTubeNegative.mo
@@ -58,7 +58,8 @@ initial equation
       kMed=kMed,
       muMed=muMed,
       cpMed=cpMed,
-      m_flow_nominal=m_flow_nominal);
+      m_flow_nominal=m_flow_nominal,
+      instanceName=getInstanceName());
 
   annotation (
     __Dymola_Commands(file=
@@ -81,6 +82,13 @@ capacity location <code>x</code> is then automatically set to zero.
 </html>", revisions="<html>
 <ul>
 <li>
+November 22, 2023, by Michael Wetter:<br/>
+Corrected use of <code>getInstanceName()</code> which was called inside a function which
+is not allowed.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1814\">IBPSA, #1814</a>.
+</li>
+<li>
 June 21, 2018, by Massimo Cimmino:<br/>
 First implementation.
 </li>
diff --git a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/internalResistancesOneUTube.mo b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/internalResistancesOneUTube.mo
index b544984738b..ae4a52311b4 100644
--- a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/internalResistancesOneUTube.mo
+++ b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/internalResistancesOneUTube.mo
@@ -81,7 +81,7 @@ algorithm
       i := i + 1;
     end while;
   end if;
-  assert(test, "In " + getInstanceName() + ":\n" +
+  assert(test, "In " + instanceName + ":\n" +
   "Maximum number of iterations exceeded. Check the borehole geometry.
   The tubes may be too close to the borehole wall.
   Input to the function
@@ -121,6 +121,13 @@ International Journal of Energy Research, 35:312&ndash;320, 2011.</p>
 </html>", revisions="<html>
 <ul>
 <li>
+November 22, 2023, by Michael Wetter:<br/>
+Corrected use of <code>getInstanceName()</code> which was called inside a function which
+is not allowed.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1814\">IBPSA, #1814</a>.
+</li>
+<li>
 February 7, 2022, by Michael Wetter:<br/>
 Changed function to be <code>pure</code>.<br/>
 This is for
diff --git a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/internalResistancesTwoUTube.mo b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/internalResistancesTwoUTube.mo
index 35080acb90a..af0cce2a7e4 100644
--- a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/internalResistancesTwoUTube.mo
+++ b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/internalResistancesTwoUTube.mo
@@ -88,7 +88,7 @@ algorithm
       i := i + 1;
     end while;
   end if;
-  assert(test, "In " + getInstanceName() + ":\n" +
+  assert(test, "In " + instanceName + ":\n" +
   "Maximum number of iterations exceeded. Check the borehole geometry.
   The tubes may be too close to the borehole wall.
   Input to the function
@@ -129,6 +129,13 @@ International Journal of Energy Research, 35:312&ndash;320, 2011.</p>
 </html>", revisions="<html>
 <ul>
 <li>
+November 22, 2023, by Michael Wetter:<br/>
+Corrected use of <code>getInstanceName()</code> which was called inside a function which
+is not allowed.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1814\">IBPSA, #1814</a>.
+</li>
+<li>
 February 7, 2022, by Michael Wetter:<br/>
 Changed function to be <code>pure</code>.<br/>
 This is for
diff --git a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/partialInternalResistances.mo b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/partialInternalResistances.mo
index e9289988358..43f320ab576 100644
--- a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/partialInternalResistances.mo
+++ b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/Functions/partialInternalResistances.mo
@@ -29,6 +29,8 @@ partial function partialInternalResistances
   input Modelica.Units.SI.SpecificHeatCapacity cpMed
     "Specific heat capacity of the fluid";
   input Modelica.Units.SI.MassFlowRate m_flow_nominal "Nominal mass flow rate";
+  input String instanceName="undeclared caller"
+    "Instance name of the model or block that calls this function";
 
   // Outputs
   output Real x "Capacity location";
@@ -71,6 +73,13 @@ the borehole internal resistances.
 </html>", revisions="<html>
 <ul>
 <li>
+November 22, 2023, by Michael Wetter:<br/>
+Corrected use of <code>getInstanceName()</code> which was called inside a function which
+is not allowed.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1814\">IBPSA, #1814</a>.
+</li>
+<li>
 June 4, 2023, by Michael Wetter:<br/>
 Corrected variability.<br/>
 This is for <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1762\">IBPSA, #1762</a>.
diff --git a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/InternalHEXOneUTube.mo b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/InternalHEXOneUTube.mo
index 70491dd7fc7..d7b6e146bcc 100644
--- a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/InternalHEXOneUTube.mo
+++ b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/InternalHEXOneUTube.mo
@@ -92,7 +92,8 @@ initial equation
       kMed=kMed,
       muMed=muMed,
       cpMed=cpMed,
-      m_flow_nominal=m1_flow_nominal);
+      m_flow_nominal=m1_flow_nominal,
+      instanceName=getInstanceName());
 
 equation
     assert(borFieDat.conDat.borCon == Buildings.Fluid.Geothermal.Borefields.Types.BoreholeConfiguration.SingleUTube,
@@ -159,6 +160,13 @@ International Journal Of Energy Research, 35:312-320, 2011.
 </html>", revisions="<html>
 <ul>
 <li>
+November 22, 2023, by Michael Wetter:<br/>
+Corrected use of <code>getInstanceName()</code> which was called inside a function which
+is not allowed.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1814\">IBPSA, #1814</a>.
+</li>
+<li>
 March 7, 2022, by Michael Wetter:<br/>
 Removed <code>massDynamics</code>.<br/>
 This is for
diff --git a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/InternalHEXTwoUTube.mo b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/InternalHEXTwoUTube.mo
index 4de2d00a3c6..a6b23fbb9d0 100644
--- a/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/InternalHEXTwoUTube.mo
+++ b/Buildings/Fluid/Geothermal/Borefields/BaseClasses/Boreholes/BaseClasses/InternalHEXTwoUTube.mo
@@ -153,7 +153,8 @@ initial equation
       kMed=kMed,
       muMed=muMed,
       cpMed=cpMed,
-      m_flow_nominal=m1_flow_nominal);
+      m_flow_nominal=m1_flow_nominal,
+      instanceName=getInstanceName());
 
 equation
   assert(borFieDat.conDat.borCon == Buildings.Fluid.Geothermal.Borefields.Types.BoreholeConfiguration.DoubleUTubeParallel
@@ -253,6 +254,13 @@ International Journal Of Energy Research, 35:312-320, 2011.
 </html>", revisions="<html>
 <ul>
 <li>
+November 22, 2023, by Michael Wetter:<br/>
+Corrected use of <code>getInstanceName()</code> which was called inside a function which
+is not allowed.<br/>
+This is for
+<a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1814\">IBPSA, #1814</a>.
+</li>
+<li>
 March 7, 2022, by Michael Wetter:<br/>
 Removed <code>massDynamics</code>.<br/>
 This is for
diff --git a/Buildings/package.mo b/Buildings/package.mo
index b1b2adfaeec..19bd0761054 100644
--- a/Buildings/package.mo
+++ b/Buildings/package.mo
@@ -206,8 +206,9 @@ Each class (i.e., model, block and function) must be used in an example or valid
 
 
     class Version_10_1_0 "Version 10.1.0"
-  extends Modelica.Icons.ReleaseNotes;
-        annotation(
+      extends
+          Modelica.Icons.ReleaseNotes;
+        annotation (
           Documentation(info = "<html>
 <div class=\"release-summary\">
 <p>
@@ -323,12 +324,16 @@ that do <b style=\"color:red\">not</b> lead to wrong simulation results, e.g.,
 units are wrong or errors in documentation):
 </p>
 <table class=\"releaseTable\" summary=\"summary\" border=\"1\" cellspacing=\"0\" cellpadding=\"2\" style=\"border-collapse:collapse;\">
-<tr><td colspan=\"2\"><b>xxx</b>
+<tr><td colspan=\"2\"><b>Buildings.Fluid.Geothermal.Borefields</b>
     </td>
 </tr>
-<tr><td valign=\"top\">xxx
+<tr><td valign=\"top\">Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.BaseClasses.Functions.internalResistancesOneUTube<br/>
+                       Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.BaseClasses.Functions.internalResistancesTwoUTube
     </td>
-    <td valign=\"top\">xxx.
+    <td valign=\"top\">Corrected usage of <code>getInstanceName()</code>, which was called inside
+                       these functions. This does not conform with the Modelica Language Standard, and causes
+                       the compilation to fail in OpenModelica 1.22.0.<br/>
+                       This is for <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1814\">IBPSA, #1814</a>
     </td>
 </tr>
 </table>
@@ -13221,4 +13226,4 @@ requirements definition or providing feedback regarding the model applicability
 to solve specific problems.
 </p>
 </html>"));
-end Buildings;
\ No newline at end of file
+end Buildings;

xxx +
Buildings.Fluid.Geothermal.Borefields
xxx +
Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.BaseClasses.Functions.internalResistancesOneUTube + Buildings.Fluid.Geothermal.Borefields.BaseClasses.Boreholes.BaseClasses.Functions.internalResistancesTwoUTube	xxx. +	Corrected usage of `getInstanceName()`, which was called inside + these functions. This does not conform with the Modelica Language Standard, and causes + the compilation to fail in OpenModelica 1.22.0. + This is for IBPSA, #1814