next up previous contents
Next: Notes Up: SampleIO Previous: Purpose   Contents

SampleIO Parameters

Parameters to control the SampleIO I/O method are:

  • SampleIO::out_vars
    This parameter denotes the variables to output as a space-separated list of full variable and/or group names.
  • SampleIO::point_x, SampleIO::point_y, SampleIO::point_z
    The location of the data point to output for all variables is given in index coordinates (starting from 0) on a three-dimensional computational grid.
  • SampleIO::out_every
    This parameter sets the frequency for periodic output. A positive value means to output every so many iterations. A negative value chooses the value of the general IO::out_every integer parameter to be taken. A value of zero disables SampleIO periodic output.
    The value for out_every is used for all variables by default. This can be overwritten for individual variables by appending an option string to the variable name, like in SampleIO::out_vars = "MyThorn::MyVar[out_every=2]".

All parameters are steerable, ie. they can be changed at runtime.
The code in thorn SampleIO includes the logic to check whether a parameter has been changed since the last output, and how to re-evaluate the I/O parameters.


next up previous contents
Next: Notes Up: SampleIO Previous: Purpose   Contents