summaryrefslogtreecommitdiff
path: root/doc/UsersGuide/ApplicationThorns.tex
diff options
context:
space:
mode:
Diffstat (limited to 'doc/UsersGuide/ApplicationThorns.tex')
-rw-r--r--doc/UsersGuide/ApplicationThorns.tex15
1 files changed, 13 insertions, 2 deletions
diff --git a/doc/UsersGuide/ApplicationThorns.tex b/doc/UsersGuide/ApplicationThorns.tex
index 447a1241..55561263 100644
--- a/doc/UsersGuide/ApplicationThorns.tex
+++ b/doc/UsersGuide/ApplicationThorns.tex
@@ -520,6 +520,10 @@ the number of timelevels of each group for which storage should be activated.
This number can range from one to the maximum number of timelevels for the group, as specified in the group definition in its \texttt{interface.ccl} file. If this maximum number is one, the timelevel specification can be omitted from the
\texttt{STORAGE} statement.
+Alternatively \var{timelevels} can be the name of a parameter accessible
+to the thorn. The parameter name is the same as used in C routines of the
+thorn, fully qualified parameter names of the form
+\texttt{\var{thorn}::\var{parameter}} are not allowed.
\item[\texttt{TRIGGERS}] \texttt{TRIGGERS} is used when the routine is
registered at \texttt{ANALYSIS}. This is a special time bin; a routine
@@ -1361,7 +1365,7 @@ A usual simple specification for a schedule declaration is
\begin{alltt}schedule <\var{function name}> AT <\var{schedule bin}>
\{
LANG: <\var{language}>
- [STORAGE: <\var{group}>,<\var{group}>...]
+ [STORAGE: <\var{group}>[[\var{timelevels}]],<\var{group}>[[\var{timelevels}]]...]
\} "\var{Description of function}"
\end{alltt}
@@ -1372,7 +1376,7 @@ The full specification for a schedule declaration is
[BEFORE|AFTER <\var{item}>|(<\var{item}> <\var{item}> ...)]
\{
LANG: <\var{language}>
- [STORAGE: <\var{group}>,<\var{group}>...]
+ [STORAGE: <\var{group}>[[\var{timelevels}]],<\var{group}>[[\var{timelevels}]]...]
[TRIGGER: <\var{group}>,<\var{group}>...]
[SYNC: <\var{group}>,<\var{group}>...]
[OPTIONS: <\var{option}>,<\var{option}>...]
@@ -1494,6 +1498,13 @@ and registered as \texttt{LANG: C}.
which memory should be allocated for the duration of the routine or
schedule group. The storage status reverts to its previous status
after completion of the routine or schedule group.
+Each group must specify how many timelevels to activate storage for,
+from 1 up to the maximum number for the group as specified in the
+defining {\tt interface.ccl} file. If the maximum is 1 (the default)
+this number may be omitted. Alternatively \var{timelevels} can be the
+name of a parameter accessible to the thorn. The parameter name is the
+same as used in C routines of the thorn, fully qualified parameter names
+of the form \texttt{\var{thorn}::\var{parameter}} are not allowed.
\item[\texttt{TRIGGER}]
This is only used for items scheduled at timebin \texttt{CCTK\_ANALYSIS}.
The item will only be executed if output is due for at least one