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.

nan_check

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

nan_check

Periodic sanity check that scans evolved variables (cell-centered state, auxiliary, and staggered) for NaN values, with a configurable action when any are found.

Name:	enabled
Type:	bool
Default:	False
Description:	Master switch. When false, no scans are performed.

Name:	check_before_first_step
Type:	bool
Default:	True
Description:	Run a scan once before the evolution loop begins, after initial data has been set and before the first timestep. Useful for catching bad initial data.

Name:	check_every
Type:	int
Default:	0
Range:	[0,*)
Description:	Iteration interval between scans during the evolution loop. 0 disables periodic in-loop scans (the before-first-step scan is still controlled by check_before_first_step).

Name:	action
Type:	keyword
Default:	abort
Range:	warn, terminate, abort
Description:	What to do when NaNs are detected. “warn” prints a warning and continues. “terminate” requests a clean termination (the loop exits after the current iteration, output and checkpointing run normally). “abort” calls ERROR(), which throws and aborts the run with a backtrace.