support mathematical expressions in Parameter #2325

norihiro-w · 2019-01-17T13:34:57Z

as titled. The implementation is based on exprtk (http://www.partow.net/programming/exprtk/index.html).
So far I named the new parameter type as "Function", but you might have better idea about the naming. let me know...

Remarks

Currently "x", "y", "z" are supported as variables.
Example of input files is

        <parameter>
            <name>initial_pressure</name>
            <type>Function</type>
            <expression>1000.0*9.81*(-z)</expression>
        </parameter>

For non-scalar parameters, <expression> definition should be given for each component. The number of parameter components is set by the number of given <expression>.

endJunction · 2019-01-17T15:07:02Z

I'd add a git submodule instead. Same source code by same author here: https://github.com/ArashPartow/exprtk

"Function" is OK. If we add python functions later, they can be called "Python(Function)"; no clash here.
Maybe "SpatialFunction" would be more precise. With possible variations on "TemporalFunction" or "SpatioTemporalFunction". More suggestions are welcome.

endJunction · 2019-01-17T15:17:17Z

ProcessLib/Parameter/FunctionParameter.h

+    mutable double _x, _y, _z;
+    symbol_table_t _symbol_table;
+    std::vector<expression_t> _vec_expression;
+    mutable std::vector<T> _cache;


The mutable members are not compatible with openMP parallelization. Better to use local variables in the operator().

@endJunction I will change it. FYI other parameters also have mutable members.

@endJunction no it's no easy. Because the operator() returns a reference, local variables cannot be used here.

i have created #2337 for this.

endJunction · 2019-01-17T15:18:59Z

ProcessLib/Parameter/FunctionParameter.h

+            parser_t parser;
+            if (!parser.compile(_vec_expression_str[i], _vec_expression[i]))
+            {
+                ERR("Error: %s\tExpression: %s\n", parser.error().c_str(),


Replace the ERR with OGS_FATAL. Somebody is going to miss that error message otherwise.

endJunction · 2019-01-17T15:22:01Z

ProcessLib/Parameter/FunctionParameter.cpp

+
+    std::vector<std::string> vec_expressions;
+
+    //! \ogs_file_param{prj__parameters__parameter__Function__expression}


the tag documentation files are missing. See https://github.com/ufz/ogs/tree/master/Documentation/ProjectFile/prj/parameters/parameter

wenqing

👍

wenqing · 2019-01-18T09:00:28Z

ProcessLib/Parameter/FunctionParameter.h

+#include <utility>
+#include <vector>
+
+#include <exprtk.hpp>


The file is large with template definitions. When it was compiled in OGS5 with visual studio 2010, the option of /bigobj is needed. Since the building in appveyor succeeded, I think the new visual studio can handle it without using any additional option.

i tested with VS2017 and so far it's ok.

wenqing · 2019-01-18T09:01:08Z

ProcessLib/Parameter/FunctionParameter.h

+{
+
+/// A parameter class evaluating a functon defined by
+/// a user-provided maethmatical expression.


maethmatical --> mathematical

TomFischer · 2019-01-31T06:13:17Z

Documentation/ProjectFile/prj/parameters/parameter/Function/t_expression.md

@@ -0,0 +1 @@
+Mathematical expression of the function (currently x,y,z are supported variales). For non-scalar values, an expression should be given for each component.


variales -> variables

TomFischer · 2019-01-31T06:16:56Z

ProcessLib/Parameter/FunctionParameter.h

+namespace ProcessLib
+{
+
+/// A parameter class evaluating functons defined by


functons -> functions

TomFischer · 2019-01-31T06:24:33Z

ProcessLib/Parameter/FunctionParameter.h

+
+private:
+    MeshLib::Mesh const& _mesh;
+    std::vector<std::string> _vec_expression_str;


Can _vec_expression_str be const?

TomFischer · 2019-01-31T06:59:34Z

ProcessLib/Parameter/FunctionParameter.cpp

+    std::vector<std::string> vec_expressions;
+
+    //! \ogs_file_param{prj__parameters__parameter__Function__expression}
+    for (auto p : config.getConfigSubtreeList("expression"))


for (auto const& p : config.getConfigSubtreeList("expression")) avoid copies.

TomFischer

After fixing / discussion of open points: ⏩

codecov · 2019-01-31T13:58:25Z

Codecov Report

Merging #2325 into master will increase coverage by 0.45%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master   #2325      +/-   ##
=========================================
+ Coverage   32.45%   32.9%   +0.45%     
=========================================
  Files         526     525       -1     
  Lines       20008   19712     -296     
  Branches     4051    4050       -1     
=========================================
- Hits         6493    6487       -6     
+ Misses      10272    9981     -291     
- Partials     3243    3244       +1

Impacted Files	Coverage Δ
GeoLib/SurfaceGrid.cpp	`53.7% <0%> (-2.78%)`	⬇️
GeoLib/Surface.cpp	`56.81% <0%> (-2.28%)`	⬇️
GeoLib/Polyline.cpp	`35.75% <0%> (-0.61%)`	⬇️
...ousMedium/Permeability/createPermeabilityModel.cpp	`0% <0%> (ø)`	⬆️
Applications/ApplicationsLib/ProjectData.cpp	`0% <0%> (ø)`	⬆️
...Lib/PorousMedium/Permeability/DupuitPermeability.h

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b910d25...1c2a783. Read the comment docs.

ogsbot · 2020-06-19T12:57:17Z

OpenGeoSys development has been moved to GitLab.

See this pull request on GitLab.

endJunction reviewed Jan 17, 2019

View reviewed changes

wenqing approved these changes Jan 18, 2019

View reviewed changes

norihiro-w mentioned this pull request Jan 30, 2019

[PL] remove mutable member variables in Parameter classes #2337

Merged

norihiro-w force-pushed the add-exprtk branch 2 times, most recently from 5bce310 to bff354a Compare January 31, 2019 03:53

TomFischer reviewed Jan 31, 2019

View reviewed changes

TomFischer approved these changes Jan 31, 2019

View reviewed changes

norihiro-w added 6 commits January 31, 2019 22:02

add exprtk as submodule

99155e6

[CMake] add exprtk to include dir

3f11cb0

[PL] add FunctionParameter

0cc30f6

[doc] add docs for the new parameter type Function

af51c8c

[doc] fix typo

c9f624d

[PL] minor fixes in FunctionParameter

e9f3ad5

norihiro-w force-pushed the add-exprtk branch from 0946bc0 to e9f3ad5 Compare January 31, 2019 13:03

norihiro-w added 2 commits January 31, 2019 22:57

[Third] add exprtk in ReadMe

1d5b069

[cmake] add exprtk to required submodulues

1c2a783

endJunction merged commit 7e0dc96 into ufz:master Jan 31, 2019

norihiro-w deleted the add-exprtk branch September 26, 2022 15:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support mathematical expressions in Parameter #2325

support mathematical expressions in Parameter #2325

norihiro-w commented Jan 17, 2019 •

edited

Loading

endJunction commented Jan 17, 2019

endJunction Jan 17, 2019

norihiro-w Jan 21, 2019

norihiro-w Jan 30, 2019

norihiro-w Jan 30, 2019

endJunction Jan 17, 2019

norihiro-w Jan 30, 2019

endJunction Jan 17, 2019

norihiro-w Jan 30, 2019

wenqing left a comment

wenqing Jan 18, 2019

norihiro-w Jan 21, 2019

wenqing Jan 18, 2019

norihiro-w Jan 30, 2019

TomFischer Jan 31, 2019

norihiro-w Jan 31, 2019

TomFischer Jan 31, 2019

norihiro-w Jan 31, 2019

TomFischer Jan 31, 2019

norihiro-w Jan 31, 2019

TomFischer Jan 31, 2019

norihiro-w Jan 31, 2019

TomFischer left a comment

codecov bot commented Jan 31, 2019 •

edited

Loading

ogsbot commented Jun 19, 2020


		std::vector<std::string> vec_expressions;

		//! \ogs_file_param{prj__parameters__parameter__Function__expression}

		@@ -0,0 +1 @@
		Mathematical expression of the function (currently x,y,z are supported variales). For non-scalar values, an expression should be given for each component.

support mathematical expressions in Parameter #2325

support mathematical expressions in Parameter #2325

Conversation

norihiro-w commented Jan 17, 2019 • edited Loading

endJunction commented Jan 17, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wenqing left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomFischer left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 31, 2019 • edited Loading

Codecov Report

ogsbot commented Jun 19, 2020

norihiro-w commented Jan 17, 2019 •

edited

Loading

codecov bot commented Jan 31, 2019 •

edited

Loading