# Parameter definitions for thorn IOUtil

#############################################################################
### import grid parameters
#############################################################################
shares: grid

USES KEYWORD domain ""
{
}

#############################################################################
### declare IOUtil parameters
### These are declared protected so that they can be seen by other IO thorns.
#############################################################################
restricted:

####################
# Output directories
####################
STRING outdir "Name of IO output directory"
{
  .* :: A regex which matches everything
} "."

########################
# How often to do output
########################
INT out_every "How often to do IO output"
{
  -1:* ::
} -1

################
# various things
################
BOOLEAN verbose "Give extended screen output in IO?"
{
} "no"
BOOLEAN out3D_datestamp "Write date as attribute to IO 3D output file?"
{
} "yes"
BOOLEAN out3D_parameters "Write parameters to IO 3D output file?"
{
} "yes"
BOOLEAN out3D_structures "Write structures to IO 3D output file?"
{
} "yes"


#######################
# Specific to 3D output
#######################
KEYWORD out3D_mode "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"

INT out3D_procs "Do IO on every N processors."
{
  1:*       :: "Must be a positive integer"
} 8
BOOLEAN out3D_septimefiles "Write one file per time slice, as opposed to all data in one file"
{
} "no"
BOOLEAN out3D_unchunked "Don't write data in chunks."
{
} "no"


##############################################
# 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."
{
  1:*       :: "Must be a positive integer"
} 1
INT out3D_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
INT out3D_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
BOOLEAN out3D_single "Output 3D data in single precision ? This parameter is ignored for Cactus compiled with single precision"
{
} "no"


###################################
# Checkpointing/recovery parameters
###################################
BOOLEAN checkpoint_ID "Checkpoint initial data ?"
{
} "no"
BOOLEAN checkpoint_keep_all "Keep all checkpoint files ?"
{
} "no"
BOOLEAN recover "Recover from a checkpoint file ?"
{
} "no"
INT checkpoint_every "Checkpoint every x iterations"
{
  -1:* :: "negative values disable checkpointing"
} -1
INT checkpoint_keep "How many checkpoint files to keep"
{
  1:* :: "1 overwrites the latest checkpoint file"
} 1
STRING checkpoint_file "File name for regular checkpoint"
{
  .* :: A regex which matches everything
} "checkpoint"
STRING checkpoint_ID_file "File name for initial data checkpoint"
{
  .* :: A regex which matches everything
} "checkpointID"
STRING recover_file "File name of recovery file"
{
  .* :: A regex which matches everything
} "checkpoint"
STRING checkpoint_dir "Output directory for checkpoint files"
{
  .* :: A regex which matches everything
} "."
STRING recovery_dir "Directory to look for the recovery file"
{
  .* :: A regex which matches everything
} "."