FMU
|
Page in progress. |
Imports models created in other environments into Engee using FMI.
Description
Block FMU imports models created in other environments into Engee using the Functional Mock-up Interface (FMI).
The unit supports FMI version 2.0 for collaborative modelling (`Co-Simulation' mode).
To use this block, you must have an existing Functional Mock-up Unit (FMU) exported from another tool or written in C language.
The initial values of the parameters defined in the FMU can be set in the field Parameters.
The input and output ports are configured in the parameters Inputs names, Outputs names и Internal variables.
The input and output ports support numeric and string data types.
By default, the block has one output port Out1.
Ports
Output
#
Out1
—
output port
none | string size limited to 255
Details
Output port.
| Data types |
|
| Complex numbers support |
No |
Parameters
Main
# FMU name — FMU name
Details
Specify the name of the FMU file with or without an extension. This parameter is case sensitive. The FMU must exist in the Engee path.
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
Yes |
#
Enable FMU tolerance —
switch on the FMU tolerance
Logical
Details
Select this check box to allow the FMU to set the error value. Otherwise, clear this check box.
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
No |
#
Relative tolerance —
relative error value
Real number
Details
FMU relative error value (%) as a scalar.
Dependencies
To use this parameter, select the check box. Enable FMU tolerance.
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
Yes |
#
Parameters —
parameters
String
Details
Parameters defined in the FMU.
It is sufficient to specify only those parameters whose initial values are to be changed.
Example: g=>>-5.5 e=>5.
If the parameter name is specified incorrectly, an error will be generated with a message about available parameter names.
If there is no need to change the values by default, the string is left blank.
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
Yes |
#
Inputs names —
input ports
String
Details
Specify the names of the available input ports to be used, separated by a space.
Example: In_1 In_2.
If the port name is specified incorrectly, an error will be generated with a message about available port names.
If the model has no input ports or there is no need to use them, the value for Inputs names is not filled in.
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
Yes |
#
Outputs names —
output ports
String
Details
Specify, separated by a space, the names of the available output ports to be used.
Example: Out_1 Out_2.
If the port name is specified incorrectly, an error will be generated with a message about available port names.
If the model has no output ports or there is no need to use them, the value for Outputs names is not filled in.
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
Yes |
#
Internal variables —
internal variables
String
Details
Specify the names of available internal variables whose values you want to output, separated by a space.
Example: Var_1 Var_2.
If the variable name is specified incorrectly, an error will be generated with a message about available variable names.
If the model has no internal variables or there is no need to use them, the value for the Internal variables is not filled in.
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
Yes |
#
Communication Step Size —
step size between time intervals of joint modelling
SampleTime (real number / vector of two real numbers)
Details
Communication step size. Specify the step size between simulation time intervals for the block.
In most cases, set a positive value to prevent unexpected behaviour. To inherit the sampling time from the driving block or model solver, set this parameters to -1.
The block supports only a periodic discrete calculation step with no offset (e.g. positive scalar).
| Default value |
|
| Program usage name |
|
| Tunable |
No |
| Evaluatable |
Yes |