-
Notifications
You must be signed in to change notification settings - Fork 85
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.
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
Clarify when to use Scheduled Execution #1979
Conversation
docs/1___overview.adoc
Outdated
@@ -124,6 +124,9 @@ In some ways the Scheduled Execution interface has similarities to the Model Exc | |||
[#figure-scheduled-execution-data-flow] | |||
image::images/scheduled-execution-data-flow.svg[width=40%, align="center"] | |||
|
|||
_[An external scheduler is only required if the importer needs direct control over the tasks, e.g. to avoid overruns in a real-time application. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't like the "is only required" because this is not relevant perspective. Better "An external scheduler allows to control scheduling of tasks and thus model partitions. Such an environment e.g. is required to execute real-time simulations."
If you really need to reference overruns I suggest "Only in a real-time execution overruns can occur and thus can be stressed." Actually mentioning preemption and priorities would be just as relevant to mention. So I rather suggest not to mention any since it is explained in more detail in the SE section.
docs/1___overview.adoc
Outdated
@@ -124,6 +124,9 @@ In some ways the Scheduled Execution interface has similarities to the Model Exc | |||
[#figure-scheduled-execution-data-flow] | |||
image::images/scheduled-execution-data-flow.svg[width=40%, align="center"] | |||
|
|||
_[An external scheduler is only required if the importer needs direct control over the tasks, e.g. to avoid overruns in a real-time application. | |||
To synchronize events between the importer and across FMUs, <<Clock, Clocks>> should be used that are available in all interface types.]_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
" The FMU provides model partitions defined by clocks in the FMU interface description. This way the importer can allow to configure the scheduling of each model partition, e.g. it enables to synchronize the execution across FMUs."
Specific places to link to: Section 8 generally on SE: https://modelica.github.io/fmi-guides/main/fmi-guide/#_scheduled_execution_specific_issues Section 8.1 on Use Cases for SE: https://modelica.github.io/fmi-guides/main/fmi-guide/#_use_cases_for_scheduled_execution |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was suggested in the FMI Steering Committee.
fixes #1948