Skip to content
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

Jump to bottom

Describe that fmi2reset can be called in case of fmi2error #1974

Draft
wants to merge 2 commits into
base: v2.0.x
Choose a base branch
from
Draft

Describe that fmi2reset can be called in case of fmi2error #1974

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0c26ce
describe that fmi2reset can be called
chrbertsch Sep 10, 2024
0d501ec
Fix capitalization
t-sommer Sep 10, 2024
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
3 changes: 2 additions & 1 deletion docs/2_1_common_api.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,11 +291,12 @@ mode (`loggingOn = fmi2True`).
Otherwise, `logger` should not show a message.

- `fmi2Error` - the FMU encountered an error.
The simulation cannot be continued with this FMU instance.
The simulation cannot be continued.
If one of the functions returns `fmi2Error`,
it can be tried to restart the simulation from a formerly stored FMU state by calling `fmi2SetFMUstate`.
This can be done if the capability flag `canGetAndSetFMUstate` is true and
`fmi2GetFMUstate` was called before in non-erroneous state.
It is also possible to reset the FMU by calling `fmi2Reset`.
footnote:[Typically, `fmi2Error` return is for non-numerical reasons, like "disk full".
There might be cases where the environment can fix such errors (eventually with the help oft the user),
and then simulation can continue at the last consistent state defined with `fmi2SetFMUstate`.] +
Expand Down