Example Parameter Files

Here we give examples of the parameters for the different I/O methods.

• Output information to screen using IOBasic's "Info" I/O method

    ActiveThorns = "IOBasic IOUtil PUGHReduce ..."
  
    # Output using all methods on iteration 0, 10, 20, ...
    IO::out_every = 10
  
    # Group of variables to output to screen
    IOBasic::outInfo_vars = "evolve::vars"
  

• Scalar Output from IOBasic's "Scalar" I/O method

    ActiveThorns = "IOBasic IOUtil PUGHReduce ..."
  
    # Output vars using scalar method on iteration 0, 10, 20, ...
    IOBasic::outScalar_every = 10
  
    # Group of variables to output to file
    IOBasic::outScalar_vars = "evolve::vars"
  

• ASCII 1D and 2D Output with IOASCII's "IOASCII_1D" and "IOASCII_2D" I/O methods

    ActiveThorns = "IOASCII IOUtil PUGHSlab ..."
  
    # Output vars in 1D on iteration 0, 10, 20, ...
    IOASCII::out1D_every = 10
  
    # Output vars in 2D on iteration 0, 50, 100, ...
    IOASCII::out2D_every = 50
  

• HDF5 Output with IOHDF5's "IOHDF5" I/O method

    ActiveThorns = "IOHDF5 IOUtil PUGHSlab ..."
  
    # Output vars in HDF5 format on iteration 0, 5, 10, ...
    IOHDF5::out_every = 5
  
    # Group of variables to output
    IOHDF5::out_vars = "evolve::vars"
  
    # Special I/O directory for HDF5 output
    IOHDF5::out_dir = "/scratch/tmp"
  
    # Full output unchunked to one file
    # (Only using a small number of processors)
    IO::out_mode      = "onefile"
    IO::out_unchunked = "yes"
  
    # Downsample full data by a factor of 3 in each direction
    IO::out_downsample_x = 3
    IO::out_downsample_y = 3
    IO::out_downsample_z = 3
  

• IEEEIO 2D hyperslab and full output using IOFlexIO's "IOFlexIO_2D" and "IOFlexIO" I/O methods

    ActiveThorns = "IOFlexIO FlexIO IOUtil PUGHSlab ..."
  
    # Output vars in 2D IEEEIO format on iteration 0, 100, 200, ...
    IOFlexIO::out2D_every = 100
  
    # Output vars in IEEEIO format on iteration 0, 5, 10, ...
    IOFlexIO::out_every = 5
  
    # Group of variables to output to file for each method
    IOFlexIO::out2D_vars = "evolve::vars"
    IOFlexIO::out_vars   = "evolve::vars"
  
    # 2D output goes into standard I/O directory
    IO::out_dir = "test"
  
    # Special I/O directory for full output
    IOFlexIO::out_dir = "/scratch/tmp"
  
    # Full output chunked to one file for every eight processors
    # (Run on large number of processors)
    IO::out_mode       = "np"
    IO::out_proc_every = 8
    IO::out_unchunked  = "no"
  
    # Downsample full data by a factor of 3 in each direction
    IO::out_downsample_x = 3
    IO::out_downsample_y = 3
    IO::out_downsample_z = 3
  

• Checkpointing using thorn IOFlexIO

    ActiveThorns = "IOFlexIO FlexIO IOUtil PUGHSlab ..."
  
    # Use IEEEIO data format for checkpoint files
    IOFlexIO::checkpoint = "yes"
  
    # Make a new checkpoint file every 300 iterations
    IO::checkpoint_every = 300
  
    # Name and directory of checkpoint file
    IO::checkpoint_file = "run5"
    IO::checkpoint_dir  = "/scratch/tmp"
  

• Recovering from a checkpoint file

    ActiveThorns = "IOFlexIO FlexIO IOUtil PUGHSlab ..."
  
    # automatically choose the latest checkpoint file
    IO::recover = "auto"
  
    # Name and directory of checkpoint file to recover from
    IO::recover_file = "run5"
    IO::recover_dir  = "/scratch/tmp"