From b0c26cef6b72e4dd3c2645c5216c8585b03e7387 Mon Sep 17 00:00:00 2001 From: Christian Bertsch Date: Tue, 10 Sep 2024 13:32:08 +0200 Subject: [PATCH 1/2] describe that fmi2reset can be called --- docs/2_1_common_api.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/2_1_common_api.adoc b/docs/2_1_common_api.adoc index 51560a98..43d8916a 100644 --- a/docs/2_1_common_api.adoc +++ b/docs/2_1_common_api.adoc @@ -291,11 +291,11 @@ 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. +`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`.] + From 0d501ec279800d1875fe6372e1c6ef6e92abfa24 Mon Sep 17 00:00:00 2001 From: Torsten Sommer Date: Tue, 10 Sep 2024 13:43:24 +0200 Subject: [PATCH 2/2] Fix capitalization --- docs/2_1_common_api.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/2_1_common_api.adoc b/docs/2_1_common_api.adoc index 43d8916a..52f5a6f9 100644 --- a/docs/2_1_common_api.adoc +++ b/docs/2_1_common_api.adoc @@ -295,7 +295,8 @@ 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`. +`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`.] +