blockCombiTable1Dv
Extends from Modelica.Blocks.Interfaces.MIMOs (Multiple Input Multiple Output continuous control block with same number of inputs and outputs).
Information
Univariate constant, linear or cubic Hermite spline interpolation in one dimension of a table. Via parameter columns it can be defined how many columns of the table are interpolated. If, e.g., columns={2,4}, it is assumed that 2 input and 2 output signals are present and that the first output interpolates the first input via column 2 and the second output interpolates the second input via column 4 of the table matrix.
The grid points and function values are stored in a matrix "table[i,j]", where the first column "table[:,1]" contains the grid points and the other columns contain the data to be interpolated. Example:
table = [0, 0;
1, 1;
2, 4;
4, 16]
If, e.g., the input u = 1.0, the output y = 1.0,
e.g., the input u = 1.5, the output y = 2.5,
e.g., the input u = 2.0, the output y = 4.0,
e.g., the input u =-1.0, the output y = -1.0 (i.e., extrapolation).
- The interpolation interval is found by a binary search where the interval used in the last call is used as start interval.
- Via parameter smoothness it is defined how the data is interpolated:
smoothness = 1: Linear interpolation = 2: Akima interpolation: Smooth interpolation by cubic Hermite splines such that der(y) is continuous, also if extrapolated. = 3: Constant segments = 4: Fritsch-Butland interpolation: Smooth interpolation by cubic Hermite splines such that y preserves the monotonicity and der(y) is continuous, also if extrapolated. = 5: Steffen interpolation: Smooth interpolation by cubic Hermite splines such that y preserves the monotonicity and der(y) is continuous, also if extrapolated. = 6: Modified Akima interpolation: Smooth interpolation by cubic Hermite splines such that der(y) is continuous, also if extrapolated. Additionally, overshoots and edge cases of the original Akima interpolation method are avoided. - First and second derivatives are provided, with exception of the following two smoothness options.
- No derivatives are provided for interpolation by constant segments.
- No second derivative is provided for linear interpolation.
- Values outside of the table range, are computed by
extrapolation according to the setting of parameter extrapolation:
extrapolation = 1: Hold the first or last value of the table, if outside of the table scope. = 2: Extrapolate by using the derivative at the first/last table points if outside of the table scope. (If smoothness is LinearSegments or ConstantSegments this means to extrapolate linearly through the first/last two table points.). = 3: Periodically repeat the table data (periodical function). = 4: No extrapolation, i.e. extrapolation triggers an error - If the table has only one row, the table value is returned, independent of the value of the input signal.
- The grid values (first column) have to be strictly increasing.
The table matrix can be defined in the following ways:
- Explicitly supplied as parameter matrix "table",
and the other parameters have the following values:
tableName is "NoName" or has only blanks, fileName is "NoName" or has only blanks.
- Read from a file "fileName" where the matrix is stored as
"tableName". CSV, text and MATLAB MAT-file format is possible.
(Both the limitations on the CSV format and the text format are described below).
The MAT-file format comes in four different versions: v4, v6, v7 and v7.3.
The library supports at least v4, v6 and v7 whereas v7.3 is optional.
It is most convenient to generate the MAT-file from FreeMat or MATLAB®
by command
or Scilab by commandsave tables.mat tab1 tab2 tab3
when the three tables tab1, tab2, tab3 should be used from the model.savematfile tables.mat tab1 tab2 tab3
Note, a fileName can be defined as URI by using the helper function loadResource. - Statically stored in function "usertab" in file "usertab.c". The matrix is identified by "tableName". Parameter fileName = "NoName" or has only blanks. Row-wise storage is always to be preferred as otherwise the table is reallocated and transposed. See the Tables package documentation for more details.
When the constant "NO_FILE_SYSTEM" is defined, all file I/O related parts of the source code are removed by the C-preprocessor, such that no access to files takes place.
If the table is read from a CSV file, the following limitations apply
- Non-numeric data is not supported (in the lines following the header lines), even if such columns are excluded.
- Double-quoted data entries in the first header line shall not contain the column delimiter.
If tables are read from a text file, the file needs to have the following structure ("-----" is not part of the file content):
----------------------------------------------------- #1 double tab1(5,2) # comment line 0 0 1 1 2 4 3 9 4 16 double tab2(5,2) # another comment line 0 0 2 2 4 8 6 18 8 32 -----------------------------------------------------
Note, that the first two characters in the file need to be "#1" (a line comment defining the version number of the file format). Afterwards, the corresponding matrix has to be declared with type (= "double" or "float"), name and actual dimensions. A valid matrix name (e.g., "tab1") must be ASCII encoded and not contain blanks, line breaks, tab (\t), comma (,) or parentheses. Finally, in successive rows of the file, the elements of the matrix have to be given. The elements have to be provided as a sequence of numbers in row-wise order (therefore a matrix row can span several lines in the file and need not start at the beginning of a line). Numbers have to be given according to C syntax (such as 2.3, -2, +2.e4). Number separators are spaces, tab (\t), comma (,), or semicolon (;). Several matrices may be defined one after another. Line comments start with the hash symbol (#) and can appear everywhere. Text files should either be ASCII or UTF-8 encoded, where UTF-8 encoded strings are only allowed in line comments and an optional UTF-8 BOM at the start of the text file is ignored. Other characters, like trailing non comments, are not allowed in the file.
MATLAB is a registered trademark of The MathWorks, Inc.
Parameters
| Type | Name | Default | Description |
|---|---|---|---|
| Integer | n (from MIMOs) | 1 | Number of inputs (= number of outputs) |
| Real | u_min | Internal.getTable1DAbscissaUmin(tableID) | Minimum abscissa value defined in table |
| Real | u_max | Internal.getTable1DAbscissaUmax(tableID) | Maximum abscissa value defined in table |
| Table data definition | |||
| Boolean | tableOnFile | false | = true, if table is defined on file or in function usertab |
| Real[:,:] | table | fill(0.0, 0, 2) | Table matrix (grid = first column; e.g., table=[0, 0; 1, 1; 2, 4]) |
| String | tableName | "NoName" | Table name on file or in function usertab (see docu) |
| String | fileName | "NoName" | File where matrix is stored |
| String | delimiter | "," | Column delimiter character for CSV file |
| Integer | nHeaderLines | 0 | Number of header lines to ignore for CSV file |
| Boolean | verboseRead | true | = true, if info message that file is loading is to be printed |
| Table data interpretation | |||
| Integer[:] | columns | 2:size(table, 2) | Columns of table to be interpolated |
| Modelica.Blocks.Types.Smoothness | smoothness | Modelica.Blocks.Types.Smoothness.LinearSegments | Smoothness of table interpolation |
| Modelica.Blocks.Types.Extrapolation | extrapolation | Modelica.Blocks.Types.Extrapolation.LastTwoPoints | Extrapolation of data outside the definition range |
| Boolean | verboseExtrapolation | false | = true, if warning messages are to be printed if table input is outside the definition range |
Connectors
| Type | Name | Default | Description |
|---|---|---|---|
| RealInput[n] | u (from MIMOs) | Connector of Real input signals | |
| RealOutput[n] | y (from MIMOs) | Connector of Real output signals |