Parameter names changes as announced in today's mail to users@cactuscode.org.

You must also update thorn IOUtil now.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGHIO/IOFlexIO/trunk@241 ebee0441-1374-4afa-a3b5-247f3ba15b9a

1 files changed, 18 insertions, 18 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
index defad82..e0f91c5 100644
--- a/doc/documentation.tex
+++ b/doc/documentation.tex
@@ -7,12 +7,12 @@
 \date{1998-1999}
 \maketitle
 
-\abstract{Thorn IOFlexIO provides I/O methods to output variables in IEEEIO
+\abstract{Thorn {\bf IOFlexIO} provides I/O methods to output variables in IEEEIO
 file format. It also implements checkpointing/recovery functionality.}
 %
 \section{Purpose}
 %
-Thorn IOFlexIO uses John Shalf's FlexIO library (see {\tt
+Thorn {\bf IOFlexIO} uses John Shalf's FlexIO library (see {\tt
 http://bach.ncsa.uiuc.edu/FlexIO/} for details) to output any type of grid
 variables (grid scalars, grid functions, and arrays of arbitrary dimension)
 in the IEEEIO file format.\\
@@ -20,32 +20,32 @@ in the IEEEIO file format.\\
 The thorn registers two I/O methods with the flesh's I/O interface at startup:
 %
 \begin{itemize}
-  \item method {\tt IOFlexIO\_3D} outputs all types of grid variables with
+  \item method {\tt IOFlexIOD} outputs all types of grid variables with
     arbitrary dimensions
   \item method {\tt IOFlexIO\_2D} outputs two-dimensional slices (xy-, xz-,
     and yz-slice) of three-dimensional grid functions and arrays
 \end{itemize}
 
-Data is written into files named {\tt "<varname>.ieee"} (for method {\tt IOFlexIO\_3D}) and {\tt "<varname>\_2d\_<plane>.ieee"} (for method {\tt IOFlexIO\_2D}).
+Data is written into files named {\tt "<varname>.ieee"} (for method {\tt IOFlexIO}) and {\tt "<varname>\_2d\_<plane>.ieee"} (for method {\tt IOFlexIO\_2D}).
 Such datafiles can be used for further postprocessing (eg. visualization)
 or fed back into Cactus via the filereader capabilities of thorn IOUtil.\\[3ex]
 
 
 \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 IOFlexIO
+According to the ouptput mode parameter settings ({\tt IO::out\_mode,
+IO::out\_unchunked, IO::out\_proc\_every}) of thorn {\bf IOUtil}, thorn {\bf IOFlexIO}
 will output distributed data either
 \begin{itemize}
   \item in serial into a single unchunked file
 \begin{verbatim}
-  IO::out3D_mode      = "onefile"
-  IO::out3D_unchunked = "yes"
+  IO::out_mode      = "onefile"
+  IO::out_unchunked = "yes"
 \end{verbatim}
   \item in parallel, that is, into separate files containing chunks of the
         individual processors' patches of the distributed array
 \begin{verbatim}
-  IO::out3D_mode      = "proc | np"
+  IO::out_mode      = "proc | np"
 \end{verbatim}
 \end{itemize}
 The default is to output data in parallel, in order to get maximum I/O
@@ -97,14 +97,14 @@ the current working directory:
 
 \subsection{Checkpointing \& Recovery}
 
-Thorn IOFlexIO can also be used for creating IEEEIO checkpoint files and
+Thorn {\bf IOFlexIO} can also be used for creating IEEEIO checkpoint files and
 recovering from such files later on.\\
 
 Checkpoint routines are scheduled at several timebins so that you can save
 the current state of your simulation atfer the initial data phase,
 during evolution, or at termination.
 A recovery routine is registered with thorn IOUtil in order to restart
-a new simulation from a given IOFlexIO checkpoint.
+a new simulation from a given {\bf IOFlexIO} checkpoint.
 The very same recovery mechanism is used to implement a filereader
 functionality to feed back data into Cactus.\\
 
@@ -115,14 +115,14 @@ to this thorn's documentation).
 
 \section{Comments}
 
-\subsection{Importing external data into Cactus with IOFlexIO}
+\subsection{Importing external data into Cactus with {\bf IOFlexIO}}
 
 In order to import external data into Cactus (eg. to initialize some variable)
 you first need to convert this data into an IEEEIO datafile which then can be
-processed by the registered recovery routine of thorn IOFlexIO.\\
+processed by the registered recovery routine of thorn {\bf IOFlexIO}.\\
 
 The following description explains the IEEEIO file layout of an unchunked
-datafile which thorn IOFlexIO expects in order to restore Cactus variables
+datafile which thorn {\bf IOFlexIO} expects in order to restore Cactus variables
 from it properly. There is also a well-documented example C program provided
 ({\tt IOFlexIO/doc/CreateIOFlexIOdatafile.c}) which illustrates how to create
 a datafile with IEEEIO file layout. This working example can be used as a
@@ -133,7 +133,7 @@ template for building your own data converter program.\\
 
   \item The type of your data as well as its dimensions are already
         inherited by a dataset itself as metainformation. But this is not
-        enough for IOFlexIO to savely match it against a specific Cactus
+        enough for {\bf IOFlexIO} to savely match it against a specific Cactus
         variable.
         For that reason, the variable's name, its groupname, its grouptype, the
         timelevel to restore, and the
@@ -173,15 +173,15 @@ 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}
+\subsection{Other utility programs in {\bf IOFlexIO}}
 %
-In addition to the IEEEIO recombiner program, thorn IOFlexIO also provides
+In addition to the IEEEIO recombiner program, thorn {\bf IOFlexIO} also provides
 some other utilities which can be build the same way:
 %
 \begin{itemize}
   \item {\tt ieee\_merge.c}\\
     Merges the contents of its input files into a single output file.\\
-    This might be useful for IOFlexIO datafile created by different runs.
+    This might be useful for {\bf IOFlexIO} datafile created by different runs.
   \item {\tt ieee\_extract.c}\\
     Extracts a hyperslab from all datasets of the input file.\\
     You can select a hyperslab by specifying an origin and an extent (eg.