Next: Interfaces
Up: IOUtil
Previous: Adding a Recovery Method
Contents
truncate_files |
Scope: private |
| BOOLEAN |
Description: Truncate existing output files from previous runs (except when recovering) ? |
|
|
|
| Default: yes |
truncate_files_after_recovering |
Scope: private |
| BOOLEAN |
Description: Truncate existing output files after recovering ? |
|
|
|
| Default: no |
abort_on_io_errors |
Scope: restricted |
| BOOLEAN |
Description: Abort on I/O errors (rather than just print a warning) ? |
|
|
|
| Default: no |
checkpoint_dir |
Scope: restricted |
| STRING |
Description: Output directory for checkpoint files |
|
Range |
|
| Default: (none) |
.+ |
A valid directory name |
|
checkpoint_every |
Scope: restricted |
| INT |
Description: How often to checkpoint |
|
Range |
|
| Default: -1 |
1:* |
Every so many iterations |
|
-1:0 |
Disable periodic checkpointing |
|
checkpoint_every_walltime_hours |
Scope: restricted |
| REAL |
Description: How often to checkpoint |
|
Range |
|
| Default: -1 |
(0:* |
After so much walltime has passed |
|
-1 |
Disable periodic walltime checkpointing |
|
checkpoint_file |
Scope: restricted |
| STRING |
Description: File name for regular checkpoint |
|
Range |
|
| Default: checkpoint.chkpt |
.+ |
A valid filename |
|
checkpoint_id |
Scope: restricted |
| BOOLEAN |
Description: Checkpoint initial data ? |
|
|
|
| Default: no |
checkpoint_id_file |
Scope: restricted |
| STRING |
Description: File name for initial data checkpoint |
|
Range |
|
| Default: checkpoint.chkpt |
.+ |
A valid filename |
|
checkpoint_keep |
Scope: restricted |
| INT |
Description: How many checkpoint files to keep |
|
Range |
|
| Default: 1 |
1:* |
1 overwrites the latest checkpoint file |
|
-1: |
Keep all checkpoint files |
|
checkpoint_on_terminate |
Scope: restricted |
| BOOLEAN |
Description: Checkpoint after last iteration |
|
|
|
| Default: no |
filereader_id_dir |
Scope: restricted |
| STRING |
Description: Directory to look for input files |
|
Range |
|
| Default: (none) |
.+ |
A valid directory name |
|
filereader_id_files |
Scope: restricted |
| STRING |
Description: List of files to read in as initial data |
|
Range |
|
| Default: (none) |
.+ |
Space-separated list of initial data filenames |
|
^$ |
An empty string for not recovering initial data |
|
filereader_id_vars |
Scope: restricted |
| STRING |
Description: List of variables to read in from the given initial data files |
|
Range |
|
| Default: all |
all |
Read all variables contained in the initial data files |
|
.+ |
Space-separated list of fully qualified variable/group names |
|
^$ |
An empty string for not recovering initial data |
|
new_filename_scheme |
Scope: restricted |
| BOOLEAN |
Description: Use the new filename scheme for output files ? |
|
|
|
| Default: yes |
out3d_septimefiles |
Scope: restricted |
| BOOLEAN |
Description: Write one file per time slice, as opposed to all data in one file |
|
|
|
| Default: no |
out_criterion |
Scope: restricted |
| KEYWORD |
Description: Criterion to select output intervals |
|
Range |
|
| Default: iteration |
never |
Never output |
|
iteration |
Output every so many iterations |
|
time |
Output every that much coordinate time |
|
out_dir |
Scope: restricted |
| STRING |
Description: Default output directory |
|
Range |
|
| Default: (none) |
.+ |
A valid directory name |
|
out_downsample_x |
Scope: restricted |
| INT |
Description: Factor by which to downsample output in x direction. Point (0,0,0) is always included. |
|
Range |
|
| Default: 1 |
1:* |
A positive integer |
|
out_downsample_y |
Scope: restricted |
| INT |
Description: Factor by which to downsample output in y direction. Point (0,0,0) is always included. |
|
Range |
|
| Default: 1 |
1:* |
A positive integer |
|
out_downsample_z |
Scope: restricted |
| INT |
Description: Factor by which to downsample output in z direction. Point (0,0,0) is always included. |
|
Range |
|
| Default: 1 |
1:* |
A positive integer |
|
out_dt |
Scope: restricted |
| REAL |
Description: How often to do output by default |
|
Range |
|
| Default: -2 |
(0:* |
In intervals of that much coordinate time |
|
|
As often as possible |
|
-1 |
Disable output |
|
-2 |
Disable output |
|
out_every |
Scope: restricted |
| INT |
Description: How often to do output by default |
|
Range |
|
| Default: -1 |
1:* |
Every so many iterations |
|
-1:0 |
Disable output |
|
out_fileinfo |
Scope: restricted |
| KEYWORD |
Description: Add some useful file information to output files ? |
|
Range |
|
| Default: all |
none |
no file information |
|
creation date |
add creation date |
|
parameter filename |
add parameter filename |
|
axis labels |
add axis labels information to output files |
|
all |
add all available file information |
|
out_mode |
Scope: restricted |
| KEYWORD |
Description: Which mode to use for output |
|
Range |
|
| Default: proc |
proc |
Every processor writes its share of data into a separate file |
|
np |
Data is collected and written by every N'th processor into a separate file, where N is specified by the parameter IO::out_proc_every |
|
onefile |
All output is written into a single file by processor 0 |
|
out_proc_every |
Scope: restricted |
| INT |
Description: Do output on every N processors |
|
Range |
|
| Default: 8 |
1:* |
A number between [1, nprocs) |
|
out_save_parameters |
Scope: restricted |
| KEYWORD |
Description: Save current parameter settings in output files ? |
|
Range |
|
| Default: only set |
all |
Save all parameter settings |
|
only set |
Only save parameters which have been set before |
|
no |
Don't save parameter settings |
|
out_single_precision |
Scope: restricted |
| BOOLEAN |
Description: Output data in single precision ? |
|
|
|
| Default: no |
out_timesteps_per_file |
Scope: restricted |
| INT |
Description: How many timesteps to write to a single file |
|
Range |
|
| Default: -1 |
1:1 |
Number of timesteps per file (can only be 1 so far) |
|
-1: |
All timesteps in a single file |
|
out_unchunked |
Scope: restricted |
| BOOLEAN |
Description: Don't write data in chunks. This parameter is ignored for single-processor runs where output is always done in unchunked mode. |
|
|
|
| Default: no |
out_xline_y |
Scope: restricted |
| REAL |
Description: y-coord for 1D lines in x-direction |
|
Range |
|
| Default: 0.0 |
*:* |
A value between [ymin, ymax] |
|
out_xline_yi |
Scope: restricted |
| INT |
Description: y-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_y |
|
Range |
|
| Default: -2 |
0:* |
An index between [0, ny) |
|
-1: |
Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using 0 |
|
-2: |
Default to physical coordinate IO::out_xline_y if it is within grid bounds, otherwise revert to using the y-center of the box |
|
out_xline_z |
Scope: restricted |
| REAL |
Description: z-coord for 1D lines in x-direction |
|
Range |
|
| Default: 0.0 |
*:* |
A value between [zmin, zmax] |
|
out_xline_zi |
Scope: restricted |
| INT |
Description: z-index (from 0) for 1D lines in x-direction, overrides IO::out_xline_z |
|
Range |
|
| Default: -2 |
0:* |
An index between [0, nz) |
|
-1: |
Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using 0 |
|
-2: |
Default to physical coordinate IO::out_xline_z if it is within grid bounds, otherwise revert to using the z-center of the box |
|
out_xyplane_z |
Scope: restricted |
| REAL |
Description: z-coord for 2D planes in xy |
|
Range |
|
| Default: 0.0 |
*:* |
A value between [zmin, zmax] |
|
out_xyplane_zi |
Scope: restricted |
| INT |
Description: z-index (from 0) for 2D planes in xy, overrrides IO::out_xyplane_z |
|
Range |
|
| Default: -2 |
0:* |
An index between [0, nz) |
|
-1: |
Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using 0 |
|
-2: |
Default to physical coordinate IO::out_xyplane_z if it is within grid bounds, otherwise revert to using the z-center of the box |
|
out_xzplane_y |
Scope: restricted |
| REAL |
Description: y-coord for 2D planes in xz |
|
Range |
|
| Default: 0.0 |
*:* |
A value between [ymin, ymax] |
|
out_xzplane_yi |
Scope: restricted |
| INT |
Description: y-index (from 0) for 2D planes in xz, overrrides IO::out_xzplane_y |
|
Range |
|
| Default: -2 |
0:* |
An index between [0, ny) |
|
-1: |
Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using 0 |
|
-2: |
Default to physical coordinate IO::out_xzplane_y if it is within grid bounds, otherwise revert to using the y-center of the box |
|
out_yline_x |
Scope: restricted |
| REAL |
Description: x-coord for 1D lines in y-direction |
|
Range |
|
| Default: 0.0 |
*:* |
A value between [xmin, xmax] |
|
out_yline_xi |
Scope: restricted |
| INT |
Description: x-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_x |
|
Range |
|
| Default: -2 |
0:* |
An index between [0, nx) |
|
-1: |
Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using 0 |
|
-2: |
Default to physical coordinate IO::out_yline_x if it is within grid bounds, otherwise revert to using the x-center of the box |
|
out_yline_z |
Scope: restricted |
| REAL |
Description: z-coord for 1D lines in y-direction |
|
Range |
|
| Default: 0.0 |
*:* |
A value between [zmin, zmax] |
|
out_yline_zi |
Scope: restricted |
| INT |
Description: z-index (from 0) for 1D lines in y-direction, overrides IO::out_yline_z |
|
Range |
|
| Default: -2 |
0:* |
An index between [0, nz) |
|
-1: |
Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using 0 |
|
-2: |
Default to physical coordinate IO::out_yline_z if it is within grid bounds, otherwise revert to using the z-center of the box |
|
out_yzplane_x |
Scope: restricted |
| REAL |
Description: x-coord for 2D planes in yz |
|
Range |
|
| Default: 0.0 |
*:* |
A value between [xmin, xmax] |
|
out_yzplane_xi |
Scope: restricted |
| INT |
Description: x-index (from 0) for 2D planes in yz, overrrides IO::out_yzplane_x |
|
Range |
|
| Default: -2 |
0:* |
An index between [0, nx) |
|
-1: |
Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using 0 |
|
-2: |
Default to physical coordinate IO::out_yzplane_x if it is within grid bounds, otherwise revert to using the x-center of the box |
|
out_zline_x |
Scope: restricted |
| REAL |
Description: x-coord for 1D lines in z-direction |
|
Range |
|
| Default: 0.0 |
*:* |
A value between [xmin, xmax] |
|
out_zline_xi |
Scope: restricted |
| INT |
Description: x-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_x |
|
Range |
|
| Default: -2 |
0:* |
An index between [0, nx) |
|
-1: |
Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using 0 |
|
-2: |
Default to physical coordinate IO::out_zline_x if it is within grid bounds, otherwise revert to using the x-center of the box |
|
out_zline_y |
Scope: restricted |
| REAL |
Description: y-coord for 1D lines in z-direction |
|
Range |
|
| Default: 0.0 |
*:* |
A value between [ymin, ymax] |
|
out_zline_yi |
Scope: restricted |
| INT |
Description: y-index (from 0) for 1D lines in z-direction, overrides IO::out_zline_y |
|
Range |
|
| Default: -2 |
0:* |
An index between [0, ny) |
|
-1: |
Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using 0 |
|
-2: |
Default to physical coordinate IO::out_zline_y if it is within grid bounds, otherwise revert to using the y-center of the box |
|
parfile_name |
Scope: restricted |
| STRING |
Description: Filename for the parameter file to be written |
|
Range |
|
| Default: (none) |
.+ |
A valid filename |
|
^$ |
An empty string to choose the original parameter filename |
|
parfile_update_every |
Scope: restricted |
| INT |
Description: How often to update the parameter file for steered parameters |
|
Range |
|
| Default: (none) |
1:* |
Every so many iterations |
|
0: |
Disable updating |
|
parfile_write |
Scope: restricted |
| KEYWORD |
Description: Write a parameter file to 'IO::out_dir' |
|
Range |
|
| Default: copy |
no |
Do not write a parameter file |
|
copy |
Copy the original parameter file |
|
generate |
Generate a parameter file from the current settings |
|
print_timing_info |
Scope: restricted |
| BOOLEAN |
Description: Print timing information on I/O operations. |
|
|
|
| Default: no |
recover |
Scope: restricted |
| KEYWORD |
Description: Recover from a checkpoint file ? |
|
Range |
|
| Default: no |
no |
Don't recover |
|
manual |
Recover from the checkpoint file as given in IO::recover_dir and IO::recover_file |
|
auto |
Automatically recover from the latest checkpoint file found in <recover_dir> |
|
autoprobe |
Probe for checkpoint files and automatically recover, continue as usual if nothing was found |
|
recover_and_remove |
Scope: restricted |
| BOOLEAN |
Description: Remove checkpoint file after successful recovery ? |
|
|
|
| Default: no |
recover_dir |
Scope: restricted |
| STRING |
Description: Directory to look for recovery files |
|
Range |
|
| Default: (none) |
.+ |
A valid directory name |
|
recover_file |
Scope: restricted |
| STRING |
Description: Basename of recovery file |
|
Range |
|
| Default: checkpoint.chkpt |
.+ |
A valid filename |
|
require_empty_output_directory |
Scope: restricted |
| BOOLEAN |
Description: Require that IO::out_dir is empty at startup ? |
|
|
|
| Default: no |
strict_io_parameter_check |
Scope: restricted |
| BOOLEAN |
Description: Stop on errors while parsing I/O parameters from parameter file ? |
|
|
|
| Default: yes |
verbose |
Scope: restricted |
| KEYWORD |
Description: Level of screen output for I/O |
|
Range |
|
| Default: standard |
none |
No output |
|
standard |
Initial description for each I/O method |
|
full |
Maximal output |
|
Next: Interfaces
Up: IOUtil
Previous: Adding a Recovery Method
Contents
|