diff --git a/docs/examples/combi1d_modelDescription.xml b/docs/examples/combi1d_modelDescription.xml new file mode 100644 index 0000000..3d7cc98 --- /dev/null +++ b/docs/examples/combi1d_modelDescription.xml @@ -0,0 +1,13 @@ +... + + + + + + + + +... diff --git a/docs/examples/combi1d_terminalsAndIcons.xml b/docs/examples/combi1d_terminalsAndIcons.xml new file mode 100644 index 0000000..c4b0c4f --- /dev/null +++ b/docs/examples/combi1d_terminalsAndIcons.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/docs/examples/combi2d_modelDescription.xml b/docs/examples/combi2d_modelDescription.xml new file mode 100644 index 0000000..741c70f --- /dev/null +++ b/docs/examples/combi2d_modelDescription.xml @@ -0,0 +1,13 @@ +... + + + + + + + + +... diff --git a/docs/examples/combi2d_terminalsAndIcons.xml b/docs/examples/combi2d_terminalsAndIcons.xml new file mode 100644 index 0000000..49ed39a --- /dev/null +++ b/docs/examples/combi2d_terminalsAndIcons.xml @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/docs/index.adoc b/docs/index.adoc index e11b030..ca51d8c 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -35,6 +35,7 @@ The licenses text can be found in the https://raw.githubusercontent.com/modelica For many use cases, the grouping of variables gives the user a better overview about the usage of variables. For certain groupings the importing tool might be able to provide a more user-friendly interface. FMUs might use maps/functions sampled on the vertices of a grid to calculate output values. The values at these sampling points and even the locations of the sampling points might get exposed as parameter variables of the FMU to allow calibrations. However, the FMI standard only defines n-dimensional array variable but doesn't define any relation between these variables. This layered standard defines how to group variables to represent maps. +E.g., CombiTable1D or CombiTable2D blocks of the Modelica standard library used within an FMU can be exposed with this approach. This layered standard uses terminals of the FMI 3.0 standard to represent structures like maps by grouping variables in terminals. Terminals are used to group variables and already define means to connect its variables between FMUs. Such a connections could ensure that the same map values are used by different FMUs or allow one FMU to provide the map values to be used by other FMUs. @@ -111,6 +112,12 @@ n-D lookup table:: In the context of this layered standard, an n-D lookup table `org.fmi-standard.fmi-ls-struct.map.rectilinearGrid`:: for maps defined on the vertices of a rectilinear grid. +`org.fmi-standard.fmi-ls-struct.map.combitable1d`:: +for 1-d maps defined on the vertices of a rectilinear grid, stored in a single matrix. + +`org.fmi-standard.fmi-ls-struct.map.combitable2d`:: +for 2-d maps defined on the vertices of a rectilinear grid, in a single matrix. + `org.fmi-standard.fmi-ls-struct.map.irregular`:: for maps defined by unstructured tuples of ("point cloud"). @@ -224,6 +231,89 @@ include::examples/terminalsAndIcons.xml[] +=== Referencing Modelica Standard Library Combitables + +The Modelica Standard Library defines lookup tables which are stored in a single matrix (https://doc.modelica.org/om/Modelica.Blocks.Tables.html) + + +==== Referencing Modelica Standard Library CombiTable1d + +===== Example + + +[[combitable1d_example]] +[cols="1,1,1,2"] +|==== +|x.0 +|v1 +|v2 +|v3 + +|1.0 +|2.0 +|4.0 +|7.0 + +|2.0 +|3.0 +|2.0 +|5.0 + +|3.0 +|4.0 +|1.0 +|2.0 +|==== + +[source, xml] +---- +include::examples/combi1d_modelDescription.xml[] +---- + +The following example shows how to reference the Modelica Standard Library CombiTable1D matrix `combitable1d_example` in the TerminalsAndIcons.xml file: +[source, xml] +---- +include::examples/combi1d_terminalsAndIcons.xml[] +---- + + +==== Referencing Modelica Standard Library CombiTable2d + +===== Example + +[[combitable2d_example]] +[cols="1,1,1,2"] +|==== +| +|1.0 +|2.0 +|3.0 + +|1.0 +|1.0 +|3.0 +|5.0 + +|2.0 +|2.0 +|4.0 +|6.0 +|==== + +[source, xml] +---- +include::examples/combi2d_modelDescription.xml[] +---- + +The following example shows how to reference the Modelica Standard Library CombiTable2D matrix `combitable2d_example` in the TerminalsAndIcons.xml file: +[source, xml] +---- +include::examples/combi2d_terminalsAndIcons.xml[] +---- + + + + == Maps sampled on irregular grids ("Point Cloud")