Code cleanup before moving into production mode.

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

1 files changed, 116 insertions, 90 deletions

diff --git a/src/Startup.c b/src/Startup.c
index 710e35c..9fe875c 100644
--- a/src/Startup.c
+++ b/src/Startup.c
@@ -2,9 +2,9 @@
    @file      Startup.c
    @date      Fri Oct 6 2000
    @author    Thomas Radke
-   @desc 
+   @desc
               Startup and termination routines for IOHDF5Util.
-   @enddesc 
+   @enddesc
    @version   $Id$
 @@*/
 
@@ -20,25 +20,32 @@
 static const char *rcsid = "$Id$";
 CCTK_FILEVERSION(BetaThorns_IOHDF5Util_Startup_c)
 
-/* prototypes of routines defined in this source file */
+
+/********************************************************************
+ ********************    External Routines   ************************
+ ********************************************************************/
 void IOHDF5Util_Startup (void);
-void IOHDF5Util_Terminate (cGH *GH);
-static void *IOHDF5Util_SetupGH (tFleshConfig *config,
-                                 int convergence_level,
-                                 cGH *GH);
+void IOHDF5Util_Terminate (const cGH *GH);
 
 
- /*@@
-   @routine   IOHDF5Util_Startup
-   @date      Fri Oct 6 2000
-   @author    Thomas Radke
-   @desc 
-              The startup registration routine for IOHDF5Util.
-              Registers the GH extensions needed for IOHDF5Util
-              and the routine to set it up.
-   @enddesc 
+/********************************************************************
+ ********************    Internal Routines   ************************
+ ********************************************************************/
+static void *IOHDF5Util_SetupGH (tFleshConfig *config, int conv_level, cGH *GH);
+
 
-   @calls     CCTK_RegisterGHExtensionSetupGH
+ /*@@
+   @routine    IOHDF5Util_Startup
+   @date       Fri Oct 6 2000
+   @author     Thomas Radke
+   @desc
+               The startup registration routine for IOHDF5Util.
+               Registers the GH extensions needed for IOHDF5Util
+               and the routine to set it up.
+   @enddesc
+
+   @calls      CCTK_RegisterGHExtension
+               CCTK_RegisterGHExtensionSetupGH
 @@*/
 void IOHDF5Util_Startup (void)
 {
@@ -62,20 +69,21 @@ void IOHDF5Util_Startup (void)
 
 
  /*@@
-   @routine   IOHDF5Util_Terminate
-   @date      Fri Oct 6 2000
-   @author    Thomas Radke
-   @desc 
-              The termination registration routine for IOHDF5Util.
-              It frees any resources kept on the GH extensions.
-   @enddesc 
+   @routine    IOHDF5Util_Terminate
+   @date       Fri Oct 6 2000
+   @author     Thomas Radke
+   @desc
+               The termination registration routine for IOHDF5Util.
+               It frees any resources kept on the GH extensions.
+   @enddesc
+
    @var        GH
-   @vdesc      Pointer to CCTK GH
-   @vtype      cGH *
+   @vdesc      Pointer to CCTK grid hierarchy
+   @vtype      const cGH *
    @vio        in
    @endvar
 @@*/
-void IOHDF5Util_Terminate (cGH *GH)
+void IOHDF5Util_Terminate (const cGH *GH)
 {
   ioHDF5UtilGH *myGH;
 
@@ -86,117 +94,135 @@ void IOHDF5Util_Terminate (cGH *GH)
     /* close the dataspaces used to write scalar and array attributes */
     if (myGH->scalar_dataspace >= 0)
     {
-      IOHDF5_ERROR (H5Sclose (myGH->scalar_dataspace));
+      HDF5_ERROR (H5Sclose (myGH->scalar_dataspace));
     }
     if (myGH->array_dataspace >= 0)
     {
-      IOHDF5_ERROR (H5Sclose (myGH->array_dataspace));
+      HDF5_ERROR (H5Sclose (myGH->array_dataspace));
     }
 
     /* close the predefined complex and string datatypes */
-    if (myGH->IOHDF5_COMPLEX >= 0)
+    if (myGH->HDF5_COMPLEX >= 0)
     {
-      IOHDF5_ERROR (H5Tclose (myGH->IOHDF5_COMPLEX));
+      HDF5_ERROR (H5Tclose (myGH->HDF5_COMPLEX));
     }
 #ifdef CCTK_REAL4
-    if (myGH->IOHDF5_COMPLEX8 >= 0)
+    if (myGH->HDF5_COMPLEX8 >= 0)
     {
-      IOHDF5_ERROR (H5Tclose (myGH->IOHDF5_COMPLEX8));
+      HDF5_ERROR (H5Tclose (myGH->HDF5_COMPLEX8));
     }
 #endif
 #ifdef CCTK_REAL8
-    if (myGH->IOHDF5_COMPLEX16 >= 0)
+    if (myGH->HDF5_COMPLEX16 >= 0)
     {
-      IOHDF5_ERROR (H5Tclose (myGH->IOHDF5_COMPLEX16));
+      HDF5_ERROR (H5Tclose (myGH->HDF5_COMPLEX16));
     }
 #endif
 #ifdef CCTK_REAL16
-    if (myGH->IOHDF5_COMPLEX32 >= 0)
+    if (myGH->HDF5_COMPLEX32 >= 0)
     {
-      IOHDF5_ERROR (H5Tclose (myGH->IOHDF5_COMPLEX32));
+      HDF5_ERROR (H5Tclose (myGH->HDF5_COMPLEX32));
     }
 #endif
-    if (myGH->IOHDF5_STRING >= 0)
+    if (myGH->HDF5_STRING >= 0)
     {
-      IOHDF5_ERROR (H5Tclose (myGH->IOHDF5_STRING));
+      HDF5_ERROR (H5Tclose (myGH->HDF5_STRING));
     }
   }
 }
 
 
-/****************************************************************************/
-/*                           local routines                                 */
-/****************************************************************************/
+/********************************************************************
+ ********************    Internal Routines   ************************
+ ********************************************************************/
  /*@@
-   @routine     IOHDF5Util_SetupGH
-   @date        Fri Oct 6 2000
-   @author      Thomas Radke
-   @desc 
-                Allocate a GH extension structure for IOHDF5Util and set it up.
-   @enddesc 
-
-   @returntype  void *
+   @routine    IOHDF5Util_SetupGH
+   @date       Fri Oct 6 2000
+   @author     Thomas Radke
+   @desc
+               Allocates and sets up IOHDF5Util's GH extension structure.
+   @enddesc
+
+   @calls      CCTK_RegisterIOMethod
+               CCTK_RegisterIOMethodOutputGH
+               CCTK_RegisterIOMethodOutputVarAs
+               CCTK_RegisterIOMethodTimeToOutput
+               CCTK_RegisterIOMethodTriggerOutput
+
+   @var        config
+   @vdesc      the CCTK configuration as provided by the flesh
+   @vtype      tFleshConfig *
+   @vio        unused
+   @endvar
+   @var        conv_level
+   @vdesc      the convergence level
+   @vtype      int
+   @vio        unused
+   @endvar
+   @var        GH
+   @vdesc      Pointer to CCTK grid hierarchy
+   @vtype      cGH *
+   @vio        unused
+   @endvar
+
+   @returntype void *
    @returndesc
-                pointer to the allocated GH extension structure
+               pointer to the allocated GH extension structure
    @endreturndesc
 @@*/
-static void *IOHDF5Util_SetupGH (tFleshConfig *config,
-                                 int convergence_level,
-                                 cGH *GH)
+static void *IOHDF5Util_SetupGH (tFleshConfig *config, int conv_level, cGH *GH)
 {
-  DECLARE_CCTK_PARAMETERS
   ioHDF5UtilGH *myGH;
+  DECLARE_CCTK_PARAMETERS
 
 
   /* suppress compiler warnings about unused variables */
-  config = config;
-  convergence_level = convergence_level;
-  GH = GH;
+  (void) (config + 0);
+  (void) (conv_level + 0);
+  (void) (GH + 0);
 
+  /* allocate the GH extension */
   myGH = (ioHDF5UtilGH *) malloc (sizeof (ioHDF5UtilGH));
 
-  /* save the original error printing routine and its argument */
-  IOHDF5_ERROR (H5Eget_auto (&myGH->print_error_fn, &myGH->print_error_fn_arg));
-
   /* predefine dataspaces for writing scalar and array attributes */
   /* the dimension of the array dataspace is set when used */
-  IOHDF5_ERROR (myGH->scalar_dataspace = H5Screate (H5S_SCALAR));
-  IOHDF5_ERROR (myGH->array_dataspace  = H5Screate (H5S_SIMPLE));
-
-  /* predefine IOHDF5_COMPLEX datatypes */
-  IOHDF5_ERROR (myGH->IOHDF5_COMPLEX =
-                H5Tcreate (H5T_COMPOUND, sizeof (CCTK_COMPLEX)));
-  IOHDF5_ERROR (H5Tinsert (myGH->IOHDF5_COMPLEX, "real",
-                           offsetof (CCTK_COMPLEX, Re), IOHDF5_REAL));
-  IOHDF5_ERROR (H5Tinsert (myGH->IOHDF5_COMPLEX, "imag",
-                           offsetof (CCTK_COMPLEX, Im), IOHDF5_REAL));
+  HDF5_ERROR (myGH->scalar_dataspace = H5Screate (H5S_SCALAR));
+  HDF5_ERROR (myGH->array_dataspace  = H5Screate (H5S_SIMPLE));
+
+  /* predefine HDF5_COMPLEX datatypes */
+  HDF5_ERROR (myGH->HDF5_COMPLEX =
+              H5Tcreate (H5T_COMPOUND, sizeof (CCTK_COMPLEX)));
+  HDF5_ERROR (H5Tinsert (myGH->HDF5_COMPLEX, "real",
+                         offsetof (CCTK_COMPLEX, Re), HDF5_REAL));
+  HDF5_ERROR (H5Tinsert (myGH->HDF5_COMPLEX, "imag",
+                         offsetof (CCTK_COMPLEX, Im), HDF5_REAL));
 #ifdef CCTK_REAL4
-  IOHDF5_ERROR (myGH->IOHDF5_COMPLEX8 =
-                H5Tcreate (H5T_COMPOUND, sizeof (CCTK_COMPLEX8)));
-  IOHDF5_ERROR (H5Tinsert (myGH->IOHDF5_COMPLEX8, "real",
-                           offsetof (CCTK_COMPLEX8, Re), IOHDF5_REAL4));
-  IOHDF5_ERROR (H5Tinsert (myGH->IOHDF5_COMPLEX8, "imag",
-                           offsetof (CCTK_COMPLEX8, Im), IOHDF5_REAL4));
+  HDF5_ERROR (myGH->HDF5_COMPLEX8 =
+              H5Tcreate (H5T_COMPOUND, sizeof (CCTK_COMPLEX8)));
+  HDF5_ERROR (H5Tinsert (myGH->HDF5_COMPLEX8, "real",
+                         offsetof (CCTK_COMPLEX8, Re), HDF5_REAL4));
+  HDF5_ERROR (H5Tinsert (myGH->HDF5_COMPLEX8, "imag",
+                         offsetof (CCTK_COMPLEX8, Im), HDF5_REAL4));
 #endif
 #ifdef CCTK_REAL8
-  IOHDF5_ERROR (myGH->IOHDF5_COMPLEX16 =
-                H5Tcreate (H5T_COMPOUND, sizeof (CCTK_COMPLEX16)));
-  IOHDF5_ERROR (H5Tinsert (myGH->IOHDF5_COMPLEX16, "real",
-                           offsetof (CCTK_COMPLEX16, Re), IOHDF5_REAL8));
-  IOHDF5_ERROR (H5Tinsert (myGH->IOHDF5_COMPLEX16, "imag",
-                           offsetof (CCTK_COMPLEX16, Im), IOHDF5_REAL8));
+  HDF5_ERROR (myGH->HDF5_COMPLEX16 =
+              H5Tcreate (H5T_COMPOUND, sizeof (CCTK_COMPLEX16)));
+  HDF5_ERROR (H5Tinsert (myGH->HDF5_COMPLEX16, "real",
+                         offsetof (CCTK_COMPLEX16, Re), HDF5_REAL8));
+  HDF5_ERROR (H5Tinsert (myGH->HDF5_COMPLEX16, "imag",
+                         offsetof (CCTK_COMPLEX16, Im), HDF5_REAL8));
 #endif
 #ifdef CCTK_REAL16
-  IOHDF5_ERROR (myGH->IOHDF5_COMPLEX32 =
-                H5Tcreate (H5T_COMPOUND, sizeof (CCTK_COMPLEX32)));
-  IOHDF5_ERROR (H5Tinsert (myGH->IOHDF5_COMPLEX32, "real",
-                           offsetof (CCTK_COMPLEX32, Re), IOHDF5_REAL16));
-  IOHDF5_ERROR (H5Tinsert (myGH->IOHDF5_COMPLEX32, "imag",
-                           offsetof (CCTK_COMPLEX32, Im), IOHDF5_REAL16));
+  HDF5_ERROR (myGH->HDF5_COMPLEX32 =
+              H5Tcreate (H5T_COMPOUND, sizeof (CCTK_COMPLEX32)));
+  HDF5_ERROR (H5Tinsert (myGH->HDF5_COMPLEX32, "real",
+                         offsetof (CCTK_COMPLEX32, Re), HDF5_REAL16));
+  HDF5_ERROR (H5Tinsert (myGH->HDF5_COMPLEX32, "imag",
+                         offsetof (CCTK_COMPLEX32, Im), HDF5_REAL16));
 #endif
 
   /* predefine a C string datatype */
-  IOHDF5_ERROR (myGH->IOHDF5_STRING = H5Tcopy (H5T_C_S1));
+  HDF5_ERROR (myGH->HDF5_STRING = H5Tcopy (H5T_C_S1));
 
   return (myGH);
 }