From 8084da58aaf92ace6c787280c425bd28221d6410 Mon Sep 17 00:00:00 2001
From: Andreas <38031952+AnHeuermann@users.noreply.github.com>
Date: Fri, 1 Mar 2024 12:14:27 +0100
Subject: [PATCH] Updating doc of some Modelica builtins (#11696)
- spatialDistribution operator
- homotopy operator
---
OMCompiler/Compiler/FrontEnd/ModelicaBuiltin.mo | 12 +++++++-----
OMCompiler/Compiler/NFFrontEnd/NFModelicaBuiltin.mo | 10 ++++++----
2 files changed, 13 insertions(+), 9 deletions(-)
diff --git a/OMCompiler/Compiler/FrontEnd/ModelicaBuiltin.mo b/OMCompiler/Compiler/FrontEnd/ModelicaBuiltin.mo
index 9dc19080bef..3572f338722 100644
--- a/OMCompiler/Compiler/FrontEnd/ModelicaBuiltin.mo
+++ b/OMCompiler/Compiler/FrontEnd/ModelicaBuiltin.mo
@@ -273,13 +273,13 @@ annotation(Documentation(info="
"));
end log10;
-function homotopy
+function homotopy "Homotopy operator actual*lambda + simplified*(1-lambda)"
input Real actual;
input Real simplified;
output Real outValue;
external "builtin";
-annotation(version="Modelica 3.2",Documentation(info="
- See homotopy() (experimental implementation)
+annotation(__OpenModelica_builtin=true, version="Modelica 3.2",Documentation(info="
+ See homotopy()
"));
end homotopy;
@@ -742,7 +742,7 @@ If no class was being simulated, the last simulated class or a default will be u
"),version="Modelica 3.3");
end getInstanceName;
-function spatialDistribution "Not yet implemented"
+function spatialDistribution "Approximation of variable-speed transport of properties"
input Real in0;
input Real in1;
input Real x;
@@ -752,7 +752,9 @@ function spatialDistribution "Not yet implemented"
output Real out0;
output Real out1;
external "builtin";
-annotation(version="Modelica 3.3");
+annotation(Documentation(info="
+spatialDistribution allows approximation of variable-speed transport of properties. For further details, see the Modelica Language Specification spatialdistribution().
+"), version="Modelica 3.3");
end spatialDistribution;
function previous "Access previous value of a clocked variable"
diff --git a/OMCompiler/Compiler/NFFrontEnd/NFModelicaBuiltin.mo b/OMCompiler/Compiler/NFFrontEnd/NFModelicaBuiltin.mo
index b0d30cfaed7..d76fd209580 100644
--- a/OMCompiler/Compiler/NFFrontEnd/NFModelicaBuiltin.mo
+++ b/OMCompiler/Compiler/NFFrontEnd/NFModelicaBuiltin.mo
@@ -288,13 +288,13 @@ annotation(__OpenModelica_builtin=true, Documentation(info="
"));
end log10;
-impure function homotopy
+impure function homotopy "Homotopy operator actual*lambda + simplified*(1-lambda)"
input Real actual;
input Real simplified;
output Real outValue;
external "builtin";
annotation(__OpenModelica_builtin=true, version="Modelica 3.2",Documentation(info="
- See homotopy() (experimental implementation)
+ See homotopy()
"));
end homotopy;
@@ -854,7 +854,7 @@ If no class was being simulated, the last simulated class or a default will be u
"),version="Modelica 3.3");
end getInstanceName;
-function spatialDistribution "Not yet implemented"
+function spatialDistribution "Approximation of variable-speed transport of properties"
input Real in0;
input Real in1;
input Real x;
@@ -864,7 +864,9 @@ function spatialDistribution "Not yet implemented"
output Real out0;
output Real out1;
external "builtin";
-annotation(__OpenModelica_builtin=true, version="Modelica 3.3");
+annotation(Documentation(info="
+spatialDistribution allows approximation of variable-speed transport of properties. For further details, see the Modelica Language Specification spatialdistribution().
+"), version="Modelica 3.3");
end spatialDistribution;
function previous<__ComponentExpression> "Access previous value of a clocked variable"