From 08063628c00a3b6238f29e5b985a6d998a48d3fd Mon Sep 17 00:00:00 2001
From: Thomas Radke <tradke@aei.mpg.de>
Date: Tue, 13 Sep 2005 16:26:00 +0000
Subject: CarpetIOHDF5: update thorn documentation

Document that when invoking the CarpetIOHDF5 output method via the flesh API
this must be done in level mode.
Also document how to trigger the output of the same variable at intermediate
timesteps.

darcs-hash:20050913162656-776a0-bdc0dda2138176f9aea3baee6586070455e2dbc5.gz
---
 Carpet/CarpetIOHDF5/doc/documentation.tex | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'Carpet/CarpetIOHDF5/doc/documentation.tex')

diff --git a/Carpet/CarpetIOHDF5/doc/documentation.tex b/Carpet/CarpetIOHDF5/doc/documentation.tex
index 7a2e68bb1..28176c549 100644
--- a/Carpet/CarpetIOHDF5/doc/documentation.tex
+++ b/Carpet/CarpetIOHDF5/doc/documentation.tex
@@ -168,6 +168,28 @@ chunked files; the module will determine the total number of files in the set
 automatically and read them all.
 
 
+\section{Using the flesh I/O API to produce HDF5 output}
+
+Periodic output of grid variables is usually specified via I/O parameters
+in the parameter file and then automatically triggered by the flesh scheduler
+at each iteration step after analysis. If output should also be triggered
+at a different time, one can do that from within an application thorn by
+invoking one of the {\tt CCTK\_OutputVar*()} I/O routines provided
+by the flesh I/O API (see chapter B8.2 ``IO'' in the Cactus Users Guide).
+In this case, the application thorn routine which calls {\tt CCTK\_OutputVar*()}
+must be scheduled in level mode.
+
+It should be noted here that -- due to a restriction in the naming scheme of
+objects in an HDF5 data file -- \ThisThorn\ can output a given grid variable
+with given refinement level only once per timestep. Attempts of application
+thorns to trigger the output of the same variable multiple times during an iteration
+will result in a runtime warning and have no further effect.
+If output for a variable is required also for intermediate timesteps
+this can be achieved by calling {\tt CCTK\_OutputVarAs*()} with a different
+{\tt alias} name; output for the same variable is then written into
+different HDF5 files based on the {\tt alias} argument.
+
+
 \section{Checkpointing \& Recovery and Importing Data}
 
 Thorn \ThisThorn\ can also be used to create HDF5 checkpoint files and
-- 
cgit v1.2.3

