From c8d6116a2479ab49c9bbdb07a68ef18ce0076703 Mon Sep 17 00:00:00 2001 From: Klaus Schuch Date: Wed, 15 May 2024 14:32:49 +0200 Subject: [PATCH] Clarify the information flow of clocks --- docs/2_2_common_mechanisms.adoc | 10 ++++++++-- docs/2_4_common_schema.adoc | 7 +++++-- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/2_2_common_mechanisms.adoc b/docs/2_2_common_mechanisms.adoc index 83e6f5236..68782daaf 100644 --- a/docs/2_2_common_mechanisms.adoc +++ b/docs/2_2_common_mechanisms.adoc @@ -284,7 +284,9 @@ All variables are listed in <> as elements of `>. -The attribute <> defines the direction of the information flow with respect to the FMU (e.g. <>, <>, <>). +The attribute <> defines the direction of the information flow with respect to the FMU (e.g. <>, <>, <>). + +For Clocks the <> indicates the information flow of the activation of the Clock. + +Only for triggered Clocks, the <> also indicates the information flow of the timing. Variables, except Clocks, may be scalar or multi-dimensional arrays. Clocks must always be scalar. @@ -536,7 +538,11 @@ Input Clock:: is a variable of type Clock with <> = <>. In Model Exchange and Co-Simulation, when input Clocks tick, the importer will activate the input Clocks using <>. In Scheduled Execution, when input Clocks tick, the importer will activate the associated model partitions (but not the input Clocks) using <>. -While the importer is the source of the actual Clock activations, the timing of the Clocks is defined by the FMU, either through the <> or calling <>, or by another Clock connected to a <> input Clock. + +The importer is the source of the actual Clock activations of input Clocks. +For time-based input Clocks, the timing is defined by the FMU, either through the <> or by the importer calling <>. +For <> input clocks, the timing is determined by the importer. +_[The timing could be given by a triggered output Clock, or a time-based input Clock of a connected FMU, or any other source.]_ Output Clock:: [[outputClock, `output Clock`]] diff --git a/docs/2_4_common_schema.adoc b/docs/2_4_common_schema.adoc index b90791d3a..ae64126e5 100644 --- a/docs/2_4_common_schema.adoc +++ b/docs/2_4_common_schema.adoc @@ -965,8 +965,11 @@ If a <> is referenced in <> is <>. + -A continuous-time <> or an event indicator must have <> = <> or <>, see also <>. + -The causality of variables of type <> must be either <>, <> or <>. +A continuous-time <> or an event indicator must have <> = <> or <>, see also <>. + +The causality of variables of type <> must be either <>, <> or <>. + +For Clocks the <> indicates the information flow of the activation of the Clock. + +Only for triggered Clocks, the <> also indicates the information flow of the timing. |`variability` |