ModelicaTableAdditions

Free Modelica library for univariate and bivariate interpolation and extrapolation in lookup-tables.

Status

Library description

ModelicaTableAdditions is an extension of the CombiTable blocks of the Modelica Standard Library to support reading CSV, EPW (EnergyPlus Weather) and JSON files. An overview of the library is provided in

Thomas Beutlich and Dietmar Winkler. Efficient Parameterization of Modelica Models. In: Proceedings of the 14th International Modelica Conference. Ed. by Martin Sjölund, Lena Buffoni, Adrian Pop, and Lennart Ochel. Linköping, Sweden, September 2021. DOI: 10.3384/ecp21181141.

Some more implementation details have been published earlier in

Thomas Beutlich, Gerd Kurzbach and Uwe Schnabel. Remarks on the Implementation of the Modelica Standard Tables. In: Proceedings of the 10th International Modelica Conference. Ed. by Hubertus Tummescheit and Karl-Erik Årzén. Lund, Sweden, March 2014. DOI: 10.3384/ecp14096893.

Main features

• Read support of file formats
  • CSV
  • EPW (EnergyPlus Weather)
  • JSON
  • MATLAB MAT of version v4, v6, v7 (and v7.3 depending on Modelica tool)
  • MOS (Text)
• Univariate interpolation by
  • Constant segments
  • Linear segments
  • Akima splines
  • Natural cubic splines
  • Fritsch-Butland splines
  • Steffen splines
  • Modified Akima splines
• Bivariate interpolation by
  • Constant segments
  • Bilinear segments
  • Akima splines
  • Natural cubic splines
• Extrapolation by
  • Constant continuation
  • Continuously differentiable continuation
  • Periodic repetition
  • Extrapolation triggers an error
• C (and not C++) code for external functions and objects
• Cross-platform (Windows and Linux)
• Dependency on the Modelica Standard Library v4.0.0
• Tested in Dymola and OpenModelica

Building the external libraries

CMake is recommended as build system, which usually consists of three steps for configuration, build and installation. By default, the CMake project is also configured for testing with CTest. For example,

git clone https://github.com/tbeu/ModelicaTableAdditions
cd ModelicaTableAdditions
cmake -S ./ModelicaTableAdditions/Resources -B .
cmake --build .
ctest --test-dir .
cmake --install .

The following ModelicaTableAdditions specific options for building with CMake are available.

• MODELICA_COPY_TABLE_DATA:BOOL=ON This flag avoids an undesired memory optimization of shallow-copying the passed table arrays.
• MODELICA_DEBUG_TIME_EVENTS:BOOL=OFF This flag enables tracing of time events.
• MODELICA_DUMMY_FUNCTION_USERTAB:BOOL=OFF This flag adds a dummy function "usertabadditions".
• MODELICA_SHARE_TABLE_DATA:BOOL=ON This flag enables the memory optimization of avoiding redundant copies of table arrays read from file.
• MODELICA_BUILD_TESTING:BOOL=ON This option enables the GoogleTest based testsuite for CTest.

License

ModelicaTableAdditions is released under the terms of the Simplified BSD License.

Citing

Use the following BibTeX lines to cite the ModelicaTableAdditions library.

@InProceedings{ModelicaTableAdditions,
  title = {{Efficient Parameterization of Modelica Models}},
  author = {Beutlich, Thomas and Winkler, Dietmar},
  pages = {141--146},
  doi = {10.3384/ecp21181141},
  booktitle = {Proceedings of the 14th International Modelica Conference},
  location = {Link\"oping, Sweden},
  editor = {Sj\"olund, Martin and Buffoni, Lena and Pop, Adrian and Ochel, Lennart},
  isbn = {978-91-7929-027-6},
  issn = {1650-3740},
  month = sep,
  series = {Link\"oping Electronic Conference Proceedings},
  number = {181},
  publisher = {Modelica Association and Link\"oping University Electronic Press},
  year = {2021}
}

Development and contribution

You may report any issues with using the Issues button.

Contributions in shape of Pull Requests are always welcome.