mom_debugging module reference

Provides checksumming functions for debugging.

Functions/Subroutines

`mom_debugging_init()`	MOM_debugging_init initializes the MOM_debugging module, and sets the parameters that control which checks are active for MOM6.
`query_debugging_checks()`	Returns logicals indicating which debugging checks should be performed.
`check_redundant_vc3d()`	Check for consistency between the duplicated points of a 3-D C-grid vector.
`check_redundant_vc2d()`	Check for consistency between the duplicated points of a 2-D C-grid vector.
`check_redundant_sb3d()`	Check for consistency between the duplicated points of a 3-D scalar at corner points.
`check_redundant_sb2d()`	Check for consistency between the duplicated points of a 2-D scalar at corner points.
`check_redundant_vb3d()`	Check for consistency between the duplicated points of a 3-D B-grid vector.
`check_redundant_vb2d()`	Check for consistency between the duplicated points of a 2-D B-grid vector.
`check_redundant_st3d()`	Check for consistency between the duplicated points of a 3-D scalar at tracer points.
`check_redundant_st2d()`	Check for consistency between the duplicated points of a 2-D scalar at tracer points.
`check_redundant_vt3d()`	Check for consistency between the duplicated points of a 3-D A-grid vector.
`check_redundant_vt2d()`	Check for consistency between the duplicated points of a 2-D A-grid vector.
`chksum_vec_c3d()`	Do a checksum and redundant point check on a 3d C-grid vector.
`chksum_vec_c2d()`	Do a checksum and redundant point check on a 2d C-grid vector.
`chksum_vec_b3d()`	Do a checksum and redundant point check on a 3d B-grid vector.
`chksum_vec_b2d()`
`chksum_vec_a3d()`	Do a checksum and redundant point check on a 3d C-grid vector.
`chksum_vec_a2d()`	Do a checksum and redundant point check on a 2d C-grid vector.
`totalstuff()`	This function returns the sum over computational domain of all processors of hThick*stuff, where stuff is a 3-d array at tracer points.
`totaltands()`	This subroutine display the total thickness, temperature and salinity as well as the change since the last call.
`check_column_integral()`	Returns false if the column integral of a given quantity is within roundoff.
`check_column_integrals()`	Returns false if the column integrals of two given quantities are within roundoff of each other.

Detailed Description

This module contains subroutines that perform various error checking and debugging functions for MOM6. This routine is similar to it counterpart in the SIS2 code, except for the use of the ocean_grid_type and by keeping them separate we retain the ability to set up MOM6 and SIS2 debugging separately.

Function/Subroutine Documentation

subroutine mom_debugging/mom_debugging_init(param_file)

MOM_debugging_init initializes the MOM_debugging module, and sets the parameters that control which checks are active for MOM6.

Parameters:: param_file :: param_file [in] A structure to parse for run-time parameters
Call to:: debug debug_chksums debug_redundant mom_checksums::mom_checksums_init