updated documentation of smoothInterpolation() to direct to new function

ibpsa · Feb 29, 2024 · 0749682 · 0749682
1 parent 459009a
commit 0749682
Showing 1 changed file with 14 additions and 4 deletions.
diff --git a/IBPSA/Utilities/Math/Functions/smoothInterpolation.mo b/IBPSA/Utilities/Math/Functions/smoothInterpolation.mo
@@ -61,10 +61,20 @@ function value <i>y<sup>1</sup></i> is returned.
 </p>
 <p>
 Note that if <code>xSup</code> and <code>ySup</code> only depend on parameters
-or constants, then
-<a href=\"modelica://IBPSA.Utilities.Math.Functions.cubicHermiteLinearExtrapolation\">
-IBPSA.Utilities.Math.Functions.cubicHermiteLinearExtrapolation</a>
-will be more efficient.
+or constants and will not change during the simulation,
+it is more efficient to first call
+<a href=\"modelica://IBPSA.Utilities.Math.Functions.splineDerivatives\">
+IBPSA.Utilities.Math.Functions.splineDerivatives</a>
+to find the derivatives, and then call
+<a href=\"modelica://IBPSA.Utilities.Math.Functions.interpolate\">
+IBPSA.Utilities.Math.Functions.interpolate</a> to perform the interpolation.
+This way the derivatives only need to be computed once upon initialisation,
+not at each step during the simulation.
+See the example implemented in
+<a href=\"modelica://IBPSA.Utilities.Math.Functions.Examples.Interpolate\">
+IBPSA.Utilities.Math.Functions.Examples.Interpolate</a>.
+</p>
+<p>
 In contrast to the function
 <a href=\"modelica://Modelica.Math.Vectors.interpolate\">
 Modelica.Math.Vectors.interpolate</a>