aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/documentation.tex13
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 9095042..93f7b30 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -488,14 +488,19 @@ read from file(s) as initial data:
be separated by spaces)\\
This is useful if a datafile contains multiple variables but only some of
them should be read. Thus it is possible to recover distinguished variables
- from a full checkpoint file. Note that if the file contains several
- timesteps of the same variable only the last one is taken.
+ from a full checkpoint file.\\
+ Note that if the file contains several timesteps of the same variable only
+ the last one is taken by default. This can be changed by adding an option
+ string with the key {\tt cctk\_iteration} and an associated integer scalar
+ value to the variable name denoting the iteration number to choose, like in
+ {\tt IO::filereader\_ID\_vars = "wavetoy::phi[ cctk\_iteration = 10 ]"}.
\end{itemize}
Thorn {\bf IOUtil} also provides a filereader API which can be called
by any application thorn at any time. It gets passed the equivalent information
to the filereader parameters, plus a pointer to the underlying CCTK grid
-hierarchy:
+hierarchy. The return code denotes the total number of variables recovered by
+the filereader.
C API:
\begin{verbatim}
@@ -506,7 +511,7 @@ C API:
Fortran API:
\begin{verbatim}
- call IOUtil_RecoverVarsFromDatafiles (GH, in_files, in_vars)
+ call IOUtil_RecoverVarsFromDatafiles (result, GH, in_files, in_vars)
integer result
CCTK_POINTER GH