# Parameter definitions for thorn IOFlexIO
# $Header$

#############################################################################
### declare IOFlexIO parameters
#############################################################################
private:


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


####################
# Output directories
####################
STRING out2D_dir "Output directory for 2D IOFlexIO files, overrides IO::out_dir" STEERABLE = RECOVER
{
  ".+" :: "A valid directory name"
  "^$" :: "An empty string to choose the default from IO::out_dir"
} ""
STRING out_dir "Output directory for IOFlexIO files, overrides IO::out_dir" STEERABLE = RECOVER
{
  ".+" :: "A valid directory name"
  "^$" :: "An empty string to choose the default from IO::out_dir"
} ""


##########################
# What variables to output
##########################
STRING out2D_vars "Variables to output in 2D FlexIO file format" STEERABLE = ALWAYS
{
  ".+" :: "Space-separated list of fully qualified variable/group names"
  "^$" :: "An empty string to output nothing"
} ""
STRING out_vars "Variables to output in FlexIO file format" STEERABLE = ALWAYS
{
  ".+" :: "Space-separated list of fully qualified variable/group names"
  "^$" :: "An empty string to output nothing"
} ""


################
# Various things
################
BOOLEAN checkpoint "Do checkpointing with IOFlexIO" 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

USES STRING out_dir AS io_out_dir
USES INT out_every AS io_out_every

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

USES KEYWORD verbose
USES BOOLEAN print_timing_info
USES BOOLEAN strict_io_parameter_check

USES KEYWORD out_mode
USES KEYWORD out_fileinfo
USES KEYWORD out_save_parameters
USES INT     out_timesteps_per_file

USES INT     checkpoint_every
USES INT     checkpoint_keep
USES BOOLEAN checkpoint_ID
USES BOOLEAN recover_and_remove
USES BOOLEAN checkpoint_on_terminate
USES KEYWORD recover
USES STRING  recover_file