Skip to content

Commit

Permalink
Merge pull request #2535 from HansOlsson/InheritExperiment
Browse files Browse the repository at this point in the history
Specify inheritance of experiment annotation.
Closes #2314
  • Loading branch information
HansOlsson authored Nov 29, 2023
2 parents 86ab4a4 + 331415c commit ed76f68
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions chapters/annotations.tex
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,11 @@ \section{Simulations}\label{annotations-for-simulations}\label{simulations}
The \lstinline!experiment! annotation defines the start time (\lstinline!StartTime!) in {[}s{]}, the stop time (\lstinline!StopTime!) in {[}s{]}, the suitable time resolution for the result grid (\lstinline!Interval!) in {[}s{]}, and the relative integration tolerance (\lstinline!Tolerance!) for simulation experiments to be carried out with the model or block at hand.
When \lstinline!Interval! or \lstinline!Tolerance! is not provided, the tool is responsible for applying appropriate defaults.

The experiment options are inherited, and the derived class may override individual inherited options.
\begin{nonnormative}
The inheritance makes it useful to have an \lstinline!experiment! annotation also in partial models, e.g., a template for a number of similar test cases.
\end{nonnormative}

If \lstinline!StopTime! is set in a non-partial model, it is required to be a simulation model.
Tools can allow users to override these settings without modifying the model.
\end{semantics}
Expand Down

0 comments on commit ed76f68

Please sign in to comment.