# Parameter definitions for thorn IOHDF5

#############################################################################
### declare IOHDF5 parameters
#############################################################################
private:

########################
# How often to do output
########################
INT outHDF5_every "How often to do HDF5 output, overrides IO::out_every" STEERABLE = ALWAYS
{
  -1:* :: "Values <= 0 disable HDF5 output"
} -1

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


#####################
# Variables to output
#####################
STRING out_vars "Variables to output in HDF5 file format" STEERABLE = ALWAYS
{
  .* :: A regex which matches everything
} ""

##############################################
# Downsampling parameters specific to IOHDF5
##############################################
# 1D 
######
STRING origin1D "Default origin for line"
{
  .* :: "Comma separated list of positive integer values"
} "-1,-1,-1"
STRING downsampling1D "Default downsampling"
{
  .* :: "Comma separated list of positive integer values"
} "1,1,1"
STRING length1D "Default length of the 1D hyperslab"
{
  .* :: "Comma separated list of integer values"
} "-1,-1,-1"   

######
# 2D 
######
STRING origin2D "Default origin 2D"
{
  .* :: "Comma separated list of positive integer values"
} "-1,-1,-1"
STRING downsampling2D "Default downsampling 2D"
{
  .* :: "Comma separated list of positive integer values"
} "1,1,1"
STRING length2D "Default length 2D"
{
  .* :: "Comma separated list of integer values"
} "-1,-1,-1" 

######
# 3D 
######
STRING origin3D "Default origin 3D"
{
  .* :: "Comma separated list of positive integer values"
} "0,0,0"
STRING downsampling3D "Default downsampling 3D"
{
  .* :: "Comma separated list of positive integer values"
} "1,1,1"
STRING length3D "Default length of the 3D hyperslab"
{
  .* :: "Comma separated list of integer values 3D"
} "-1,-1,-1"

######
# 4D 
######
STRING origin4D "Default origin"
{
  .* :: "Comma separated list of positive integer values"
} "0,0,0"
STRING downsampling4D "Default downsampling"
{
  .* :: "Comma separated list of positive integer values"
} "1,1,1"
STRING length4D "Default length of the hyperslab to stream"
{
  .* :: "Comma separated list of integer values"
} "-1,-1,-1"

##########
# General 
##########
STRING origin "Default origin"
{
  .* :: "Comma separated list of positive integer values"
} "0,0,0"
STRING downsampling "Default downsampling"
{
  .* :: "Comma separated list of positive integer values"
} "1,1,1"
STRING length "Default length of the hyperslab to stream"
{
  .* :: "Comma separated list of integer values"
} "-1,-1,-1" 

#########################
# Checkpointing requested
#########################
BOOLEAN checkpoint "Do checkpointing with HDF5" STEERABLE = ALWAYS
{
} "no"
BOOLEAN checkpoint_next "Checkpoint at next iteration" STEERABLE = ALWAYS
{
} "no"


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

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


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


################
# various things
################
USES BOOLEAN verbose 
USES BOOLEAN print_timing_info 
USES BOOLEAN out3D_parameters 
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 based on IOUTIL
##############################################
USES INT out3D_downsample_x 
USES INT out3D_downsample_y 
USES INT out3D_downsample_z 

###################################
# 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