Skip to content

Enhance documentation on discreteStatesNeedUpdate #2184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
pmai wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Enhance documentation on discreteStatesNeedUpdate #2184

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/2_3_common_states.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -716,6 +716,14 @@ include::../headers/fmi3FunctionTypes.h[tag=UpdateDiscreteStates]

[[discreteStatesNeedUpdate,`discreteStatesNeedUpdate`]]
* When `discreteStatesNeedUpdate = fmi3True`, the importer must stay in <<EventMode>> for another event iteration, starting a new super-dense time instant.
+
[NOTE]
====
This might be needed if the FMU has transitioned during the current super-dense time instant to a new intermediate state, in order to expose the its current outputs for this state, while still having further internal transitions that might fire at the current time for the current inputs.
By forcing the importer to start a new super-dense time instant, the FMU can perform this additional transition as part of normal event iteration.
Alternatively, an FMU that does not care about exposing outputs for intermediate states can just auto-transition all internal state changes for the current input in the current super-dense time instant, and would thus only expose the final state/outputs.
In this case it would not return `discreteStatesNeedUpdate = fmi3True`.
====

[[terminateSimulationUDS,`terminateSimulation`]]
* When <<terminateSimulationUDS,`terminateSimulation = fmi3True`>>, the FMU requests to stop the simulation.
Expand Down
Loading