mom_debugging mom_debugging::check_redundant mom_debugging::check_redundant_b mom_debugging::check_redundant_c mom_debugging::check_redundant_t mom_debugging::vec_chksum mom_debugging::vec_chksum_a mom_debugging::vec_chksum_b mom_debugging::vec_chksum_c integer integer mom_debugging::max_redundant_prints max_redundant_prints = 100 Maximum number of times to write redundant messages. check_redundant_sb2d check_redundant_st2d check_redundant_vb2d check_redundant_vc2d check_redundant_vt2d integer, dimension(3) integer, dimension(3) mom_debugging::redundant_prints redundant_prints = 0 Counters for controlling redundant printing. check_redundant_sb2d check_redundant_st2d check_redundant_vb2d check_redundant_vc2d check_redundant_vt2d logical logical mom_debugging::debug debug = .false. Write out verbose debugging data. mom_debugging_init logical logical mom_debugging::debug_chksums debug_chksums = .true. Perform checksums on arrays. chksum_vec_a2d chksum_vec_a3d chksum_vec_b2d chksum_vec_b3d chksum_vec_c2d chksum_vec_c3d mom_debugging_init logical logical mom_debugging::debug_redundant debug_redundant = .true. Check redundant values on PE boundaries. chksum_vec_a2d chksum_vec_a3d chksum_vec_b2d chksum_vec_b3d chksum_vec_c2d chksum_vec_c3d mom_debugging_init subroutine, public subroutine, public mom_debugging::mom_debugging_init (param_file) mom_debugging_init param_file param_file MOM_debugging_init initializes the MOM_debugging module, and sets the parameterts that control which checks are active for MOM6. param_file A structure to parse for run-time parameters debug debug_chksums debug_redundant mom_checksums::mom_checksums_init subroutine subroutine mom_debugging::check_redundant_vc3d (mesg, u_comp, v_comp, G, is, ie, js, je, direction) check_redundant_vc3d mesg mesg u_comp u_comp v_comp v_comp G G is is ie ie js js je je direction direction Check for consistency between the duplicated points of a 3-D C-grid vector. mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector to be checked for consistency v_comp The u-component of the vector to be checked for consistency is The starting i-index to check ie The ending i-index to check js The starting j-index to check je The ending j-index to check direction the direction flag to be passed to pass_vector check_redundant_vc2d subroutine subroutine mom_debugging::check_redundant_vc2d (mesg, u_comp, v_comp, G, is, ie, js, je, direction) check_redundant_vc2d mesg mesg u_comp u_comp v_comp v_comp G G is is ie ie js js je je direction direction Check for consistency between the duplicated points of a 2-D C-grid vector. mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector to be checked for consistency v_comp The u-component of the vector to be checked for consistency is The starting i-index to check ie The ending i-index to check js The starting j-index to check je The ending j-index to check direction the direction flag to be passed to pass_vector max_redundant_prints mom_error_handler::mom_error redundant_prints check_redundant_vc3d subroutine subroutine mom_debugging::check_redundant_sb3d (mesg, array, G, is, ie, js, je) check_redundant_sb3d mesg mesg array array G G is is ie ie js js je je Check for consistency between the duplicated points of a 3-D scalar at corner points. mesg An identifying message g The ocean's grid structure array The array to be checked for consistency is The starting i-index to check ie The ending i-index to check js The starting j-index to check je The ending j-index to check check_redundant_sb2d subroutine subroutine mom_debugging::check_redundant_sb2d (mesg, array, G, is, ie, js, je) check_redundant_sb2d mesg mesg array array G G is is ie ie js js je je Check for consistency between the duplicated points of a 2-D scalar at corner points. mesg An identifying message g The ocean's grid structure array The array to be checked for consistency is The starting i-index to check ie The ending i-index to check js The starting j-index to check je The ending j-index to check max_redundant_prints mom_error_handler::mom_error redundant_prints mom_domains::to_all check_redundant_sb3d subroutine subroutine mom_debugging::check_redundant_vb3d (mesg, u_comp, v_comp, G, is, ie, js, je, direction) check_redundant_vb3d mesg mesg u_comp u_comp v_comp v_comp G G is is ie ie js js je je direction direction Check for consistency between the duplicated points of a 3-D B-grid vector. mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector to be checked for consistency v_comp The v-component of the vector to be checked for consistency is The starting i-index to check ie The ending i-index to check js The starting j-index to check je The ending j-index to check direction the direction flag to be passed to pass_vector check_redundant_vb2d subroutine subroutine mom_debugging::check_redundant_vb2d (mesg, u_comp, v_comp, G, is, ie, js, je, direction) check_redundant_vb2d mesg mesg u_comp u_comp v_comp v_comp G G is is ie ie js js je je direction direction Check for consistency between the duplicated points of a 2-D B-grid vector. mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector to be checked for consistency v_comp The v-component of the vector to be checked for consistency is The starting i-index to check ie The ending i-index to check js The starting j-index to check je The ending j-index to check direction the direction flag to be passed to pass_vector max_redundant_prints mom_error_handler::mom_error redundant_prints check_redundant_vb3d subroutine subroutine mom_debugging::check_redundant_st3d (mesg, array, G, is, ie, js, je) check_redundant_st3d mesg mesg array array G G is is ie ie js js je je Check for consistency between the duplicated points of a 3-D scalar at tracer points. mesg An identifying message g The ocean's grid structure array The array to be checked for consistency is The starting i-index to check ie The ending i-index to check js The starting j-index to check je The ending j-index to check check_redundant_st2d subroutine subroutine mom_debugging::check_redundant_st2d (mesg, array, G, is, ie, js, je) check_redundant_st2d mesg mesg array array G G is is ie ie js js je je Check for consistency between the duplicated points of a 2-D scalar at tracer points. mesg An identifying message g The ocean's grid structure array The array to be checked for consistency is The starting i-index to check ie The ending i-index to check js The starting j-index to check je The ending j-index to check max_redundant_prints redundant_prints check_redundant_st3d subroutine subroutine mom_debugging::check_redundant_vt3d (mesg, u_comp, v_comp, G, is, ie, js, je, direction) check_redundant_vt3d mesg mesg u_comp u_comp v_comp v_comp G G is is ie ie js js je je direction direction Check for consistency between the duplicated points of a 3-D A-grid vector. mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector to be checked for consistency v_comp The v-component of the vector to be checked for consistency is The starting i-index to check ie The ending i-index to check js The starting j-index to check je The ending j-index to check direction the direction flag to be passed to pass_vector check_redundant_vt2d subroutine subroutine mom_debugging::check_redundant_vt2d (mesg, u_comp, v_comp, G, is, ie, js, je, direction) check_redundant_vt2d mesg mesg u_comp u_comp v_comp v_comp G G is is ie ie js js je je direction direction Check for consistency between the duplicated points of a 2-D A-grid vector. mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector to be checked for consistency v_comp The v-component of the vector to be checked for consistency is The starting i-index to check ie The ending i-index to check js The starting j-index to check je The ending j-index to check direction the direction flag to be passed to pass_vector max_redundant_prints redundant_prints check_redundant_vt3d subroutine subroutine mom_debugging::chksum_vec_c3d (mesg, u_comp, v_comp, G, halos, scalars) chksum_vec_c3d mesg mesg u_comp u_comp v_comp v_comp G G halos halos scalars scalars Do a checksum and redundant point check on a 3d C-grid vector. mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector v_comp The v-component of the vector halos The width of halos to check (default 0) scalars If true this is a pair of scalars that are being checked. debug_chksums debug_redundant mom_domains::to_all subroutine subroutine mom_debugging::chksum_vec_c2d (mesg, u_comp, v_comp, G, halos, scalars) chksum_vec_c2d mesg mesg u_comp u_comp v_comp v_comp G G halos halos scalars scalars Do a checksum and redundant point check on a 2d C-grid vector. mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector v_comp The v-component of the vector halos The width of halos to check (default 0) scalars If true this is a pair of scalars that are being checked. debug_chksums debug_redundant mom_domains::to_all subroutine subroutine mom_debugging::chksum_vec_b3d (mesg, u_comp, v_comp, G, halos, scalars) chksum_vec_b3d mesg mesg u_comp u_comp v_comp v_comp G G halos halos scalars scalars Do a checksum and redundant point check on a 3d B-grid vector. mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector v_comp The v-component of the vector halos The width of halos to check (default 0) scalars If true this is a pair of scalars that are being checked. debug_chksums debug_redundant mom_domains::to_all subroutine subroutine mom_debugging::chksum_vec_b2d (mesg, u_comp, v_comp, G, halos, scalars, symmetric) chksum_vec_b2d mesg mesg u_comp u_comp v_comp v_comp G G halos halos scalars scalars symmetric symmetric mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector v_comp The v-component of the vector halos The width of halos to check (default 0) scalars If true this is a pair of scalars that are being checked. symmetric If true, do the checksums on the full symmetric computational domain. debug_chksums debug_redundant mom_domains::to_all subroutine subroutine mom_debugging::chksum_vec_a3d (mesg, u_comp, v_comp, G, halos, scalars) chksum_vec_a3d mesg mesg u_comp u_comp v_comp v_comp G G halos halos scalars scalars Do a checksum and redundant point check on a 3d C-grid vector. mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector v_comp The v-component of the vector halos The width of halos to check (default 0) scalars If true this is a pair of scalars that are being checked. debug_chksums debug_redundant mom_domains::to_all subroutine subroutine mom_debugging::chksum_vec_a2d (mesg, u_comp, v_comp, G, halos, scalars) chksum_vec_a2d mesg mesg u_comp u_comp v_comp v_comp G G halos halos scalars scalars Do a checksum and redundant point check on a 2d C-grid vector. mesg An identifying message g The ocean's grid structure u_comp The u-component of the vector v_comp The v-component of the vector halos The width of halos to check (default 0) scalars If true this is a pair of scalars that are being checked. debug_chksums debug_redundant mom_domains::to_all real function, public real function, public mom_debugging::totalstuff (HI, hThick, areaT, stuff) totalstuff HI HI hThick hThick areaT areaT stuff stuff This function returns the sum over computational domain of all processors of hThick*stuff, where stuff is a 3-d array at tracer points. hi A horizontal index type hthick The array of thicknesses to use as weights areat The array of cell areas [m2] stuff The array of stuff to be summed the globally integrated amoutn of stuff totaltands subroutine, public subroutine, public mom_debugging::totaltands (HI, hThick, areaT, temperature, salinity, mesg) totaltands HI HI hThick hThick areaT areaT temperature temperature salinity salinity mesg mesg This subroutine display the total thickness, temperature and salinity as well as the change since the last call. hi A horizontal index type hthick The array of thicknesses to use as weights areat The array of cell areas [m2] temperature The temperature field to sum salinity The salinity field to sum mesg An identifying message mom_error_handler::is_root_pe totalstuff logical function, public logical function, public mom_debugging::check_column_integral (nk, field, known_answer) check_column_integral nk nk field field known_answer known_answer Returns false if the column integral of a given quantity is within roundoff. nk Number of levels in column field Field to be summed known_answer If present is the expected sum, If missing, assumed zero logical function, public logical function, public mom_debugging::check_column_integrals (nk_1, field_1, nk_2, field_2, missing_value) check_column_integrals nk_1 nk_1 field_1 field_1 nk_2 nk_2 field_2 field_2 missing_value missing_value Returns false if the column integrals of two given quantities are within roundoff of each other. nk_1 Number of levels in field 1 nk_2 Number of levels in field 2 field_1 First field to be summed field_2 Second field to be summed missing_value If column contains missing values, mask them from the sum mom_ale::ale_offline_inputs Provides checksumming functions for debugging. 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.