diff --git a/docs/4_2_co-simulation_api.adoc b/docs/4_2_co-simulation_api.adoc index 9caefe390..9bf84aeb2 100644 --- a/docs/4_2_co-simulation_api.adoc +++ b/docs/4_2_co-simulation_api.adoc @@ -103,7 +103,7 @@ _Both arguments <> and <> allo _[The FMU can use this flag to flush a result buffer.]_ * [[eventHandlingNeeded,`eventHandlingNeeded`]] <> indicates that an event was encountered by the FMU at <> and the importer has to enter <> by calling <>. -<> must not be signaled, if the importer indicates to not support <> by <>. +<> must not be signalled, if the importer indicates to not support <> by <>. _[This is different from <> which only indicates that the <> did not complete the intended step up until <> + <> and does not require event handling.]_ * [[terminateSimulationDS,`terminateSimulation`]] When <>, the FMU requests to stop the simulation and the importer must call <>. @@ -115,6 +115,10 @@ Reasons for <> are ** expressed by the return arguments <> or <> of <>, or ** the FMU's reaction to the importers request for <> by the return argument <> of <>, or ** the FMU's request for a communication point at <> for any other reason. ++ +<> must not be used to signal that the requested step was not completed due to an error _[(e.g. integrator encountered division by zero)]_. +Instead, the function must return with an error code (<> or <>). +Alternatively, the function can return with <>, if the FMU is in the same state as before the call, i.e. the output argument values are undefined, but the computation may continue. * [[lastSuccessfulTime,`lastSuccessfulTime`]] `lastSuccessfulTime` represents the internal time latexmath:[t_{i+1}] of the FMU when <> returns, for any value of <>. It is possible that the <> is equal to <> when <> to indicate, for example, the detection of an event at <>.