Skip to content

Commit

Permalink
Clarify issues 1558 (#1559)
Browse files Browse the repository at this point in the history
I use admin-privs to merge to overrule Karl´s pending change request that I have addressed and was approved by TorstenB.
  • Loading branch information
andreas-junghanns committed Nov 9, 2021
1 parent d620f94 commit 924d9ce
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 8 deletions.
28 changes: 25 additions & 3 deletions docs/2_3_common_states.adoc
Expand Up @@ -397,14 +397,20 @@ Function <<fmi3GetEventIndicators>>::
See <<fmi3GetEventIndicators>>.

Function <<fmi3GetShiftDecimal>>::
See <<fmi3GetShift>>.

Function <<fmi3GetShiftFraction>>::
See <<fmi3GetShift>>.

Function <<fmi3GetIntervalDecimal>>::
See <<fmi3GetInterval>>.

Function <<fmi3GetIntervalFraction>>::
See <<fmi3GetInterval>>.

Function <<fmi3SetIntervalDecimal>>::
One of these functions must be called for all <<fixed-periodic-clock,Fixed periodic Clocks>>.

Function <<fmi3SetIntervalFraction>>::
One of these functions must be called for all <<fixed-periodic-clock,Fixed periodic Clocks>>.

Expand Down Expand Up @@ -572,13 +578,19 @@ See <<fmi3GetAdjointDerivative>>.

Function <<fmi3GetContinuousStates>>::
This function must be called if <<fmi3UpdateDiscreteStates>> returned with <<valuesOfContinuousStatesChanged, `valuesOfContinuousStatesChanged == fmi3True`>>.
Can only be called in Model Exchange.
Not allowed in Co-Simulation and Scheduled Execution.

Function <<fmi3GetContinuousStateDerivatives>>::
Not allowed in Co-Simulation and Scheduled Execution.

Function <<fmi3GetEventIndicators>>::
Not allowed in Co-Simulation and Scheduled Execution.

Function <<fmi3GetNumberOfContinuousStates>>::
Not allowed in Co-Simulation and Scheduled Execution.

Function <<fmi3GetNumberOfEventIndicators>>::
Can only be called in Model Exchange.
Not allowed in Co-Simulation and Scheduled Execution.

Function <<fmi3EvaluateDiscreteStates>>::
This function is called to trigger the evaluation of latexmath:[\mathbf{f}_{\mathit{disc}}] to compute the current values of discrete states from previous values.
Expand Down Expand Up @@ -880,12 +892,22 @@ Getting variables might trigger <<selectiv-computation,computations>>.
_[If <<Terminated>> is entered because of an `fmi3Error` return value, retrieved values should only be used for debugging purposes.]_

Function <<fmi3GetContinuousStateDerivatives>>::
Not allowed in Co-Simulation and Scheduled Execution.

Function <<fmi3GetContinuousStates>>::
Not allowed in Co-Simulation and Scheduled Execution.

Function <<fmi3GetNominalsOfContinuousStates>>::
Not allowed in Co-Simulation and Scheduled Execution.

Function <<fmi3GetEventIndicators>>::
Not allowed in Co-Simulation and Scheduled Execution.

Function <<fmi3GetDirectionalDerivative>>::
No restrictions.

Function <<fmi3GetAdjointDerivative>>::
No restrictions.

Function <<fmi3GetOutputDerivatives>>::
Not allowed in Model Exchange.
Not allowed in Model Exchange and Scheduled Execution.
8 changes: 3 additions & 5 deletions docs/2_4_common_schema.adoc
Expand Up @@ -1378,8 +1378,7 @@ Initial or guess value of variable.
This value is also stored in the C functions.
_[Therefore, calling_ <<get-and-set-variable-values,`fmi3Set{VariableType}`>> _to set <<start>> values is only necessary, if a different value as stored in the XML file is desired._
_It is not allowed to change the start values in the <<modelDescription.xml>> file of an FMU, as this would break the consistency with the hard-coded start values in the C-Code._
_This could lead to unpredictable behavior of the FMU in different importing tools, as it is not mandatory to call <<get-and-set-variable-values,`fmi3Set{VariableType}`>> to set start values during initialization._
_Instead it is recommended to use the SSP Standard (https://ssp-standard.org/) to handle modified parameters of FMUs or different parameter sets.]_
_This could lead to unpredictable behavior of the FMU in different importing tools, as it is not mandatory to call <<get-and-set-variable-values,`fmi3Set{VariableType}`>> to set start values during initialization.]_

The <<start>> is either a single value or a list of values.
The serialization of a multi-dimensional array variable is described in <<serialization-of_variables>>.
Expand Down Expand Up @@ -1428,8 +1427,7 @@ All variables listed in this element must have attribute `derivative` (in order

|`reinit`
|[[reinit,`reinit`]]
Only for Model Exchange (if only a Co-Simulation FMU, this attribute must not be present.
If both Model Exchange and a Co-Simulation FMU, this attribute is ignored for co-simulation): +
Only used in Model Exchange, ignored for the other interface types.
Can only be present for a continuous-time <<state>>. +
If `true`, <<state>> can be reinitialized at an event by the FMU. +
If `false`, <<state>> will not be reinitialized at an event by the FMU.
Expand Down Expand Up @@ -1750,7 +1748,7 @@ _The ordering of the variables in this list is defined by the exporting tool.]_

For Co-Simulation, elements <<EventIndicator>> are ignored.

_[If an FMU supports both Model Exchange and Co-Simulation, then the <<EventIndicator>> elements might be present, since it is needed for Model Exchange.]_
_[If an FMU supports more than Model Exchange, then the <<EventIndicator>> elements might be present, since it is needed for Model Exchange, but will be ignored for Co-Simulation and Scheduled Execution.]_
|====

Elements <<Output>>, <<ContinuousStateDerivative>>, <<ClockedState>>, <<InitialUnknown>>, and <<EventIndicator>> have (partially) the following attributes:
Expand Down

0 comments on commit 924d9ce

Please sign in to comment.