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

You must also update thorn IOUtil now.

This thorn will be moved from BetaThorns to CactusPUGHIO now.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGHIO/IOHDF5Util/trunk@64 7842ec3a-9562-4be5-9c5b-06ba18f2b668

6 files changed, 69 insertions, 52 deletions

diff --git a/doc/documentation.tex b/doc/documentation.tex
new file mode 100644
index 0000000..6a621e1
--- /dev/null
+++ b/doc/documentation.tex
@@ -0,0 +1,46 @@
+% Thorn documentation template
+\documentclass{article}
+\begin{document}
+
+\title{IOHDF5Util}
+\author{Thomas Radke}
+\date{2000\\$ $Revision$ $Date$ $}
+\maketitle
+
+\abstract{
+Thorn {\bf IOHDF5Util} provides functionality to implement HDF5 I/O in Cactus.
+}
+
+\section{Purpose}
+Thorn {\bf IOHDF5Util} provides common routines which can be used to implement
+Cactus I/O methods for input/output of Cactus variables in the HDF5 standard
+(Hierarchical Data Format Version 5).
+
+Currently, {\bf IOHDF5Util} is inherited by the {\bf IOHDF5} and
+{\bf IOStreamHDF5} I/O thorns which share its routines to implement their own
+I/O methods doing parallel HDF5 file I/O and online HDF5 data streaming.
+%
+%
+\section{Building A Cactus Configuration with {\bf IOHDF5Util}}
+%
+The Cactus distribution does not contain the HDF5 header files and library which
+is used by thorn {\bf IOHDF5Util}. So you need to configure it as an external
+software package via:
+%
+\begin{verbatim}
+  make <configuration>-config HDF5=yes
+                             [HDF5_DIR=<path to HDF5 package>]
+\end{verbatim}
+%
+The configuration script will look in some default places for an installed
+HDF5 package. If nothing is found this way you can explicitly specify it with
+the {\tt HDF5\_DIR} configure variable.
+
+%
+% Automatically created from the ccl files
+% Do not worry for now.
+\include{interface}
+\include{param}
+\include{schedule}
+
+\end{document}
diff --git a/param.ccl b/param.ccl
index 6402d83..ee2b37e 100644
--- a/param.ccl
+++ b/param.ccl
@@ -1,53 +1,24 @@
 # Parameter definitions for thorn IOHDF5Util
 # $Header$
 
-#####################
+#############################################################################
+### declare IOHDF5 parameters
+#############################################################################
+private:
+
+###################
 # Compression level
-#####################
+###################
 INT compression_level "Compression level to use for writing HDF5 data"
 {
-  0:9 :: "A value of zero disables compression"
+  0:9 :: "Higher numbers compress better, a value of zero disables compression"
 } 0
 
 
-######################
-# Hyperslab parameters
-######################
-
-# TR: temporarily commented out hyperslab parameters
-#     until parsing is fully implemented
-
-#STRING origin "Default origin"
-#{
-#  .* :: "Comma separated list of positive integer values"
-#} "0,0,0"
-#STRING downsampling "Default downsampling"
-#{
-#  .* :: "Comma separated list of positive integer values"
-#} "1,1,1"
-#STRING length "Default length of the hyperslab to stream"
-#{
-#  .* :: "Comma separated list of integer values"
-#} "-1,-1,-1"
-#STRING direction "Default direction of hyperslab to stream"
-#{
-#  .* :: "Comma separated list of positive integer values"
-#} "0,1,2"
-#
-#CCTK_INT slabdim "default dimension of slab"
-#{
-# 1:3 :: "dimension of slab (1,2,3)"
-#} 3
-
-
 #############################################################################
 ### import IOUtil parameters
 #############################################################################
 shares: IO
 
-################
-# various things
-################
-USES BOOLEAN verbose
-USES BOOLEAN out3D_parameters
+USES KEYWORD verbose
 USES KEYWORD out_fileinfo
diff --git a/src/DumpUtils.c b/src/DumpUtils.c
index 3c12431..df0a77c 100644
--- a/src/DumpUtils.c
+++ b/src/DumpUtils.c
@@ -19,8 +19,8 @@
 #include "ioHDF5UtilGH.h"
 
 /* the rcs ID and its dummy function to use it */
-static const char *rcsid = "$Id$";
-CCTK_FILEVERSION(BetaThorns_IOHDF5Util_DumpUtils_c)
+static const char *rcsid = "$Header$";
+CCTK_FILEVERSION(CactusPUGHIO_IOHDF5Util_DumpUtils_c)
 
 
 /*@@
@@ -80,7 +80,7 @@ int IOHDF5Util_DumpGH (const cGH *GH, const int *timers, hid_t file)
     IOHDF5Util_DumpGHExtensions (GH, file);
   }
 
-  if (verbose)
+  if (CCTK_Equals (verbose, "full"))
   {
     CCTK_INFO ("Dumping Grid Variables ...");
   }
@@ -133,7 +133,7 @@ int IOHDF5Util_DumpGH (const cGH *GH, const int *timers, hid_t file)
            request->timelevel < gdata.numtimelevels;
            request->timelevel++)
       {
-        if (verbose && file >= 0)
+        if (CCTK_Equals (verbose, "full") && file >= 0)
         {
           fullname = CCTK_FullName (request->vindex);
           CCTK_VInfo (CCTK_THORNSTRING, "  %s (timelevel %d)",
@@ -313,7 +313,7 @@ void IOHDF5Util_DumpParameters (const cGH *GH, int all, hid_t file)
   DECLARE_CCTK_PARAMETERS
 
 
-  if (verbose)
+  if (CCTK_Equals (verbose, "full"))
   {
     CCTK_INFO ("Dumping Parameters ...");
   }
@@ -365,7 +365,7 @@ void IOHDF5Util_DumpGHExtensions (const cGH *GH, hid_t file)
   DECLARE_CCTK_PARAMETERS
 
 
-  if (verbose)
+  if (CCTK_Equals (verbose, "full"))
   {
     CCTK_INFO ("Dumping GH extensions ...");
   }
diff --git a/src/DumpVar.c b/src/DumpVar.c
index 9a0afba..75544ce 100644
--- a/src/DumpVar.c
+++ b/src/DumpVar.c
@@ -22,7 +22,7 @@
 
 /* the rcs ID and its dummy function to use it */
 static const char *rcsid = "$Header$";
-CCTK_FILEVERSION(BetaThorns_IOHDF5Util_DumpVar_c)
+CCTK_FILEVERSION(CactusPUGHIO_IOHDF5Util_DumpVar_c)
 
 
 /********************************************************************
diff --git a/src/RecoverVar.c b/src/RecoverVar.c
index 95d9835..29f48f2 100644
--- a/src/RecoverVar.c
+++ b/src/RecoverVar.c
@@ -21,8 +21,8 @@
 #include "ioHDF5UtilGH.h"
 
 /* the rcs ID and its dummy function to use it */
-static const char *rcsid = "$Id$";
-CCTK_FILEVERSION(BetaThorns_IOHDF5Util_RecoverVar_c)
+static const char *rcsid = "$Header$";
+CCTK_FILEVERSION(CactusPUGHIO_IOHDF5Util_RecoverVar_c)
 
 
 /********************************************************************
@@ -254,7 +254,7 @@ int IOHDF5Util_RecoverParameters (const fileinfo_t *fileinfo)
 
   if (CCTK_MyProc (NULL) == 0)
   {
-    if (verbose)
+    if (CCTK_Equals (verbose, "full"))
     {
       CCTK_VInfo (CCTK_THORNSTRING, "Recovering parameters from checkpoint "
                                     "file '%s'", fileinfo->filename);
@@ -726,7 +726,7 @@ static herr_t processDataset (hid_t group, const char *datasetname, void *arg)
      check whether the user wants to have this variable restored */
   if (ioUtilGH->do_inVars && ! ioUtilGH->do_inVars[vindex])
   {
-    if (verbose)
+    if (CCTK_Equals (verbose, "full"))
     {
       fullname = CCTK_FullName (vindex);
       CCTK_VInfo (CCTK_THORNSTRING, "Ignoring variable '%s' for file reader "
@@ -736,7 +736,7 @@ static herr_t processDataset (hid_t group, const char *datasetname, void *arg)
     return (0);
   }
 
-  if (verbose)
+  if (CCTK_Equals (verbose, "full"))
   {
     fullname = CCTK_FullName (vindex);
     CCTK_VInfo (CCTK_THORNSTRING, "Restoring variable '%s' (timelevel %d)",
diff --git a/src/Startup.c b/src/Startup.c
index 9fe875c..48b5937 100644
--- a/src/Startup.c
+++ b/src/Startup.c
@@ -17,8 +17,8 @@
 
 
 /* the rcs ID and its dummy function to use it */
-static const char *rcsid = "$Id$";
-CCTK_FILEVERSION(BetaThorns_IOHDF5Util_Startup_c)
+static const char *rcsid = "$Header$";
+CCTK_FILEVERSION(CactusPUGHIO_IOHDF5Util_Startup_c)
 
 
 /********************************************************************