Functional Mockup Interface 2.0: The Standard for Tool independent Exchange of Simulation Models
Blochwitz, Torsten; Otter, Martin; Åkesson, Johan; Arnold, Martin; Clauss, Christoph; Elmqvist, Hilding; Friedrich, Markus; Junghanns, Andreas; Mauss, Jakob; Neumerkel, Dietmar; Olsson, Hans; Viel, Antoine Published in: Proceedings of the 9th International Modelica Conference
DOI: 10.3384/ecp12076173
2012
Link to publication
Citation for published version (APA): Blochwitz, T., Otter, M., Åkesson, J., Arnold, M., Clauss, C., Elmqvist, H., Friedrich, M., Junghanns, A., Mauss, J., Neumerkel, D., Olsson, H., & Viel, A. (2012). Functional Mockup Interface 2.0: The Standard for Tool independent Exchange of Simulation Models. In Proceedings of the 9th International Modelica Conference (pp. 173-184). The Modelica Association. https://doi.org/10.3384/ecp12076173 Total number of authors: 12
General rights Unless other specific re-use rights are stated the following general rights apply: Copyright and moral rights for the publications made accessible in the public portal are retained by the authors and/or other copyright owners and it is a condition of accessing publications that users recognise and abide by the legal requirements associated with these rights. • Users may download and print one copy of any publication from the public portal for the purpose of private study or research. • You may not further distribute the material or use it for any profit-making activity or commercial gain • You may freely distribute the URL identifying the publication in the public portal
Read more about Creative commons licenses: https://creativecommons.org/licenses/ Take down policy If you believe that this document breaches copyright please contact us providing details, and we will remove access to the work immediately and investigate your claim. LUND UNIVERSITY
PO Box 117 221 00 Lund +46 46-222 00 00
Download date: 27. Sep. 2021 Functional Mockup Interface 2.0: The Standard for Tool independent Exchange of Simulation Models
T. Blochwitz1, M. Otter2, J. Akesson3, M. Arnold4, C. Clauß5, H. Elmqvist6 M. Friedrich7, A. Junghanns8, J. Mauss8, D. Neumerkel9, H. Olsson6,, A. Viel10 Germany: 1ITI GmbH, Dresden; 2DLR Oberpfaffenhofen; 4University of Halle, 5Fraunhofer IIS EAS, Dresden; 7SIMPACK, Gilching; 8QTronic, Berlin;9Daimler AG, Stuttgart; Sweden: 6Dassault Systèmes, Lund; 3Modelon, Lund; France: 10LMS Imagine, Roanne
Abstract
The Functional Mockup Interface (FMI) is a tool independent standard for the exchange of dynamic models and for Co-Simulation. The first version, FMI 1.0, was published in 2010. Already more than Figure 1: Improving model-based design between OEM and 30 tools support FMI 1.0. In this paper an overview supplier with FMI. about the upcoming version 2.0 of FMI is given that combines the formerly separated interfaces for Mod- The MODELISAR project ended in Dec. 2011. The el Exchange and Co-Simulation in one standard. maintenance and further development is now per- Based on the experience on using FMI 1.0, many formed by the Modelica Association in form of the small details have been improved and new features Modelica Association Project FMI (see introduced to ease the use and increase the perfor- https://www.modelica.org/projects). FMI was initiat- mance especially for larger models. Additionally, a ed and organized by Daimler AG with the goal to free FMI compliance checker is available and FMI improve the exchange of simulation models between models from different tools are made available on suppliers and OEMs. The further FMI development the web to simplify testing. is performed by 16 companies and research institutes (see Annex). The FMI project is open for FMI inter- Keywords: Simulation; Co-Simulation, Model Ex- ested persons1 and for (Modelica and non-Modelica) change; Functional Mockup Interface (FMI); Func- tool vendors supporting FMI. tional Mockup Unit (FMU); In this article an overview about the upcoming version 2.0 of FMI is given. This new version com- bines the formerly separated interfaces for Model 1 Introduction Exchange and Co-Simulation in one standard. The specification document was clarified which increases The Functional Mockup Interface (FMI) standard the compatibility of implementations. New features version 1.0 (see [1]) was published in 2010 as one ease the use and increase the performance especially result of the ITEA2 project MODELISAR, see Fig- for larger models. ure 1. In a short time after this first release several modeling and simulation tools started to support FMI. Today, more than 30 tools support FMI 1.0, and it is heavily used in industrial and scientific pro- jects, not only in the automotive sector.
1 Members of the MA project FMI need not be Modelica As- sociation members, with exception of the project leader. 2 The Functional Mock-Up Interface tems are solved independently from each other by their individual solver. Master algorithms 2.1 Main Design Ideas control the data exchange between subsystems and the synchronization of all slave simulation The FMI 2.0 standard consists of two main parts: solvers. The interface allows standard, as well as advanced master algorithms, e.g., the usage of 1. FMI for Model Exchange: variable communication step sizes, higher order The intention is that a modeling environment can signal extrapolation, and error control. generate C-Code of a dynamic system model in
the form of an input/output block, see Figure 2, tt00,pv ,inital values (a subset of ( )) v that can be utilized by other modeling and simu- Enclosing Model lation environments. Models (without solvers) are described by differential, algebraic and dis- t time crete equations with time-, state- and step- p parameters of type T events. u inputs of type T u v all exposed variables y 2. FMI for Co-Simulation: y outputs of type T The intention is to couple two or more models T Real, Integer, Boolean, or String with solvers in a co-simulation environment. The FMU instance data exchange between subsystems is restricted (model exchange or co-simulation) to discrete communication points. In the time be- tween two communication points, the subsys- Figure 2: Data flow between the environment and the FMU Blue/red arrows: Information provided by/to the FMU.
Figure 3: Complete XML schema of upcoming FMI 2.0 (but without attributes and without time synchronization). 2.2 Distribution 2.4 C-Interface
A component which implements the FMI is called The execution interface of FMI 2.0 consists of three Functional Mockup Unit (FMU). It consists of one header files that define the C-types and –interfaces. zip-file with extension “.fmu” containing all neces- The header file “fmiTypesPlatform.h” contains all sary components to utilize the FMU either for Model definitions that depend on the target platform: Exchange, for Co-Simulation or for both: #define fmiTypesPlatform "standard32" 1. An XML-file contains the definition of all varia- #define fmiTrue 1 bles of the FMU that are exposed to the envi- #define fmiFalse 0 ronment in which the FMU shall be used, as well #define fmiUndefinedValueReference (fmiValueReference)(-1) as other model information. It is then possible to run the FMU on a target system without this in- typedef void* fmiComponent; formation, i.e., with no unnecessary overhead. typedef void* fmiComponentEnvironment; typedef void* fmiFMUState; 2. A set of C-functions is provided to execute mod- typedef unsigned int fmiValueReference; el equations for the Model-Exchange case and to typedef double fmiReal ; setup and run the slaves for the Co-Simulation typedef int fmiInteger; case. These C-functions can either be provided typedef char fmiBoolean; in source and/or binary form. Binary forms for typedef const char* fmiString ; different platforms can be included in the same typedef char fmiByte; model zip-file. The underlined, blue type definitions have been new- ly introduced into FMI 2.0. This header file must be 3. Further data can be included in the FMU zip-file, used both by the FMU and by the target simulator. If especially a model icon (bitmap file), documen- the target simulator has different definitions in the tation files, maps and tables needed by the mod- header file (e.g., “ ” in- el, and/or all object libraries or DLLs that are typedef float fmiReal utilized. stead of “typedef double fmiReal”), then the FMU needs to be re-compiled with the header file 2.3 Description Schema used by the target simulator. The header file plat- form, for which the model was compiled, as well as All information about a model and a co-simulation the version number of the header files, can be in- setup that is not needed during execution is stored in quired in the target simulator with FMI functions. an XML-file called “modelDescription.XML”. The The type fmiValueReference defines a handle benefit is that every tool can use its favorite pro- for the value of a variable: The handle is unique at gramming language to read this XML-file (e.g., C, least with respect to the corresponding base type C++, C#, Java, Python) and that the overhead, both (such as fmiReal) besides alias variables that can in terms of memory and simulation efficiency, is re- have the same handle. All structured entities, such as duced. The XML-file is defined by an XML-schema records and arrays, are “flattened” into a set of scalar file called “fmiModelDescription.xsd”. In FMI 2.0, values of type fmiReal, fmiInteger etc. A the XML-file contains the information both for fmiValueReference references one such scalar. Model-Exchange and for Co-Simulation. The coding of fmiValueReference does not need In Figure 2, the complete XML schema definition to be exposed by the modeling environment that is shown. All parts are the same for the two FMI- generated the model. The data exchange is per- cases, with exception of the elements “Mod- formed using the functions fmiSetXXX(...) and elExchange” and “CoSimulation” that contain defini- fmiGetXXX(...). XXX stands for one of the types tions specific to the respective case. If either one or Real, Integer, Boolean, and String. One argument of both of the two elements are present in the XML file, these functions is an array of fmiValueReference, then the respective C-functions are available in the which defines which variables are accessed. The zip-file (usually in binary form as DLL for Win- mapping between the FMU variables and the dows, and/or as shared object for Linux or Mac). fmiValueReferences is stored in the model de- Another essential difference to FMI 1.0 is the new scription XML file. element “ModelStructure” that exposes and provides For simplicity, a “flat” structure of variables is more details of the model structure. used. Still, the original hierarchical structure of the variables can be retrieved, if a flag is set in the XML-file that a particular convention of the variable names is used. For example, the Modelica variable If an FMU is shipped with a DLL/SharedObject, name “pipe[3,4].T[14]” defines a variable the constructed function name is “fmiGetReal”, in which is the (3.4) element of an array of records other words it is not changed. A simulation environ- “pipe” of vector T (“.” separates hierarchical levels ment will then dynamically load this library and will and “[...]” defines array elements). explicitly import the function symbols by providing Header-file “fmiFunctionTypes.h” contains the FMI function names as strings. The name of the typedef definitions of all function prototypes of an library is MyModel.dll on Windows or MyModel.so FMU. When dynamically loading the DLL or shared on Linux, in other words the function prefix attribute object of an FMU, these definitions can be used to is used as library name. type-cast the function pointers to the respective func- An FMU can be optionally shipped so that it ba- tion definition. Example for a definition in this head- sically contains only the communication to another er file: tool. This is particularly common for co-simulation typedef fmiStatus fmiSetTimeTYPE tasks. In FMI 1.0, the function names are always pre- (fmiComponent, fmiReal); fixed with the model name and therefore a This header file was newly introduced in FMI 2.0 to DLL/Shared Object has to be generated for every ease the dynamic loading. model. FMI 2.0 improves this situation since model Finally, header file “fmiFunctions.h” contains the names are no longer used as prefix in case of function prototypes of an FMU that can be accessed DLL/Shared Objects: Therefore one DLL/Shared in simulation environments. This header file includes Object can be used for all models in case of tool the other two header files from above. Example for a coupling. definition in this header file: DllExport fmiSetTimeTYPE fmiSetTime; The goal is that both textual and binary represen- 3 New Features of FMI 2.0 tations of models are supported and that several models using FMI might be present at link time in an In this section the main new features introduced by executable (e.g., model A may use a model B). For FMI 2.0 are sketched. Note, also many other minor this to be possible the names of the FMI-functions in improvements have been introduced, based on the different models must be different or function point- experience in using FMI 1.0. Especially: ers must be used. To support the first variant macros are provided in “fmiFunctions.h” to build the When instantiating an FMU, the simulation envi- actual function names by using a function prefix that ronment must report the absolute path to the depends on how the FMU is shipped. Typically, FMU resource directory also in Model Ex- FMU functions are used as follows: change, in order that the FMU can read all of its resources (for example maps, tables, ...) inde- // FMU is shipped with C source code, pendently of the "current directory" of the simu- // or with static link library lation environment where the FMU is used. #define FUNCTION_PREFIX MyModel_ #include "fmiFunctions.h" Enumerations have an arbitrary (but unique) < usage of the FMU functions > mapping to integers (in FMI 1.0, the mapping was automatically assigned to 1,2,3,...). // FMU is shipped with DLL/SharedObject #define FUNCTION_PREFIX When enabling logging, log categories can be #include "fmiFunctions.h" defined, so that the FMU needs to only generate < usage of the FMU functions > logs of the defined categories (in FMI 1.0, logs had to be generated for all log categories and If an FMU is shipped with C source code, or with a they had to be filtered afterwards). static link library, then a function that is defined as Explicit alias/antiAlias variable definitions have “fmiGetReal” is changed by the macros to the ac- been removed, to simplify the interface: If varia- tual function name “MyModel_fmiGetReal”. The bles of the same base type (such as fmiReal) function prefix is hereby defined in the XML file. A have the same valueReference, they have simulation environment can therefore construct the identical values. A simulation environment may relevant function names by generating code for the ignore this completely (this was not possible in actual function call. In case of a static link library, FMI 1.0), or can utilize this information to more the name of the library is MyModel.lib on Windows, efficiently store results on file. and libMyModel.a on Linux, in other words the function prefix attribute is used as library name. Continuous state variables are explicitly listed as FMU variables, and an ordering is introduced for them, as well as for inputs, and outputs in the changing variables with causality = "parameter" XML file, in order that not an (arbitrary) order is or "input" (see explanation below). selected by the simulation environment. This is discrete: The value of the variable is constant essential, for example when linearizing an FMU, between internal events (= time, state, step or when providing "sparsity" information (see events defined implicitly in the FMU). below). continuous: No restrictions on value changes. The new value “tunable” introduced in FMI 2.0 al- 3.1 Unification of FMI for Model Exchange lows a modeling environment to expose independent and Co-Simulation parameters that can be manually “tuned” during sim- ulation (for example, during simulation a modeler In FMI 1.0 the Model Exchange and Co-Simulation might change the gain of a PID controller, or the interfaces were defined in two different documents. load mass of a drive train in order to quickly improve The XML-description and function definitions were the design). slightly different. In version 2.0 both interfaces are “Tuning a parameter” during simulation does not combined in one document and unified. Now one mean to “change the parameter online” during simu- FMU can implement both interfaces at the same lation (since this might introduce Dirac impulses). time. The presence of the “ModelExchange” or “Co- Instead, this is a short hand notation for: Simulation” elements in the XML-description indi- cates which interface is implemented. Which inter- 1. Stop the simulation at an event instant (usually, a face is used by the environment is decided by calling step event, in other words after a successful inte- the appropriate instantiation function (fmiInstan- gration step). tiateModel or fmiInstantiateSlave). 2. Change the values of the tunable parameters. In this way the distributed use case (see [1]) 3. Compute all parameters that depend on the tuna- which was applicable for Co-Simulation in FMI 1.0 ble parameters. only is supported in the Model Exchange case too. In 4. Resume the simulation using as initial values the this use case only the ability of a tool to evaluate the current values of all variables and the new values model equations is used, not its solver. of the parameters. 3.2 Classification of Interface Variables With this interpretation, changing parameters online is “clean”, as long as these changes appear at an Variables exposed by the FMU are now categorized event instant. in a slightly different way in FMI 2.0: 3.3 Save and Restore of FMU state Attribute “causality” is an enumeration that defines the causality of the variable. Allowed values are: An FMU has an internal state consisting of all values parameter: An independent variable that must that are needed to continue a simulation. This inter- be constant during simulation. nal state consists especially of the values of the con- input: The variable value can be provided from tinuous states, discrete states, iteration variables, pa- another model. rameter values, input values, file identifiers and output: The variable value can be used by an- FMU internal status information. With newly intro- other model. The algebraic relationship to the duced (optional) functions, the internal FMU state inputs is defined in element ModelStructure. can be copied and the pointer to this copy is returned local: Local variable that is calculated from other to the environment. The FMU state copy can be set variables. It is not allowed to use the variable as current FMU state, in order to continue the simu- value in another model lation from it. This feature introduced in FMI 2.0 can be for example used: Attribute “variability” is an enumeration that de- fines the time dependency of the variable, in other For iterative co-simulation master algorithms words it defines the time instants when a variable (get the FMU state for every accepted communi- can change its value. Allowed values are: cation step; if the follow-up step is not accepted, constant: The value of the variable never chang- restart co-simulation from this FMU state). es. For nonlinear Kalman filters (get the FMU state fixed: The value of the variable is fixed after just before initialization; in every sample period, initialization. set new continuous states from the Kalman filter tunable: The value of the variable is constant algorithm based on measured values; integrate to between externally triggered events due to the next sample instant and inquire the predicted continuous states that are used in the Kalman fil- xfx() d 112 ter algorithm as basis to set new continuous x fx()3 p2 x 2 u 3 u states). dt 221 213 xfxxuuu3313123(, ,, , ) For nonlinear model predictive control (get the ygxx (,) FMU state just before initialization; in every 123 sample period, set new continuous states from an where u1 and u2 are continuous-time inputs (variabil- observer, initialize and get the FMU state after ity=”continuous”), u3 is a discrete-time input (var- initialization. From this state, perform many iability=”discrete”), and p is a fixed parameter simulations that are restarted after the initializa- (variability=”fixed”). The structure of these equa- tion with new input signals proposed by the op- tions can then be defined optionally in the following timizer). way in the XML file: Furthermore, the FMU state can be serialized and
3.6 Precise Time Event Handling
The details of precise time event handling in FMI were still under discussion before the editorial dead- line of this paper. Hence we cannot present a detailed description here. The development work is compli- cated since several aspects have to be considered: The synchronous features of Modelica 3.3 [2] should be supported. In multi-body system terminology, this is called a FMI should also be useable by tools that do not “force element”. Typically, FMU 1 would be a com- support synchronous time event handling. plicated device, e.g., a controlled electrical motor The time event handling is to be defined in a with a gearbox, but the essential part is the force el- way that allows backward compatible exten- ement at the interface. The inputs to FMU 1 are the sions. angle phi and the angular velocity w of the end point of the spring/damper system. The output would be 3.7 Improved Unit Definitions the torque generated by the spring/damper. It is cal- culated with the simple equation The unit definitions have been improved in FMI 2.0: torque = c*(phi - inertia.phi) + The tool-specific unit-name can optionally be ex- d*(w – inertia.w) pressed as function of the 7 SI base units and the SI where c is the spring and d is the damper constant. derived unit “rad”. It is then possible to check units This FMU is then connected to a multi-body sys- when FMUs are connected together (without stand- tem FMU, for example a robot, and drives a revolute ardizing unit names as needed in FMI 1.0), or to joint. The FMU 2 provides phi and w as output convert variable values that are provided in different (from the relative joint coordinates) and gets the units (for the same physical quantity). In the specifi- torque as input. caiton it is sketched how to utilize this information for connection checks, dimensional checks, or unit The XML-file of FMU 1 has the following structure: propagation. The trick is to treat the derived unit
In this section two examples are shown that demon-
4.1 FMU as Force Element
Project Leader Torsten Blochwitz (ITI GmbH Dresden, Germany) Steering Committee Atego, Daimler, Dassault Systèmes, IFP EN, ITI, LMS, Modelon, QTronic, SIMPACK Advisory Board Armines, DLR, Fraunhofer (IIS/EAS, First, SCAI), Open Modelica Consortium, TWT, University of Halle Guests Altair Engineering, Berkeley University, Bosch, ETAS, Siemens, Equa Simula- tion
The Steering Committee is open for additional members that actively support FMI. Requirements: Must have (a) participated at least at two FMI meetings in the last 24 months, (b) must either provided the FMI standard or part of it in a commercial or open source tool, and/or must actively use FMI in industrial projects, (c) the Steering Committee members agree with qualified majority. The Advisory Committee is open for additional members that proofed to actively support FMI. Require- ments: Must have (a) participated at least at two FMI meetings in the last 24 months, and (b) the Steering Committee members agree with qualified majority.
Contributors to the FMI 2.0 Specification: The following persons participated at FMI 2.0 design meetings and contributed to the discussion (alphabeti- cal list): Martin Arnold, University Halle, Germany Johan Akesson, Modelon, Sweden Mongi Ben-Gaid, IFP, France Torsten Blochwitz, ITI GmbH Dresden, Germany Christoph Clauss, Fraunhofer IIS EAS, Germany Alex Eichberger, SIMPACK AG, Germany Hilding Elmqvist, Dassault Systèmes AB, Sweden Markus Friedrich, SIMPACK AG, Germany Peter Fritzson, PELAB, Sweden Andreas Junghanns, QTronic, Germany Petter Lindholm, Modelon, Sweden Kristin Majetta, Fraunhofer IIS EAS, Germany Sven Erik Mattsson, Dassault Systèmes AB, Sweden Jakob Mauss, QTronic, Germany Dietmar Neumerkel, Daimler AG, Germany Peter Nilsson, Dassault Systèmes AB, Sweden Hans Olsson, Dassault Systèmes AB, Sweden Martin Otter, DLR-RM, Germany Bernd Relovsky, Daimler AG, Germany Tom Schierz, University Halle, Germany Bernhard Thiele, DLR-RM, Germany Antoine Viel, LMS International, Belgium The following people contributed with comments (alphabetical list): Peter Aaronsson, MathCore, Sweden Bernhard Bachmann, University of Bielefeld, Germany Iakov Nakhimovski, Modelon, Sweden