Skip to content

Commit

Permalink
Describe that fmi2Reset can be called in case of fmi2Error (#1974)
Browse files Browse the repository at this point in the history
  • Loading branch information
chrbertsch authored Oct 16, 2024
1 parent d5fd298 commit 284c673
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/2_1_common_api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -296,8 +296,9 @@ 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 instance of 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),
There might be cases where the environment can fix such errors (eventually with the help of the user),
and then simulation can continue at the last consistent state defined with `fmi2SetFMUstate`.] +
Further processing is possible after this call;
especially other FMU instances are not affected.
Expand Down

0 comments on commit 284c673

Please sign in to comment.