This is the documentation of the most upstream development version of GRACE. If you're looking for the last stable release please select a different version of this documentation.

IO

This page contains a full reference of all parameters available for the IO module. At the bottom of the page you can find an example parameter block that can be used in your parameter file.

IO

Output

Name:	volume_output_every
Type:	int
Default:	-1
Range:	[-1,*)
Description:	Interval (in iterations) between successive 3D outputs. -1 disables volume output.

Name:	plane_surface_output_every
Type:	int
Default:	-1
Range:	[-1,*)
Description:	Interval (in iterations) between successive planar 2D outputs. -1 disables plane surface output.

Name:	sphere_surface_output_every
Type:	int
Default:	-1
Range:	[-1,*)
Description:	Interval (in iterations) between successive spherical 2D outputs. -1 disables sphere surface output.

Name:	scalar_output_every
Type:	int
Default:	-1
Range:	[-1,*)
Description:	Interval (in iterations) between successive scalar outputs. -1 disables scalar output.

Name:	diagnostic_output_every
Type:	int
Default:	-1
Range:	[-1,*)
Description:	Interval (in iterations) between successive diagnostic outputs. -1 disables diagnostic output.

Name:	info_output_every
Type:	int
Default:	10
Range:	[-1,*)
Description:	Interval (in iterations) between successive prints to stdout. -1 disables info output.

Name:	do_initial_output
Type:	bool
Default:	True
Description:	Do output after initial data?

Name:	output_extra_quantities
Type:	bool
Default:	True
Description:	Output rank, quadrant and tree ID in 3D and 2D plane output?

Name:	info_output_max_reductions
Type:	list
Default:	[]
Description:	List of variables whose max values are printed in info

Name:	info_output_min_reductions
Type:	list
Default:	[]
Description:	List of variables whose min values are printed in info

Name:	info_output_norm2_reductions
Type:	list
Default:	[]
Description:	List of variables whose L2 norm values are printed in info

Name:	scalar_output_minmax
Type:	list
Default:	[]
Description:	List of variables whose min and max values are written to scalar output

Name:	scalar_output_norm2
Type:	list
Default:	[]
Description:	List of variables whose L2 norm is written to scalar output

Name:	scalar_output_integral
Type:	list
Default:	[]
Description:	List of variables whose integral (wrt coordinate volume!) is written to scalar output

Name:	volume_output_cell_variables
Type:	list
Default:	[]
Description:	List of variables in 3D output

Name:	plane_surface_output_cell_variables
Type:	list
Default:	[]
Description:	List of variables in 2D plane output

Name:	sphere_surface_output_cell_variables
Type:	list
Default:	[]
Description:	List of variables in 2D sphere output

Name:	performance_metric
Type:	keyword
Default:	none
Range:	none, mzph, zcps, both
Description:	Performance metric displayed in info output and written to scalar output. Options: “none” (disabled), “mzph” (million zone-cycles per hour), “zcps” (zone-cycles per second), “both” (display both).

Name:	log_output_base_filename
Type:	string
Default:	grace_log
Description:	Base filename for logs, full filename will be basename_rank.out/err

Name:	log_output_base_directory
Type:	string
Default:	./logs
Description:	Path where logs are written, relative to running directory

Name:	volume_output_base_filename
Type:	string
Default:	volume_out
Description:	Base filename for 3D output, full filename will be basename_iteration.h5

Name:	volume_output_base_directory
Type:	string
Default:	./output_volume
Description:	Path where 3D outputs are written, relative to running directory

Name:	surface_output_base_filename
Type:	string
Default:	surface_out
Description:	Base filename for 2D output, full filename will be basename_surf_name_iteration.h5

Name:	surface_output_base_directory
Type:	string
Default:	./output_surface
Description:	Path where 2D outputs are written, relative to running directory

Name:	sphere_surface_output_base_directory
Type:	string
Default:	./output_spheres
Description:	Path where 2D sphere outputs are written, relative to running directory

Name:	scalar_output_base_filename
Type:	string
Description:	Base filename for scalar output, full filename will be basename_varname_reduction.dat

Name:	scalar_output_base_directory
Type:	string
Default:	./output_scalar
Description:	Path where scalar outputs are written, relative to running directory

Name:	output_use_hdf5
Type:	bool
Default:	True
Description:	Use HDF5 for output, if false, GRACE needs to be compiled with VTK support (deprecated).

Name:	hdf5_compression_level
Type:	int
Default:	0
Range:	[0,*)
Description:	Compression level to be used in HDF5 output, can save space but generally hurts performance. Library must support this in conjunction with parallel output.

Name:	hdf5_chunk_size
Type:	int
Default:	4096
Range:	(0,*)
Description:	Size of chunking for HDF5 output

Name:	xy_plane_offset
Type:	double
Default:	0.0
Range:	(*,*)
Description:	Z offset

Name:	xz_plane_offset
Type:	double
Default:	0.0
Range:	(*,*)
Description:	Y offset

Name:	yz_plane_offset
Type:	double
Default:	0.0
Range:	(*,*)
Description:	X offset

Name:	n_output_spheres
Type:	int
Default:	0
Range:	[0,*)
Description:	Number of spherical detectors where output is requested

Name:	output_sphere_names
Type:	list
Default:	[]
Description:	Name of spherical detectors where 2D output is requested