The hopefully final renaming of the FlexIO thorn.

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

1 files changed, 160 insertions, 0 deletions

diff --git a/param.ccl b/param.ccl
new file mode 100644
index 0000000..b9f6d66
--- /dev/null
+++ b/param.ccl
@@ -0,0 +1,160 @@
+# Parameter definitions for thorn IOFlexIO
+
+
+#############################################################################
+### declare IOFlexIO parameters
+#############################################################################
+private:
+
+##########################
+# What variables to output
+##########################
+STRING output2D "Variables to output in 2D FlexIO file format"
+{
+  :: "default is to output nothing"
+} ""
+STRING output3D "Variables to output in 3D FlexIO file format"
+{
+  :: "default is to output nothing"
+} ""
+################
+# Various things
+################
+LOGICAL checkpoint_FlexIO "Do checkpointing with IOFlexIO"
+{
+} "no"
+LOGICAL reuse_fh "Reuse file handles by closing files after each write operation."
+{
+} "no"
+
+
+#############################################################################
+### import IOUtil parameters
+#############################################################################
+friend: IO
+
+####################
+# Output directories
+####################
+EXTEND STRING IO_outdir "Name of IO output directory"
+{
+} "."
+EXTEND STRING IO_outdir2D "Name of IO 2D output directory, overrides IO_outdir"
+{
+} "IO_outdir"
+EXTEND STRING IO_outdir3D "Name of IO 3D output directory, overrides IO_outdir"
+{
+} "IO_outdir"
+
+
+########################
+# How often to do output
+########################
+EXTEND INTEGER IO_every "How often to do IO output"
+{
+  -1:* ::
+} -1
+EXTEND INTEGER IO_2Devery "How often to do 2D output, overrides IO_every"
+{
+  -1:* ::		
+} -1
+EXTEND INTEGER IO_3Devery "How often to do 3D output, overrides IO_every"
+{
+  -1:* ::
+} -1
+
+
+################
+# various things
+################
+EXTEND LOGICAL IO_verbose "Give extended screen output in IO?"
+{
+} "no"
+EXTEND LOGICAL IO_datestamp "Write date as attribute to IO 3D output file?"
+{
+} "yes"
+EXTEND LOGICAL IO_parameters "Write parameters to IO 3D output file?"
+{
+} "yes"
+EXTEND LOGICAL IO_structures "Write structures to IO 3D output file?"
+{
+} "yes"
+
+
+#######################
+# Specific to 3D output
+#######################
+EXTEND KEYWORD iomode "Which mode for 3D IO"
+{
+  "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 ioproc_every"
+  "onefile" :: "all output is written into a single file by processor 0"
+} "proc"
+
+EXTEND INTEGER ioproc_every "Do IO on every N processors."
+{
+  1:*       :: "Must be a positive integer"
+} 8
+EXTEND LOGICAL onefileperslice "Write one file per time slice, as opposed to all data in one file"
+{
+} "no"
+EXTEND LOGICAL unchunked "Don't write data in chunks."
+{
+} "no"
+
+
+##############################################
+# Downsampling parameters (only for 3D output)
+##############################################
+EXTEND INTEGER downsample_x "Factor by which to downsample output in x direction. Point (0,0,0) is always included."
+{
+  1:*       :: "Must be a positive integer"
+} 1
+EXTEND INTEGER downsample_y "Factor by which to downsample output in y direction. Point (0,0,0) is always included."
+{
+  1:*       :: "Must be a positive integer"
+} 1
+EXTEND INTEGER downsample_z "Factor by which to downsample output in z direction. Point (0,0,0) is always included."
+{
+  1:*       :: "Must be a positive integer"
+} 1
+EXTEND LOGICAL out_single "Output 3D data in single precision ? This parameter is ignored for Cactus compiled with SINGLE_PRECISION."
+{
+} "no"
+
+
+###################################
+# Checkpointing/recovery parameters
+###################################
+EXTEND LOGICAL checkpoint_ID "Checkpoint initial data ?"
+{
+} "no"
+EXTEND LOGICAL checkpoint_keep_all "Keep all checkpoint files ?"
+{
+} "no"
+EXTEND LOGICAL recover "Recover from a checkpoint file ?"
+{
+} "no"
+EXTEND INTEGER checkpoint_every "Checkpoint every x iterations"
+{
+  -1:* :: "negative values disable checkpointing"
+} -1
+EXTEND INTEGER checkpoint_keep "How many checkpoint files to keep"
+{
+  1:* :: "1 overwrites the latest checkpoint file"
+} 1
+EXTEND STRING checkpoint_file "File name for regular checkpoint"
+{
+} "checkpoint"
+EXTEND STRING checkpoint_ID_file "File name for initial data checkpoint"
+{
+} "checkpointID"
+EXTEND STRING recover_file "File name of recovery file"
+{
+} "checkpoint"
+EXTEND STRING checkpoint_dir "Output directory for checkpoint files"
+{
+} "."
+EXTEND STRING recovery_dir "Directory to look for the recovery file"
+{
+} "."