11-09 06:45 阅读 122

FMI2.0 ———— 接口与文件

本文是来自于FMI2.0规范的前两章的部分译文，基于机翻与个人理解修订而成；描述了FMI模型交换和联合仿真，还包括了程序接口以及模型描述文件两部分。

一、FMI程序接口

模型交换

支持该功能是为了在建模环境中可以生成动态系统模型的C代码，该模型可以被其他建模和仿真环境使用。通过代数、离散方程和具有时间，状态和阶跃事件的离散方程来描述模型。如果C代码描述了一个连续的系统，那么该系统将由使用它的环境的集成商来解决。该接口要处理的模型可以很大，可以在离线或在线仿真中使用，也可以在微处理器的嵌入式控制系统中使用。设计该接口是旨在描述大型模型。

联合仿真

支持该功能的意图是提供一个接口标准，用于在联合仿真环境中与其它仿真工具协同工作。子系统之间的数据交换仅限于离散的通信点（通讯时间）；在两个通信点之外的时间中，子系统由各自的求解器彼此独立地求解。主算法控制子系统之间的数据交换以及所有模拟求解器（从属）的同步。

FMI通用概念

这两个接口标准有很多共同点。我们可以利用模型以及联合仿真工具的多个实例单独或协同的将它们连接在一起。这些接口独立于目标环境，因为没有使用依赖于目标环境的头文件（目标平台的数据类型除外）。这允许生成一个可在同一平台上的任何环境中使用的动态链接库。

模型、联合仿真从属/工具的关联部分被存储在一个称为FMU（功能模拟单元）的zip文件中，包含以下内容：

XML包含FMU中所有公开变量的定义以及其他静态信息。这样就可以在没有此信息的情况下在目标系统上运行FMU
提供了所需的模型方程式或联合仿真工具的访问权限，并提供了一小组易于使用的C函数。与其他方法相比，一种新的缓存技术可以更有效地评估模型方程；同一平台的FMU zip文件中可以包含不同平台的二进制格式
可以直接在FMU中提供模型方程式或联合仿真工具，或与外部工具通信的功能模块。
包含模型图标（位图文件）、FMU所需的文档文件、地图和表格

FMU包含文件如下：

XML 用于描述模型
DLL 运行库
其它用户所需资源

FMU模型的数据流：

数据类型为 Real, Integer, Boolean, String
inputs
outputs
对外暴露的变量

头文件和函数命名

提供了几个头文件，它们定义了FMU的接口。在所有头文件中，均约定所有相关的C函数和类型定义均使用前缀“fmi2”开头

“fmi2TypesPlatform.h“：包含函数的输入和输出参数的类型定义，FMU和目标模拟器都必须使用此头文件。
“fmi2FunctionTypes.h“：包含FMU所有函数原型的 typedef 定义
“fmi2Functions.h“；包含FMU的函数原型，这些原型可以在仿真环境中访问

定义这几个接口的目的是支持FMU的文本表示和二进制表示，并且可执行文件中可能同时存在多个FMU（例如FMU A可以使用FMU B）。所以不同的fmu中函数名应当不一致，避免同时使用时冲突。

5.1 类型平台

“fmi2TypesPlatform.h”：包含类型平台的所有定义，用于唯一地标识用于编译二进制文件的头文件，相关源码如下：

#ifndef fmi2TypesPlatform_h #define fmi2TypesPlatform_h #define fmi2TypesPlatform "default"    typedef void*           fmi2Component;               /* 该数据结构包含处理模型方程式或处理各个从站的联合仿真所需的信息 */    typedef void*           fmi2ComponentEnvironment;    /* 可以在仿真环境和记录器功能之间传输来自modelDescription.xml文件 */    typedef void*           fmi2FMUstate;                /* 保存实际或先前时刻的内部FMU状态*/    typedef unsigned int    fmi2ValueReference; /* 模型变量值的句柄，句柄和基类型（例如fmi2Real）唯一地标识变量的值*/    typedef double          fmi2Real   ;    typedef int             fmi2Integer;    typedef int             fmi2Boolean;    typedef char            fmi2Char;    typedef const fmi2Char* fmi2String;    typedef char            fmi2Byte; #define fmi2True  1 #define fmi2False 0 #endif 复制代码

这个接口用于定义FMI中支持的所有数据类型。

5.2 函数返回值

文件中定义了“状态”标识（在文件“ fmi2FunctionTypes.h”中定义的fmi2Status类型的枚举），所有函数均返回该标志以指示函数调用成功：

 typedef enum{ fmi2OK, fmi2Warning,  fmi2Discard,  fmi2Error,  fmi2Fatal,  fmi2Pending } fmi2Status; 复制代码

这个接口用于定义FMI中函数的返回值类型。

5.3 fmu函数库

部分源码如下：

。。。 #define fmi2GetTypesPlatform         fmi2FullName(fmi2GetTypesPlatform) #define fmi2GetVersion               fmi2FullName(fmi2GetVersion) #define fmi2SetDebugLogging          fmi2FullName(fmi2SetDebugLogging) #define fmi2Instantiate              fmi2FullName(fmi2Instantiate) #define fmi2FreeInstance             fmi2FullName(fmi2FreeInstance) #define fmi2SetupExperiment          fmi2FullName(fmi2SetupExperiment) #define fmi2EnterInitializationMode  fmi2FullName(fmi2EnterInitializationMode) #define fmi2ExitInitializationMode   fmi2FullName(fmi2ExitInitializationMode) 。。。 复制代码

这个接口用于定义FMI中使用的函数。

初始化，终止和重置FMU

fmi2SetupExperiment函数会在fmi2Instantiate被调用之后和fmi2EnterInitializationMode被调用之前调用，参数公差定义和公差取决于FMU类型

fmi2Status fmi2SetupExperiment (fmi2Component c, fmi2Boolean   toleranceDefined, fmi2Real      tolerance,  fmi2Real      startTime, fmi2Boolean   stopTimeDefined,  fmi2Real    stopTime); 复制代码

fmuType = fmi2ModelExchange: 如果“ toleranceDefined = fmi2True”，则使用数值积分方案调用模型，其中通过使用“ tolerance”控制误差来控制步长（通常使用相对公差） fmuType = fmi2CoSimulation：如果“toleranceDefined = fmi2True”，通信间隔由估计误差控制；如果从站具有可变步长和估计误差的积分，那么通过公差来控制通信间隔

参数 startTime 和 stopTime 可用于检查模型在给定范围内是否有效，或分配存储结果所需的内存。如果当前时间超过 stopTime，则FMU必须返回fmi2Status = fmi2Error。如果stopTimeDefined = fmi2False，则没有定义自变量的最终值，并且参数stopTime没有意义。

二、FMI模型架构（ModelDescription）

与FMU相关的所有静态信息都以XML格式存储在文本文件 modelDescription.xml 中(FMU变量及其属性如名称，单位，默认初始值等都存储在此文件中)；使用模式文件“ fmiModelDescription.xsd”定义此XML文件的结构。该架构文件使用了以下辅助架构文件：

fmi2Unit.xsd
fmi2Type.xsd
fmi2Annotation.xsd
fmi2ScalarVariable.xsd
fmi2AttributeGroups.xsd
fmi2VariableDependency.xsd

该架构所需的数据类型（例如：xs：normalizedString）在XML架构标准中定义，类型的定义如下：

 xs:double 表示 double xs:int 表示  int xs:unsignedInt 表示   unsigned int xs:boolean 表示  char xs:string 表示  char* xs:normalizedString 表示  char* xs:dateTime tool 表示  specific 复制代码

XML文件的第一行（如modelDescription.xml）必须包含XML文件的编码方案,要求编码方案始终为UTF8，需要如下定义：

 <?xml version="1.0" encoding="UTF-8"?> 复制代码

以下是根级别的架构文件，包含架构文件中的所有元素，而数据由这些元素的属性定义：

fmiModelDescription（fmi模型描述）

定义如下：

标签结构如下：

fmiModelDescription

ModelExchange：如果存在，则FMU基于“用于模型交换的FMI”（换句话说，FMU包含模型或与提供模型的工具进行通信，而环境提供模拟引擎）。
CoSimulation：如果存在，则FMU基于“用于联合仿真的FMI”（换句话说，FMU包括模型和仿真引擎，或者与提供模型和仿真引擎的工具进行通信，该环境提供了主算法来运行耦合的FMU联合仿真从设备以共同运行)。
UnitDefinitions：定义单位和显示单位的全局列表（例如，将显示单位转换为模型方程式中使用的单位）。这些定义在XML元素“ ModelVariables”中使用
TypeDefinitions：“ ModelVariables”中使用的类型定义列表
LogCategories：日志类别的全局列表，可以设置该列表以定义FMU支持的日志信息
DefaultExperiment：提供积分的默认设置，例如停止时间和相对公差
VendorAnnotations：供应商可能想要存储而其他供应商可能会忽略的其他数据
ModelVariables：定义了FMU的所有变量
ModelStructure：定义模型的结构，包括输出，连续时间状态和初始未知数
fmiVersion（必需）：FMI规范版本
modelName（必需）：生成XML的模型名称
guid（必需）：全球唯一标识
description：模型简短描述
author：模型作者的名称和组织
version：模型版本
generationTool：生成XMLfile的工具
generationDateAndTime：生成XML文件的日期和时间（格式为“YYYY-MM-DDThh:mm:ssZ”，Z表示Zulu 时区）
variableNamingConvention：该约束定义了如何构造 ScalarVariable的名称（flat表示唯一的非空字符串；structured表示使用”.“作为分隔符，名称由“_”、字母和数字组成，也可以由单撇号括起来的任何字符组成）
numberOfEventIndicators：基于FMI 模型交换的事件指标的（固定）数量，联合仿真下可以忽略
属性
子标签

UnitDefinitions （变量单位）

变量的单位是（可选）自定义的，单位的支持对于技术系统很重要，因为很容易发生错误。