# Parameter definitions for thorn IOStreamedHDF5
# $Header$

#############################################################################
### declare IOStreamedHDF5 parameters
#############################################################################
private:

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

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

INT data_port "Port to stream out the HDF5 data files" STEERABLE = RECOVER
{
  1000:32000 :: "Ports below 1000 require root access"
} 8000


###############
# Checkpointing
###############
BOOLEAN checkpoint "Do checkpointing with IOStreamedHDF5" STEERABLE = ALWAYS
{
} "no"
BOOLEAN checkpoint_next "Checkpoint at next iteration" STEERABLE = ALWAYS
{
} "no"
INT checkpoint_port "Port to stream out HDF5 checkpoint files" STEERABLE = ALWAYS
{
  1000:32000 :: "Ports below 1000 require root access"
} 8001
INT checkpoint_accept_timeout "Timeout in seconds for accepting client connections to stream checkpoint files to"
{
  0:* :: "A value of 0 means not to wait on clients at all"
} 0


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

USES INT out_every AS io_out_every

USES KEYWORD verbose
USES BOOLEAN print_timing_info
USES BOOLEAN strict_io_parameter_check

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