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

You must update all other I/O thorns now.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOUtil/trunk@163 b32723a9-ab3a-4a60-88e2-2e5d99d7c17a

1 files changed, 174 insertions, 106 deletions

diff --git a/param.ccl b/param.ccl
index dfd4c48..65020b9 100644
--- a/param.ccl
+++ b/param.ccl
@@ -1,46 +1,50 @@
 # Parameter definitions for thorn IOUtil
+# $Header$
 
 #############################################################################
 ### declare IOUtil parameters
-### These are declared protected so that they can be seen by other IO thorns.
+### These are declared protected so that they can be seen by other I/O thorns.
 #############################################################################
 restricted:
 
 ####################
 # Output directories
 ####################
-STRING outdir "Name of IO output directory" STEERABLE = RECOVER
+STRING out_dir "Default output directory" STEERABLE = RECOVER
 {
-  .* :: "A regex which matches everything"
+  .+ :: "A valid directory name"
+} "."
+STRING outdir "Default output directory (DEPRECATED IN BETA13)" STEERABLE = RECOVER
+{
+  .+ :: "A valid directory name"
 } "."
 
 ########################
 # How often to do output
 ########################
-INT out_every "How often to do IO output" STEERABLE = ALWAYS
+INT out_every "How often to do output by default" STEERABLE = ALWAYS
 {
-  -1   :: "Never"
-   1:* :: "Every so many iterations"	
+   1:* :: "Every so many iterations"
+  -1:0 :: "Disable output"
 } -1
 
 ################
 # various things
 ################
-KEYWORD newverbose "Level of screen output for IO?" STEERABLE = ALWAYS
+KEYWORD verbose "Level of screen output for I/O" STEERABLE = ALWAYS
 {
-  "none"     :: "Give no output"
-  "standard" :: "Initial description for each method"
+  "none"     :: "No output"
+  "standard" :: "Initial description for each I/O method"
   "full"     :: "Maximal output"
+  "yes"      :: "Same as \"standard\" (DEPRECATED IN BETA13)"
+  "no"       :: "Same as \"none\" (DEPRECATED IN BETA13)"
 } "standard"
-BOOLEAN verbose "Give extended screen output in IO?" STEERABLE = ALWAYS
-{
-} "no"
-BOOLEAN print_timing_info "Print timing information on I/O operations."
+BOOLEAN print_timing_info "Print timing information on I/O operations." STEERABLE = RECOVER
 {
 } "no"
-BOOLEAN new_filename_scheme "Use the new filename scheme for output files ?"
+BOOLEAN new_filename_scheme "Use the new filename scheme for output files ?" STEERABLE = RECOVER
 {
-} "no"
+} "yes"
 KEYWORD out_fileinfo "Add some useful file information to output files ?" STEERABLE = RECOVER
 {
   "none"               :: "no file information"
@@ -52,48 +56,89 @@ KEYWORD out_fileinfo "Add some useful file information to output files ?" STEERA
 #######################
 # Specific to 3D output
 #######################
-KEYWORD out3D_mode "Which mode for 3D IO"
+KEYWORD out_mode "Which mode to use for output" STEERABLE = RECOVER
+{
+  "proc"    :: "Every processor writes its share of data into a separate file"
+  "np"      :: "Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every"
+  "onefile" :: "All output is written into a single file by processor 0"
+} "proc"
+KEYWORD out3D_mode "Which mode to use for output (DEPRECATED IN BETA13)" STEERABLE = RECOVER
 {
-  "proc"    :: "every processor writes its share of data into a separate file"
-  "np"      :: "data is collected and written by every N'th processor into a separate file, where N is specified by the parameter out3D_procs"
-  "onefile" :: "all output is written into a single file by processor 0"
+  "proc"    :: "Every processor writes its share of data into a separate file"
+  "np"      :: "Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every"
+  "onefile" :: "All output is written into a single file by processor 0"
 } "proc"
 
-INT out3D_procs "Do IO on every N processors."
+INT out_proc_every "Do output on every N processors" STEERABLE = RECOVER
 {
-  1:*       :: "Must be a positive integer"
+  1:* :: "A number between [1, nprocs)"
 } 8
-BOOLEAN out3D_septimefiles "Write one file per time slice, as opposed to all data in one file"
+INT out3D_procs "Do output on every N processors (DEPRECATED IN BETA13)" STEERABLE = RECOVER
+{
+  1:* :: "A number between [1, nprocs)"
+} 8
+INT out_timesteps_per_file "How many timesteps to write to a single file" STEERABLE = RECOVER
+{
+#   1:* :: "Number of timesteps per file"
+   1:1 :: "Number of timesteps per file (can only be 1 so far)"
+  -1:  :: "All timesteps in a single file"
+} -1
+BOOLEAN out3D_septimefiles "Write one file per time slice, as opposed to all data in one file" STEERABLE = RECOVER
+{
+} "no"
+BOOLEAN out_unchunked "Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode." STEERABLE = RECOVER
 {
 } "no"
-BOOLEAN out3D_unchunked "Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode."
+BOOLEAN out3D_unchunked "Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode. (DEPRECATED IN BETA13)" STEERABLE = RECOVER
 {
 } "no"
-KEYWORD out3D_parameters "Save current parameter settings in 3D output files ?"
+KEYWORD out_save_parameters "Save current parameter settings in output files ?" STEERABLE = RECOVER
 {
-  "all"      :: "save all parameter settings"
-  "only set" :: "only save parameters which have been set before"
-  "yes"      :: "synonym for \"only set\" (DEPRICATED)"
-  "no"       :: "don't save parameter settings"
+  "all"      :: "Save all parameter settings"
+  "only set" :: "Only save parameters which have been set before"
+  "yes"      :: "Synonym for \"only set\" (DEPRICATED)"
+  "no"       :: "Don't save parameter settings"
+} "only set"
+KEYWORD out3D_parameters "Save current parameter settings in output files ? (DEPRECATED IN BETA13)" STEERABLE = RECOVER
+{
+  "all"      :: "Save all parameter settings"
+  "only set" :: "Only save parameters which have been set before"
+  "yes"      :: "Synonym for \"only set\" (DEPRICATED)"
+  "no"       :: "Don't save parameter settings"
 } "only set"
 
 
 ##############################################
 # Downsampling parameters (only for 3D output)
 ##############################################
-INT out3D_downsample_x "Factor by which to downsample output in x direction. Point (0,0,0) is always included." STEERABLE = ALWAYS
+INT out_downsample_x "Factor by which to downsample output in x direction. Point (0,0,0) is always included." STEERABLE = ALWAYS
+{
+  1:* :: "A positive integer"
+} 1
+INT out_downsample_y "Factor by which to downsample output in y direction. Point (0,0,0) is always included." STEERABLE = ALWAYS
+{
+  1:* :: "A positive integer"
+} 1
+INT out_downsample_z "Factor by which to downsample output in z direction. Point (0,0,0) is always included." STEERABLE = ALWAYS
 {
-  1:*       :: "Must be a positive integer"
+  1:* :: "A positive integer"
 } 1
-INT out3D_downsample_y "Factor by which to downsample output in y direction. Point (0,0,0) is always included." STEERABLE = ALWAYS
+BOOLEAN out_single_precision "Output data in single precision ?" STEERABLE = RECOVER
 {
-  1:*       :: "Must be a positive integer"
+} "no"
+INT out3D_downsample_x "Factor by which to downsample output in x direction. Point (0,0,0) is always included. (DEPRECATED IN BETA13)" STEERABLE = ALWAYS
+{
+  1:* :: "A positive integer"
+} 1
+INT out3D_downsample_y "Factor by which to downsample output in y direction. Point (0,0,0) is always included. (DEPRECATED IN BETA13)" STEERABLE = ALWAYS
+{
+  1:* :: "A positive integer"
 } 1
-INT out3D_downsample_z "Factor by which to downsample output in z direction. Point (0,0,0) is always included." STEERABLE = ALWAYS
+INT out3D_downsample_z "Factor by which to downsample output in z direction. Point (0,0,0) is always included. (DEPRECATED IN BETA13)" STEERABLE = ALWAYS
 {
-  1:*       :: "Must be a positive integer"
+  1:* :: "A positive integer"
 } 1
-BOOLEAN out3D_single "Output 3D data in single precision ? This parameter is ignored for Cactus compiled with single precision"
+BOOLEAN out3D_single "Output 3D data in single precision ? This parameter is ignored for Cactus compiled with single precision (DEPRECATED IN BETA13)"
 {
 } "no"
 
@@ -104,54 +149,67 @@ BOOLEAN out3D_single "Output 3D data in single precision ? This parameter is ign
 BOOLEAN checkpoint_ID "Checkpoint initial data ?" STEERABLE = RECOVER
 {
 } "no"
-BOOLEAN checkpoint_keep_all "Keep all checkpoint files ?" STEERABLE = RECOVER
-{
-} "no"
 KEYWORD recover "Recover from a checkpoint file ?" STEERABLE = RECOVER
 {
   "no"        :: "Don't recover"
-  "manual"    :: "Recover from the checkpoint file given as <recovery_dir>/<recover_file>"
-  "auto"      :: "Automatically recover from the latest checkpoint file found in <recovery_dir>"
+  "manual"    :: "Recover from the checkpoint file given as <recover_dir>/<recover_file>"
+  "auto"      :: "Automatically recover from the latest checkpoint file found in <recover_dir>"
   "autoprobe" :: "Probe for checkpoint files and automatically recover, continue as usual if nothing was found"
 } "no"
-INT checkpoint_every "Checkpoint every x iterations" STEERABLE = ALWAYS
+INT checkpoint_every "How often to checkpoint" STEERABLE = ALWAYS
 {
-  -1:* :: "negative values disable checkpointing"
+   1:* :: "Every so many iterations"
+  -1:0 :: "Disable periodic checkpointing"
 } -1
 BOOLEAN checkpoint_on_terminate "Checkpoint after last iteration" STEERABLE = ALWAYS
 {
 } "no"
 INT checkpoint_keep "How many checkpoint files to keep" STEERABLE = RECOVER
 {
-  1:* :: "1 overwrites the latest checkpoint file"
+   1:* :: "1 overwrites the latest checkpoint file"
+  -1:  :: "Keep all checkpoint files"
 } 1
 STRING checkpoint_file "File name for regular checkpoint" STEERABLE = ALWAYS
 {
-  .* :: "A regex which matches everything"
+  ".+" :: "A valid filename"
 } "checkpoint.chkpt"
 STRING checkpoint_ID_file "File name for initial data checkpoint" STEERABLE = ALWAYS
 {
-  .* :: "A regex which matches everything"
+  ".+" :: "A valid filename"
 } "checkpointID"
-STRING recover_file "File name of recovery file" STEERABLE = ALWAYS
+STRING recover_file "Basename of recovery file" STEERABLE = ALWAYS
 {
-  .* :: "A regex which matches everything"
+  ".+" :: "A valid filename"
 } "checkpoint.chkpt"
 STRING checkpoint_dir "Output directory for checkpoint files" STEERABLE = RECOVER
 {
-  .* :: "A regex which matches everything"
+  ".+" :: "A valid directory name"
 } "."
-STRING recovery_dir "Directory to look for the recovery file" STEERABLE = RECOVER
+STRING recover_dir "Directory to look for recovery files" STEERABLE = RECOVER
 {
-  .* :: "A regex which matches everything"
+  ".+" :: "A valid directory name"
 } "."
-STRING recover_ID_files "List of files to read in as initial data" STEERABLE = RECOVER
+STRING recovery_dir "Directory to look for recovery files (DEPRECATED IN BETA13)" STEERABLE = RECOVER
 {
-  .* :: "A regex which matches everything"
+  ".+" :: "A valid directory name"
+} "."
+STRING filereader_ID_files "List of files to read in as initial data" STEERABLE = RECOVER
+{
+  ".+" :: "Space-separated list of initial data filenames"
+  "^$" :: "An empty string for not recovering initial data"
 } ""
-STRING recover_ID_vars "List of variables to read in from the given initial data files" STEERABLE = RECOVER
+STRING filereader_ID_vars "List of variables to read in from the given initial data files" STEERABLE = RECOVER
 {
-  .* :: "A regex which matches everything"
+  ".+" :: "Space-separated list of fully qualified variable/group names"
+} "all"
+STRING recover_ID_files "List of files to read in as initial data (DEPRECATED IN BETA13)" STEERABLE = RECOVER
+{
+  ".+" :: "Space-separated list of initial data filenames"
+  "^$" :: "An empty string for not recovering initial data"
+} ""
+STRING recover_ID_vars "List of variables to read in from the given initial data files (DEPRECATED IN BETA13)" STEERABLE = RECOVER
+{
+  ".+" :: "Space-separated list of fully qualified variable/group names"
 } "all"
 BOOLEAN recover_and_remove "Remove checkpoint file after successful recovery ?"  STEERABLE = RECOVER
 {
@@ -161,103 +219,113 @@ BOOLEAN recover_and_remove "Remove checkpoint file after successful recovery ?"
 ###################################
 # Parameter file writing parameters
 ###################################
-KEYWORD parfile_write "Write a parameter file to 'IO::outdir'" STEERABLE = recovery
+KEYWORD parfile_write "Write a parameter file to 'IO::outdir'" STEERABLE = RECOVER
 {
   "no"               :: "Do not write a parameter file"
   "copy"             :: "Copy the original parameter file"
   "generate"         :: "Generate a parameter file from the current settings"
 #  "verbose generate" :: "Like \"generate\" but describe all parameters in detail"
 } "copy"
-STRING parfile_name "Filename for the parameter file to be written" STEERABLE = recovery
+STRING parfile_name "Filename for the parameter file to be written" STEERABLE = RECOVER
 {
-  ".*" :: "a valid filename, or an empty string if the original parameter "   \
-          "filename should be used"
+  ".+" :: "A valid filename"
+  "^$" :: "An empty string to choose the original parameter filename"
 } ""
-INT parfile_update_every "How often to update the parameter file for steered parameters" STEERABLE = always
+INT parfile_update_every "How often to update the parameter file for steered parameters" STEERABLE = ALWAYS
 {
-  0:*:: "Update every so many iterations (zero disables updating)"
+  1:* :: "Every so many iterations"
+  0:  :: "Disable updating"
 } 0
 
 
 #######################################
 # 1D line slice center setup parameters
 #######################################
-REAL out_xline_y "y-coord for 1D lines in x-direction"
+REAL out_xline_y "y-coord for 1D lines in x-direction" STEERABLE = RECOVER
 {
-  *:* :: ""
+  *:* :: "A value between [ymin, ymax]"
 } 0.0
-REAL out_xline_z "z-coord for 1D lines in x-direction"
+REAL out_xline_z "z-coord for 1D lines in x-direction" STEERABLE = RECOVER
 {
-  *:* :: ""
+  *:* :: "A value between [zmin, zmax]"
 } 0.0
-REAL out_yline_x "x-coord for 1D lines in y-direction"
+REAL out_yline_x "x-coord for 1D lines in y-direction" STEERABLE = RECOVER
 {
-  *:* :: ""
+  *:* :: "A value between [xmin, xmax]"
 } 0.0
-REAL out_yline_z "z-coord for 1D lines in y-direction"
+REAL out_yline_z "z-coord for 1D lines in y-direction" STEERABLE = RECOVER
 {
-  *:* :: ""
-} 0.0 
-REAL out_zline_x "x-coord for 1D lines in z-direction"
+  *:* :: "A value between [zmin, zmax]"
+} 0.0
+REAL out_zline_x "x-coord for 1D lines in z-direction" STEERABLE = RECOVER
 {
-  *:* :: ""
+  *:* :: "A value between [xmin, xmax]"
 } 0.0
-REAL out_zline_y "y-coord for 1D lines in z-direction"
+REAL out_zline_y "y-coord for 1D lines in z-direction" STEERABLE = RECOVER
 {
-  *:* :: ""
+  *:* :: "A value between [ymin, ymax]"
 } 0.0
 
-INT out_xline_yi "y-index (from 0) for 1D lines in x-direction"
+INT out_xline_yi "y-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_y" STEERABLE = RECOVER
 {
-  0:* :: ""
-} 0
-INT out_xline_zi "z-index (from 0) for 1D lines in x-direction"
+   0:* :: "An index between [0, ny)"
+  -1:  :: "Default to physical coordinate IO::out_xline_y"
+} -1
+INT out_xline_zi "z-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_z" STEERABLE = RECOVER
 {
-  0:* :: ""
-} 0
-INT out_yline_xi "x-index (from 0) for 1D lines in y-direction"
+   0:* :: "An index between [0, nz)"
+  -1:  :: "Default to physical coordinate IO::out_xline_z"
+} -1
+INT out_yline_xi "x-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_x" STEERABLE = RECOVER
 {
-  0:* :: ""
-} 0
-INT out_yline_zi "z-index (from 0) for 1D lines in y-direction"
+   0:* :: "An index between [0, nx)"
+  -1:  :: "Default to physical coordinate IO::out_yline_x"
+} -1
+INT out_yline_zi "z-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_z" STEERABLE = RECOVER
 {
-  0:* :: ""
-} 0
-INT out_zline_xi "x-index (from 0) for 1D lines in z-direction"
+   0:* :: "An index between [0, nz)"
+  -1:  :: "Default to physical coordinate IO::out_yline_z"
+} -1
+INT out_zline_xi "x-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_x" STEERABLE = RECOVER
 {
-  0:* :: ""
-} 0
-INT out_zline_yi "y-index (from 0) for 1D lines in z-direction"
+   0:* :: "An index between [0, nx)"
+  -1:  :: "Default to physical coordinate IO::out_zline_x"
+} -1
+INT out_zline_yi "y-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_y" STEERABLE = RECOVER
 {
-  0:* :: ""
-} 0
+   0:* :: "An index between [0, ny)"
+  -1:  :: "Default to physical coordinate IO::out_zline_y"
+} -1
 
 
 ##################################
 # 2D plane center setup parameters
 ##################################
-REAL out_yzplane_x "x-coord for 2D planes in yz"
+REAL out_yzplane_x "x-coord for 2D planes in yz" STEERABLE = RECOVER
 {
-  *:* :: ""
+  *:* :: "A value between [xmin, xmax]"
 } 0.0
-REAL out_xzplane_y "y-coord for 2D planes in xz"
+REAL out_xzplane_y "y-coord for 2D planes in xz" STEERABLE = RECOVER
 {
-  *:* :: ""
+  *:* :: "A value between [ymin, ymax]"
 } 0.0
-REAL out_xyplane_z "z-coord for 2D planes in xy"
+REAL out_xyplane_z "z-coord for 2D planes in xy" STEERABLE = RECOVER
 {
-  *:* :: "" 
+  *:* :: "A value between [zmin, zmax]"
 } 0.0
 
-INT out_xyplane_zi "z-index (from 0) for 2D planes in xy"
+INT out_yzplane_xi "x-index (from 0) for 2D planes in yz, overrrides IO::out_yzplane_x" STEERABLE = RECOVER
 {
-  0:* :: ""
-} 0
-INT out_xzplane_yi "y-index (from 0) for 2D planes in xz"
+  0:* :: "An index between [0, nx)"
+  -1:  :: "Default to physical coordinate IO::out_yzplane_x"
+} -1
+INT out_xzplane_yi "y-index (from 0) for 2D planes in xz, overrrides IO::out_xzplane_y" STEERABLE = RECOVER
 {
-  0:* :: ""
-} 0
-INT out_yzplane_xi "x-index (from 0) for 2D planes in yz"
+  0:* :: "An index between [0, ny)"
+  -1:  :: "Default to physical coordinate IO::out_xzplane_y"
+} -1
+INT out_xyplane_zi "z-index (from 0) for 2D planes in xy, overrrides IO::out_xyplane_z" STEERABLE = RECOVER
 {
-  0:* :: ""
-} 0
+   0:* :: "An index between [0, nz)"
+  -1:  :: "Default to physical coordinate IO::out_xyplane_z"
+} -1