You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/0___preamble.adoc
-5Lines changed: 0 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,6 @@ The https://fmi-standard.org/[Functional Mock-up Interface (FMI)] is a free stan
2
2
[[MAP,MAP]]It is supported by https://fmi-standard.org/tools/[more than 230 tools] and maintained as a https://www.modelica.org/association/[Modelica Association Project] (MAP FMI).
3
3
https://github.com/modelica/fmi-standard/releases[Releases] and https://github.com/modelica/fmi-standard/issues[issues] can be found on https://github.com/modelica/fmi-standard[github.com/modelica/fmi-standard].
4
4
5
-
{empty} +
6
-
{empty}
7
-
8
5
Copyright (C) 2008-2011 MODELISAR Consortium and 2012-2025 The Modelica Association Project FMI.
9
6
10
7
This document is licensed under the Attribution-ShareAlike 4.0 International license.
@@ -14,5 +11,3 @@ The licenses text can be found in the https://raw.githubusercontent.com/modelica
14
11
Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights.
15
12
Modelica Association shall not be held responsible for identifying such patent rights.
16
13
All contributors to this specification have signed the https://github.com/modelica/fmi-standard.org/blob/main/static/assets/FMI_CCLA_v1.0_2016_06_21.pdf[Corporate Contributor License Agreement of the FMI Project] or the https://github.com/modelica/ModelicaAssociationCLA/releases/download/1.1.1/ModelicaAssociationCLA_1.1.1.pdf[Contributor License Agreement of the Modelica Association].
<<table-overview-features>> gives a non-normative overview of the features of the different interface types.
137
137
@@ -336,7 +336,9 @@ Contrary to the standard, the FMI Implementer's Guide will be a living document,
336
336
337
337
Conventions used in this document:
338
338
339
-
* Non-normative text is given in square brackets in italic font: _[Especially examples are defined in this style.]_
339
+
* Non-normative text is given in a gray box like this one:
340
+
+
341
+
NOTE: Especially examples are defined in this style.
340
342
341
343
* The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in https://tools.ietf.org/html/rfc2119[RFC 2119] (regardless of formatting and capitalization).
Copy file name to clipboardExpand all lines: docs/2_1_common_math.adoc
+22-9Lines changed: 22 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -66,8 +66,11 @@ latexmath:[t_{\mathit{Imax}}] is the largest occurring integer index of super-de
66
66
a|previous value
67
67
|====
68
68
69
-
_[Assume that an FMU has an event at latexmath:[t_R=2.1s] and here a variable changes discontinuously._
70
-
_If no event iteration occurs, the time instant when the event occurs is defined as (2.1, 0), and the time instant when the integration is restarted is defined as (2.1, 1).]_
69
+
[NOTE]
70
+
====
71
+
Assume that an FMU has an event at latexmath:[t_R=2.1s] and here a variable changes discontinuously.
72
+
If no event iteration occurs, the time instant when the event occurs is defined as (2.1, 0), and the time instant when the integration is restarted is defined as (2.1, 1).
73
+
====
71
74
72
75
The hybrid differential equations exposed by FMI for Model Exchange or wrapped by FMI for Co-Simulation are described as piecewise continuous-time systems.
73
76
Discontinuities can occur at time instants latexmath:[t_0, t_1, \ldots, t_n] where latexmath:[t_i < t_{i+1}].
@@ -112,15 +115,19 @@ These variables are continuous-time variables.
112
115
113
116
|`attribute = value`
114
117
|A set of variables which have an XML attribute-value combination as defined.
115
-
_[Example:_ latexmath:[\mathbf{v}_{\mathit{initial=exact}}] _are variables defined with attribute <<initial>> = <<exact>> (see <<ModelVariables>>).]_
118
+
119
+
[NOTE]
120
+
====
121
+
Example: latexmath:[\mathbf{v}_{\mathit{initial=exact}}] are variables defined with attribute <<initial>> = <<exact>> (see <<ModelVariables>>).
122
+
====
116
123
117
124
|====
118
125
119
126
At every event instant latexmath:[t_i], continuous-time variables might change discontinuously (see <<figure-piecewise-continuous-variables>>):
120
127
121
128
.Piecewise-continuous variables of an FMU: continuous-time (latexmath:[\mathbf{v}_c]), discrete-time (latexmath:[\mathbf{v}_d]) and clocked (latexmath:[\mathbf{v}_k]).
The mathematical description of an FMU uses the following variables, where bold variables (e.g. latexmath:[\mathbf{v}]) indicate vectors and italic variables (e.g. latexmath:[t]) denote scalars:
126
133
@@ -132,7 +139,11 @@ The mathematical description of an FMU uses the following variables, where bold
This variable is defined with <<causality>> = <<independent>>.
137
148
All other variables are functions of this independent variable.
138
149
@@ -190,13 +201,15 @@ latexmath:[{}^{\bullet}\mathbf{x}_d] is the value of latexmath:[\mathbf{x}_d] at
190
201
Every event removes automatically a previous definition of latexmath:[T_{\mathit{next}}], and it must be explicitly defined again, even if a previously defined latexmath:[T_{\mathit{next}}] was not yet reached (see <<fmi3UpdateDiscreteStates>>).
When entering <<ContinuousTimeMode>> all relations reported via the event indicators latexmath:[\mathbf{z}] are fixed and during this mode these relations are replaced by latexmath:[^{\bullet}\mathbf{r}].
195
206
Only during <<InitializationMode>> or <<EventMode>> the domains latexmath:[\mathbf{z}_j > 0] can change.
196
-
_[For more details, see <<frozen-relations,Remark 3>> below.]_
207
+
208
+
NOTE: For more details, see <<frozen-relations,Remark 3>> below.
197
209
198
210
|[[buffers,buffers]] latexmath:[\mathbf{b}]
199
-
|Hidden data of the FMU.
200
-
_[For example, delay buffers in Model Exchange FMUs that are used in <<ContinuousTimeMode>>]_.
211
+
a|Hidden data of the FMU.
212
+
213
+
NOTE: For example, delay buffers in Model Exchange FMUs that are used in <<ContinuousTimeMode>>.
0 commit comments