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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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: 3 additions & 0 deletions docs/1___overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

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.

To synchronize events between the importer and across FMUs, <<Clock, Clocks>> should be used that are available in all interface types.]_
Copy link
Contributor

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."


==== Feature Overview of the Interface Types

Co-Simulation FMUs contain all code necessary to abstract away the details of their internal computations.
Expand Down