aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authortradke <tradke@4825ed28-b72c-4eae-9704-e50c059e567d>2001-12-28 21:41:15 +0000
committertradke <tradke@4825ed28-b72c-4eae-9704-e50c059e567d>2001-12-28 21:41:15 +0000
commit1c626d9a839b6ec9a0c07b12cf5ff1205b6c270b (patch)
tree91eff3dc0a397ac37895a7a0f467879c34ad5664 /doc
parent8a6b1bab6403eb67ccb68492506087ed9a211b57 (diff)
Added utility program. See ThornGuide for details.
git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGHIO/IOHDF5/trunk@77 4825ed28-b72c-4eae-9704-e50c059e567d
Diffstat (limited to 'doc')
-rw-r--r--doc/documentation.tex24
1 files changed, 19 insertions, 5 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex
index 9f24b8d..cb6b806 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -38,10 +38,10 @@ You obtain output by either
Data is written into files named {\tt "<varname>.h5"}.
Such datafiles can be used for further postprocessing (eg. visualization)
-or fed back into Cactus via the filereader capabilities of thorn IOUtil.\\[3ex]
+or fed back into Cactus via the filereader capabilities of thorn IOUtil.
-{\bf Parallel File I/O}\\
+\subsection{Parallel File I/O}
According to the ouptput mode parameter settings ({\tt IO::out3D\_mode,
IO::out3D\_unchunked, IO::out3D\_procs}) of thorn IOUtil, thorn IOHDF5
@@ -71,10 +71,10 @@ To build the recombiner just do a
in the Cactus toplevel directory. The recombiner executable {\tt
hdf5\_recombiner} will be placed in the {\tt exe/<configuration>/}
-subdirectory.\\[3ex]
+subdirectory.
-{\bf Checkpointing \& Recovery}\\
+\subsection{Checkpointing \& Recovery}
Thorn IOHDF5 can also be used for creating HDF5 checkpoint files and recovering
from such files later on.\\
@@ -94,7 +94,7 @@ to this thorn's documentation).
\section{Comments}
-{\bf Importing external data into Cactus with IOHDF5}\\
+\subsection{Importing external data into Cactus with IOHDF5}
In order to import external data into Cactus (eg. to initialize some variable)
you first need to convert this data into an HDF5 datafile which then can be
@@ -159,6 +159,20 @@ It will also dump the contents of the 3D dataset. Since it only contains zeros
it would probably not make much sense to feed this datafile into Cactus for
initializing your x coordinate grid function :-)
%
+%
+\subsection{Other utility programs in IOFlexIO}
+%
+In addition to the HDF5 recombiner program, thorn IOHDF5 also provides
+some other utilities which can be build the same way:
+%
+\begin{itemize}
+ \item {\tt hdf5\_convert\_from\_ieeeio.c}\\
+ Converts a datafile created by thorn IOFlexIO into an HDF5 datafile.
+\end{itemize}
+%
+If any of these utility programs is called without arguments it will print
+a usage message.
+%
% Automatically created from the ccl files
% Do not worry for now.
\include{interface}