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.

Sign up for GitHub

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

Jump to bottom

Clarify intermediate update #1886

Merged
merged 5 commits into from
Jun 9, 2023
Merged

Clarify intermediate update #1886

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c9573be
Update 2_4_common_schema.adoc
chrbertsch Jun 6, 2023
28314f4
Update 2_3_common_states.adoc
chrbertsch Jun 6, 2023
629ed44
Update 2_4_common_schema.adoc
chrbertsch Jun 6, 2023
bca08d5
One sentence per line
andreas-junghanns Jun 7, 2023
afd33f3
Add reference
chrbertsch Jun 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/2_3_common_states.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ Only in this case, <<fmi3DoStep>> may return with <<earlyReturn,`earlyReturn = f
This set may be empty (<<nRequiredIntermediateVariables>> = 0) when the simulation algorithm does not intend to use intermediate update.
Only the variables in <<requiredIntermediateVariables>> may be accessed by the simulation algorithm using <<get-and-set-variable-values,`fmi3Set{VariableType}`>> and <<get-and-set-variable-values,`fmi3Get{VariableType}`>> during <<IntermediateUpdateMode>>.
All variables referenced in this set must be marked with the attribute <<intermediateUpdate,`intermediateUpdate = "true"`>> in <<modelDescription.xml>>.
For Co-Simulation, these intermediate variables must be continuous-time variables.

* [[nRequiredIntermediateVariables,`nRequiredIntermediateVariables`]] `nRequiredIntermediateVariables` gives the number of entries in <<requiredIntermediateVariables>>.
If <<nRequiredIntermediateVariables>> is zero <<requiredIntermediateVariables>> is not defined.
Expand Down
7 changes: 4 additions & 3 deletions docs/2_4_common_schema.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1026,11 +1026,12 @@ _Therefore, such an <<input>> should not appear in an algebraic loop.]_
|
[[intermediateUpdate,`intermediateUpdate`]]
If this boolean attribute is `true`, the variable can be accessed in <<IntermediateUpdateMode>>.
Variables with <<causality>> = <<parameter>> must not be marked with <<intermediateUpdate,`intermediateUpdate = true`>>.
Only continuous-time variables can have <<intermediateUpdate,`intermediateUpdate = true`>>.
The default value of this attribute is `false`.

This attribute is ignored in Model Exchange and Scheduled Execution.
Variables of type <<Clock>> must not have the <<intermediateUpdate>> attribute.
The default value of this attribute is `false`.

This attribute is ignored in Model Exchange and Scheduled Execution.

|`previous`
a|
Expand Down