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

Document initial number of continuous states #1911

Merged
merged 1 commit into from
Dec 5, 2023
Merged

Document initial number of continuous states #1911

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/2_3_common_states.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,7 @@ This function can only be called in Model Exchange.
* Argument `nContinuousStates` points to the `size_t` variable that will receive the number of <<state,states>>.

+
The initial value of `nContinuousStates` is the sum of the sizes of the variables referenced by the <<ContinuousStateDerivative>> elements.
The number of <<state,continuous states>> might change if a variable representing a state has a <<Dimension>> element that references a <<structuralParameter,`structural parameter`>> (see <<ConfigurationMode>> and <<ReconfigurationMode>>).
<<fmi3GetNumberOfContinuousStates>> must be called after such <<structuralParameter,`structural parameters`>> changed.
As long as no <<structuralParameter,`structural parameters`>> changed, the number of states is given in the <<modelDescription.xml>>, alleviating the need to call this function.
Expand Down