# Parameter definitions for thorn IOBlockIO

#############################################################################
### declare IOBlockIO parameters
#############################################################################
private:


########################
# How often to do output
########################
INT out2D_every "How often to do 2D output, overrides out_every" STEERABLE = ALWAYS
{
  -1   :: "Never"
   1:* :: "Every so many iterations"	
} -1

INT out3D_every "How often to do 3D output, overrides out_every" STEERABLE = ALWAYS
{
  -1   :: "Never"
   1:* :: "Every so many iterations"	
} -1


####################
# Output directories
####################
STRING outdir2D "Name of IO 2D output directory, overrides outdir"
{
  .* :: "A regex which matches everything"
} "." 
STRING outdir3D "Name of IO 3D output directory, overrides outdir"
{
  .* :: "A regex which matches everything"
} "."


##########################
# What variables to output
##########################
STRING out2D_vars "Variables to output in 2D BlockIO file format" STEERABLE = ALWAYS
{
  .* :: "A regex which matches everything"
} ""
STRING out3D_vars "Variables to output in 3D BlockIO file format" STEERABLE = ALWAYS
{
  .* :: "A regex which matches everything"
} ""
################
# Various things
################
BOOLEAN checkpoint "Do checkpointing with IOBlockIO" STEERABLE = ALWAYS
{
} "no"
BOOLEAN checkpoint_next "Checkpoint at next iteration" STEERABLE = ALWAYS
{
} "no"
BOOLEAN reuse_filehandles "Reuse system file handles by pausing/resuming IEEEIO files at each output request ?"
{
} "no"


############################
# Specific to 2D output
# Choosing what output to do
############################
CCTK_REAL out2D_yzplane_x "x-coord for 2D planes in yz"
{
 *:* :: ""
} 0.0
CCTK_REAL out2D_xzplane_y "y-coord for 2D planes in xz"
{
 *:* :: ""
} 0.0
CCTK_REAL out2D_xyplane_z "z-coord for 2D planes in xy"
{
 *:* :: ""
} 0.0
CCTK_INT out2D_xyplane_zi "z-index (from 0) for 2D planes in xy"
{
 -1:* :: ""
} -1
CCTK_INT out2D_xzplane_yi "y-index (from 0) for 2D planes in xz"
{
 -1:* :: ""
} -1
CCTK_INT out2D_yzplane_xi "x-index (from 0) for 2D planes in yz"
{
 -1:* :: ""
} -1



#############################################################################
### import IOUtil parameters
#############################################################################
shares: IO

####################
# Output directories
####################
USES STRING outdir 

########################
# How often to do output
########################
USES INT out_every 

###########################
# Which 2D slices to output
###########################
USES CCTK_REAL out_yzplane_x 
USES CCTK_REAL out_xzplane_y 
USES CCTK_REAL out_xyplane_z
USES CCTK_INT out_xyplane_zi
USES CCTK_INT out_xzplane_yi
USES CCTK_INT out_yzplane_xi

################
# various things
################
USES BOOLEAN verbose
USES BOOLEAN newverbose
USES BOOLEAN out3D_parameters
USES BOOLEAN print_timing_info
USES KEYWORD out_fileinfo

#######################
# Specific to 3D output
#######################
USES KEYWORD out3D_mode
USES INT out3D_procs
USES BOOLEAN out3D_septimefiles
USES BOOLEAN out3D_unchunked


##############################################
# Downsampling parameters (only for 3D output)
##############################################
USES INT out3D_downsample_x
USES INT out3D_downsample_y
USES INT out3D_downsample_z
USES BOOLEAN out3D_single

###################################
# Checkpointing/recovery parameters
###################################
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