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

You must also update thorns IOHDF5Util and IOUtil now.

This thorn will be moved from AlphaThorns to CactusPUGHIO now.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusPUGHIO/IOHDF5/trunk@127 4825ed28-b72c-4eae-9704-e50c059e567d

1 files changed, 43 insertions, 46 deletions

diff --git a/param.ccl b/param.ccl
index e3defd0..2829d21 100644
--- a/param.ccl
+++ b/param.ccl
@@ -1,4 +1,5 @@
 # Parameter definitions for thorn IOHDF5
+# $Header$
 
 #############################################################################
 ### declare IOHDF5 parameters
@@ -10,32 +11,54 @@ private:
 ########################
 INT out_every "How often to do IOHDF5 output, overrides IO::out_every" STEERABLE = ALWAYS
 {
-  -1:* :: "Values <= 0 disable IOHDF5 output"
+   1:* :: "Every so many iterations"
+   0:  :: "Disable IOHDF5 output"
+  -1:  :: "Default to IO::out_every"
 } -1
-INT outHDF5_every "How often to do IOHDF5 output, overrides IO::out_every" STEERABLE = ALWAYS
+INT outHDF5_every "How often to do IOHDF5 output, overrides IO::out_every (DEPRECATED IN BETA13)" STEERABLE = ALWAYS
 {
-  -1:* :: "Values <= 0 disable IOHDF5 output"
+   1:* :: "Every so many iterations"
+   0:  :: "Disable IOHDF5 output"
+  -1:  :: "Default to IO::out_every"
+} -1
+INT out3D_every "How often to do IOHDF5 output, overrides IO::out_every (DEPRECATED IN BETA13)" STEERABLE = ALWAYS
+{
+   1:* :: "Every so many iterations"
+   0:  :: "Disable IOHDF5 output"
+  -1:  :: "Default to IO::out_every"
 } -1
 
 ####################
 # Output directories
 ####################
-STRING outdir "Name of IOHDF5 output directory, overrides IO::outdir"
+STRING out_dir "Output directory for IOHDF5 files, overrides IO::outdir" STEERABLE = RECOVER
 {
-  .* :: A regex which matches everything
-} "."
-STRING outdir_HDF5 "DEPRICATED: Name of IOHDF5 output directory, overrides IO::outdir"
+  ".+" :: "A valid directory name"
+  "^$" :: "An empty string to choose the default from IO::out_dir"
+} ""
+STRING outdir_HDF5 "Output directory for IOHDF5 files, overrides IO::outdir (DEPRECATED IN BETA13)" STEERABLE = RECOVER
+{
+  ".+" :: "A valid directory name"
+  "^$" :: "An empty string to choose the default from IO::out_dir"
+} ""
+STRING outdir3D "Output directory for IOHDF5 files, overrides IO::outdir (DEPRECATED IN BETA13)" STEERABLE = RECOVER
 {
-  .* :: A regex which matches everything
+  ".+" :: "A valid directory name"
+  "^$" :: "An empty string to choose the default from IO::out_dir"
 } "."
 
-
 #####################
 # Variables to output
 #####################
 STRING out_vars "Variables to output in HDF5 file format" STEERABLE = ALWAYS
 {
-  .* :: A regex which matches everything
+  ".+" :: "Space-separated list of fully qualified variable/group names"
+  "^$" :: "An empty string to output nothing"
+} ""
+STRING out3D_vars "Variables to output in 3D HDF5 file format (DEPRECATED IN BETA13)" STEERABLE = ALWAYS
+{
+  ".+" :: "Space-separated list of fully qualified variable/group names"
+  "^$" :: "An empty string to output nothing"
 } ""
 
 
@@ -55,46 +78,20 @@ BOOLEAN checkpoint_next "Checkpoint at next iteration" STEERABLE = ALWAYS
 #############################################################################
 shares: IO
 
-####################
-# Output directories
-####################
-# FIXME: need USES AS
-#USES STRING outdir 
-
-
-########################
-# How often to do output
-########################
-# FIXME: need USES AS
-#USES INT out_every 
-
+# FIXME: want USES STRING out_dir AS default_out_dir
+# FIXME: want USES INT out_every AS default_out_every
 
-################
-# various things
-################
-USES BOOLEAN verbose 
-USES BOOLEAN newverbose 
+USES KEYWORD verbose 
 USES BOOLEAN print_timing_info 
-USES BOOLEAN out3D_parameters 
 
-#######################
-# Specific to 3D output
-#######################
-USES KEYWORD out3D_mode 
-USES BOOLEAN out3D_septimefiles 
+USES KEYWORD out_mode 
+USES KEYWORD out_save_parameters 
+USES INT     out_timesteps_per_file 
 
-###################################
-# Checkpointing/recovery parameters
-###################################
+USES INT     checkpoint_every 
+USES INT     checkpoint_keep 
 USES BOOLEAN checkpoint_ID 
-USES BOOLEAN checkpoint_keep_all 
-USES KEYWORD recover 
 USES BOOLEAN recover_and_remove 
-USES INT checkpoint_every 
 USES BOOLEAN checkpoint_on_terminate 
-USES INT checkpoint_keep 
-USES STRING checkpoint_file 
-USES STRING checkpoint_ID_file 
-USES STRING recover_file 
-USES STRING checkpoint_dir 
-USES STRING recovery_dir 
+USES KEYWORD recover 
+USES STRING  recover_file