mom_checksums mom_checksums::bchksum mom_checksums::bchksum_pair mom_checksums::chk_sum_msg mom_checksums::chksum mom_checksums::hchksum mom_checksums::hchksum_pair mom_checksums::is_nan mom_checksums::qchksum mom_checksums::uchksum mom_checksums::uvchksum mom_checksums::vchksum integer, parameter integer, parameter mom_checksums::bc_modulus bc_modulus = 1000000000 Modulus of checksum bitcount. chksum0 subchk integer, parameter integer, parameter mom_checksums::default_shift default_shift =0 The default array shift. chksum_b_2d chksum_b_3d chksum_h_2d chksum_h_3d chksum_u_2d chksum_u_3d chksum_v_2d chksum_v_3d logical logical mom_checksums::calculatestatistics calculatestatistics =.true. If true, report min, max and mean. chksum0 chksum_b_2d chksum_b_3d chksum_h_2d chksum_h_3d chksum_u_2d chksum_u_3d chksum_v_2d chksum_v_3d zchksum logical logical mom_checksums::writechksums writechksums =.true. If true, report the bitcount checksum. chksum0 chksum_b_2d chksum_b_3d chksum_h_2d chksum_h_3d chksum_u_2d chksum_u_3d chksum_v_2d chksum_v_3d zchksum logical logical mom_checksums::checkfornans checkfornans =.true. If true, checks array for NaNs and cause FATAL error is any are found. chksum0 chksum_b_2d chksum_b_3d chksum_h_2d chksum_h_3d chksum_u_2d chksum_u_3d chksum_v_2d chksum_v_3d zchksum subroutine, public subroutine, public mom_checksums::chksum0 (scalar, mesg, scale, logunit) chksum0 scalar scalar mesg mesg scale scale logunit logunit Checksum a scalar field (consistent with array checksums) scalar The array to be checksummed mesg An identifying message scale A scaling factor for this array. logunit IO unit for checksum logging bc_modulus bitcount calculatestatistics checkfornans chksum_error mom_error_handler::is_root_pe writechksums subroutine, public subroutine, public mom_checksums::zchksum (array, mesg, scale, logunit) zchksum array array mesg mesg scale scale logunit logunit Checksum a 1d array (typically a column). array The array to be checksummed mesg An identifying message scale A scaling factor for this array. logunit IO unit for checksum logging calculatestatistics checkfornans chksum_error mom_error_handler::is_root_pe subchk substats writechksums subroutine subroutine mom_checksums::chksum_pair_h_2d (mesg, arrayA, arrayB, HI, haloshift, omit_corners, scale, logunit, scalar_pair) chksum_pair_h_2d mesg mesg arrayA arrayA arrayB arrayB HI HI haloshift haloshift omit_corners omit_corners scale scale logunit logunit scalar_pair scalar_pair Checksums on a pair of 2d arrays staggered at tracer points. mesg Identifying messages hi A horizontal index type arraya The first array to be checksummed arrayb The second array to be checksummed haloshift The width of halos to check (default 0) omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging scalar_pair If true, then the arrays describe a scalar, rather than vector chksum_h_2d mom_hor_index::rotate_hor_index subroutine subroutine mom_checksums::chksum_pair_h_3d (mesg, arrayA, arrayB, HI, haloshift, omit_corners, scale, logunit, scalar_pair) chksum_pair_h_3d mesg mesg arrayA arrayA arrayB arrayB HI HI haloshift haloshift omit_corners omit_corners scale scale logunit logunit scalar_pair scalar_pair Checksums on a pair of 3d arrays staggered at tracer points. mesg Identifying messages hi A horizontal index type arraya The first array to be checksummed arrayb The second array to be checksummed haloshift The width of halos to check (default 0) omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging scalar_pair If true, then the arrays describe a scalar, rather than vector chksum_h_3d mom_hor_index::rotate_hor_index subroutine subroutine mom_checksums::chksum_h_2d (array_m, mesg, HI_m, haloshift, omit_corners, scale, logunit) chksum_h_2d array_m array_m mesg mesg HI_m HI_m haloshift haloshift omit_corners omit_corners scale scale logunit logunit Checksums a 2d array staggered at tracer points. hi_m Horizontal index bounds of the model grid array_m Field array on the model grid mesg An identifying message haloshift The width of halos to check (default 0) omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging calculatestatistics checkfornans chk_sum_msg_nsew chksum_error default_shift mom_error_handler::is_root_pe mom_hor_index::rotate_hor_index subchk substats writechksums chksum_pair_h_2d subroutine subroutine mom_checksums::chksum_pair_b_2d (mesg, arrayA, arrayB, HI, haloshift, symmetric, omit_corners, scale, logunit, scalar_pair) chksum_pair_b_2d mesg mesg arrayA arrayA arrayB arrayB HI HI haloshift haloshift symmetric symmetric omit_corners omit_corners scale scale logunit logunit scalar_pair scalar_pair Checksums on a pair of 2d arrays staggered at q-points. mesg Identifying messages hi A horizontal index type arraya The first array to be checksummed arrayb The second array to be checksummed symmetric If true, do the checksums on the full symmetric computational domain. haloshift The width of halos to check (default 0) omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging scalar_pair If true, then the arrays describe a scalar, rather than vector chksum_b_2d mom_hor_index::rotate_hor_index subroutine subroutine mom_checksums::chksum_pair_b_3d (mesg, arrayA, arrayB, HI, haloshift, symmetric, omit_corners, scale, logunit, scalar_pair) chksum_pair_b_3d mesg mesg arrayA arrayA arrayB arrayB HI HI haloshift haloshift symmetric symmetric omit_corners omit_corners scale scale logunit logunit scalar_pair scalar_pair Checksums on a pair of 3d arrays staggered at q-points. mesg Identifying messages hi A horizontal index type arraya The first array to be checksummed arrayb The second array to be checksummed haloshift The width of halos to check (default 0) symmetric If true, do the checksums on the full symmetric computational domain. omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging scalar_pair If true, then the arrays describe a scalar, rather than vector chksum_b_3d mom_hor_index::rotate_hor_index subroutine subroutine mom_checksums::chksum_b_2d (array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit) chksum_b_2d array_m array_m mesg mesg HI_m HI_m haloshift haloshift symmetric symmetric omit_corners omit_corners scale scale logunit logunit Checksums a 2d array staggered at corner points. hi_m A horizontal index type array_m The array to be checksummed mesg An identifying message haloshift The width of halos to check (default 0) symmetric If true, do the checksums on the full symmetric computational domain. omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging calculatestatistics checkfornans chk_sum_msg_nsew chksum_error default_shift mom_error_handler::is_root_pe mom_hor_index::rotate_hor_index subchk substats writechksums chksum_pair_b_2d subroutine subroutine mom_checksums::chksum_uv_2d (mesg, arrayU, arrayV, HI, haloshift, symmetric, omit_corners, scale, logunit, scalar_pair) chksum_uv_2d mesg mesg arrayU arrayU arrayV arrayV HI HI haloshift haloshift symmetric symmetric omit_corners omit_corners scale scale logunit logunit scalar_pair scalar_pair Checksums a pair of 2d velocity arrays staggered at C-grid locations. mesg Identifying messages hi A horizontal index type arrayu The u-component array to be checksummed arrayv The v-component array to be checksummed haloshift The width of halos to check (default 0) symmetric If true, do the checksums on the full symmetric computational domain. omit_corners If true, avoid checking diagonal shifts scale A scaling factor for these arrays. logunit IO unit for checksum logging scalar_pair If true, then the arrays describe a a scalar, rather than vector chksum_u_2d chksum_v_2d mom_hor_index::rotate_hor_index subroutine subroutine mom_checksums::chksum_uv_3d (mesg, arrayU, arrayV, HI, haloshift, symmetric, omit_corners, scale, logunit, scalar_pair) chksum_uv_3d mesg mesg arrayU arrayU arrayV arrayV HI HI haloshift haloshift symmetric symmetric omit_corners omit_corners scale scale logunit logunit scalar_pair scalar_pair Checksums a pair of 3d velocity arrays staggered at C-grid locations. mesg Identifying messages hi A horizontal index type arrayu The u-component array to be checksummed arrayv The v-component array to be checksummed haloshift The width of halos to check (default 0) symmetric If true, do the checksums on the full symmetric computational domain. omit_corners If true, avoid checking diagonal shifts scale A scaling factor for these arrays. logunit IO unit for checksum logging scalar_pair If true, then the arrays describe a a scalar, rather than vector chksum_u_3d chksum_v_3d mom_hor_index::rotate_hor_index subroutine subroutine mom_checksums::chksum_u_2d (array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit) chksum_u_2d array_m array_m mesg mesg HI_m HI_m haloshift haloshift symmetric symmetric omit_corners omit_corners scale scale logunit logunit Checksums a 2d array staggered at C-grid u points. hi_m A horizontal index type array_m The array to be checksummed mesg An identifying message haloshift The width of halos to check (default 0) symmetric If true, do the checksums on the full symmetric computational domain. omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging calculatestatistics checkfornans chk_sum_msg_nsew chk_sum_msg_w chksum_error default_shift mom_error_handler::is_root_pe mom_hor_index::rotate_hor_index subchk substats writechksums chksum_uv_2d subroutine subroutine mom_checksums::chksum_v_2d (array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit) chksum_v_2d array_m array_m mesg mesg HI_m HI_m haloshift haloshift symmetric symmetric omit_corners omit_corners scale scale logunit logunit Checksums a 2d array staggered at C-grid v points. hi_m A horizontal index type array_m The array to be checksummed mesg An identifying message haloshift The width of halos to check (default 0) symmetric If true, do the checksums on the full symmetric computational domain. omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging calculatestatistics checkfornans chk_sum_msg_nsew chk_sum_msg_s chksum_error default_shift mom_error_handler::is_root_pe mom_hor_index::rotate_hor_index subchk substats writechksums chksum_uv_2d subroutine subroutine mom_checksums::chksum_h_3d (array_m, mesg, HI_m, haloshift, omit_corners, scale, logunit) chksum_h_3d array_m array_m mesg mesg HI_m HI_m haloshift haloshift omit_corners omit_corners scale scale logunit logunit Checksums a 3d array staggered at tracer points. hi_m A horizontal index type array_m The array to be checksummed mesg An identifying message haloshift The width of halos to check (default 0) omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging calculatestatistics checkfornans chk_sum_msg_nsew chksum_error default_shift mom_error_handler::is_root_pe mom_hor_index::rotate_hor_index subchk substats writechksums chksum_pair_h_3d subroutine subroutine mom_checksums::chksum_b_3d (array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit) chksum_b_3d array_m array_m mesg mesg HI_m HI_m haloshift haloshift symmetric symmetric omit_corners omit_corners scale scale logunit logunit Checksums a 3d array staggered at corner points. hi_m A horizontal index type array_m The array to be checksummed mesg An identifying message haloshift The width of halos to check (default 0) symmetric If true, do the checksums on the full symmetric computational domain. omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging calculatestatistics checkfornans chk_sum_msg_nsew chksum_error default_shift mom_error_handler::is_root_pe mom_hor_index::rotate_hor_index subchk substats writechksums chksum_pair_b_3d subroutine subroutine mom_checksums::chksum_u_3d (array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit) chksum_u_3d array_m array_m mesg mesg HI_m HI_m haloshift haloshift symmetric symmetric omit_corners omit_corners scale scale logunit logunit Checksums a 3d array staggered at C-grid u points. hi_m A horizontal index type array_m The array to be checksummed mesg An identifying message haloshift The width of halos to check (default 0) symmetric If true, do the checksums on the full symmetric computational domain. omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging calculatestatistics checkfornans chk_sum_msg_nsew chk_sum_msg_w chksum_error default_shift mom_error_handler::is_root_pe mom_hor_index::rotate_hor_index subchk substats writechksums chksum_uv_3d subroutine subroutine mom_checksums::chksum_v_3d (array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit) chksum_v_3d array_m array_m mesg mesg HI_m HI_m haloshift haloshift symmetric symmetric omit_corners omit_corners scale scale logunit logunit Checksums a 3d array staggered at C-grid v points. hi_m A horizontal index type array_m The array to be checksummed mesg An identifying message haloshift The width of halos to check (default 0) symmetric If true, do the checksums on the full symmetric computational domain. omit_corners If true, avoid checking diagonal shifts scale A scaling factor for this array. logunit IO unit for checksum logging calculatestatistics checkfornans chk_sum_msg_nsew chk_sum_msg_s chksum_error default_shift mom_error_handler::is_root_pe mom_hor_index::rotate_hor_index subchk substats writechksums chksum_uv_3d subroutine subroutine mom_checksums::chksum1d (array, mesg, start_i, end_i, compare_PEs) chksum1d array array mesg mesg start_i start_i end_i end_i compare_PEs compare_PEs chksum1d does a checksum of a 1-dimensional array. array The array to be summed (index starts at 1). mesg An identifying message. start_i The starting index for the sum (default 1) end_i The ending index for the sum (default all) compare_pes If true, compare across PEs instead of summing and list the root_PE value (default true) bitcount mom_error_handler::is_root_pe subroutine subroutine mom_checksums::chksum2d (array, mesg) chksum2d array array mesg mesg chksum2d does a checksum of all data in a 2-d array. array The array to be checksummed mesg An identifying message bitcount mom_error_handler::is_root_pe subroutine subroutine mom_checksums::chksum3d (array, mesg) chksum3d array array mesg mesg chksum3d does a checksum of all data in a 2-d array. array The array to be checksummed mesg An identifying message bitcount mom_error_handler::is_root_pe logical function logical function mom_checksums::is_nan_0d (x) is_nan_0d x x This function returns .true. if x is a NaN, and .false. otherwise. x The value to be checked for NaNs. is_nan_1d is_nan_2d is_nan_3d logical function logical function mom_checksums::is_nan_1d (x, skip_mpp) is_nan_1d x x skip_mpp skip_mpp Returns .true. if any element of x is a NaN, and .false. otherwise. x The array to be checked for NaNs. skip_mpp If true, only check this array only on the local PE (default false). is_nan_0d logical function logical function mom_checksums::is_nan_2d (x) is_nan_2d x x Returns .true. if any element of x is a NaN, and .false. otherwise. x The array to be checked for NaNs. is_nan_0d logical function logical function mom_checksums::is_nan_3d (x) is_nan_3d x x Returns .true. if any element of x is a NaN, and .false. otherwise. x The array to be checked for NaNs. is_nan_0d subroutine subroutine mom_checksums::chk_sum_msg1 (fmsg, bc0, mesg, iounit) chk_sum_msg1 fmsg fmsg bc0 bc0 mesg mesg iounit iounit Write a message including the checksum of the non-shifted array. fmsg A checksum code-location specific preamble mesg An identifying message supplied by top-level caller bc0 The bitcount of the non-shifted array iounit Checksum logger IO unit mom_error_handler::is_root_pe subroutine subroutine mom_checksums::chk_sum_msg5 (fmsg, bc0, bcSW, bcSE, bcNW, bcNE, mesg, iounit) chk_sum_msg5 fmsg fmsg bc0 bc0 bcSW bcSW bcSE bcSE bcNW bcNW bcNE bcNE mesg mesg iounit iounit Write a message including checksums of non-shifted and diagonally shifted arrays. fmsg A checksum code-location specific preamble mesg An identifying message supplied by top-level caller bc0 The bitcount of the non-shifted array bcsw The bitcount for SW shifted array bcse The bitcount for SE shifted array bcnw The bitcount for NW shifted array bcne The bitcount for NE shifted array iounit Checksum logger IO unit mom_error_handler::is_root_pe subroutine subroutine mom_checksums::chk_sum_msg_nsew (fmsg, bc0, bcN, bcS, bcE, bcW, mesg, iounit) chk_sum_msg_nsew fmsg fmsg bc0 bc0 bcN bcN bcS bcS bcE bcE bcW bcW mesg mesg iounit iounit Write a message including checksums of non-shifted and laterally shifted arrays. fmsg A checksum code-location specific preamble mesg An identifying message supplied by top-level caller bc0 The bitcount of the non-shifted array bcn The bitcount for N shifted array bcs The bitcount for S shifted array bce The bitcount for E shifted array bcw The bitcount for W shifted array iounit Checksum logger IO unit mom_error_handler::is_root_pe chksum_b_2d chksum_b_3d chksum_h_2d chksum_h_3d chksum_u_2d chksum_u_3d chksum_v_2d chksum_v_3d subroutine subroutine mom_checksums::chk_sum_msg_s (fmsg, bc0, bcS, mesg, iounit) chk_sum_msg_s fmsg fmsg bc0 bc0 bcS bcS mesg mesg iounit iounit Write a message including checksums of non-shifted and southward shifted arrays. fmsg A checksum code-location specific preamble mesg An identifying message supplied by top-level caller bc0 The bitcount of the non-shifted array bcs The bitcount of the south-shifted array iounit Checksum logger IO unit mom_error_handler::is_root_pe chksum_v_2d chksum_v_3d subroutine subroutine mom_checksums::chk_sum_msg_w (fmsg, bc0, bcW, mesg, iounit) chk_sum_msg_w fmsg fmsg bc0 bc0 bcW bcW mesg mesg iounit iounit Write a message including checksums of non-shifted and westward shifted arrays. fmsg A checksum code-location specific preamble mesg An identifying message supplied by top-level caller bc0 The bitcount of the non-shifted array bcw The bitcount of the west-shifted array iounit Checksum logger IO unit mom_error_handler::is_root_pe chksum_u_2d chksum_u_3d subroutine subroutine mom_checksums::chk_sum_msg2 (fmsg, bc0, bcSW, mesg, iounit) chk_sum_msg2 fmsg fmsg bc0 bc0 bcSW bcSW mesg mesg iounit iounit Write a message including checksums of non-shifted and southwestward shifted arrays. fmsg A checksum code-location specific preamble mesg An identifying message supplied by top-level caller bc0 The bitcount of the non-shifted array bcsw The bitcount of the southwest-shifted array iounit Checksum logger IO unit mom_error_handler::is_root_pe subroutine subroutine mom_checksums::chk_sum_msg3 (fmsg, aMean, aMin, aMax, mesg, iounit) chk_sum_msg3 fmsg fmsg aMean aMean aMin aMin aMax aMax mesg mesg iounit iounit Write a message including the global mean, maximum and minimum of an array. fmsg A checksum code-location specific preamble mesg An identifying message supplied by top-level caller amean The mean value of the array amin The minimum value of the array amax The maximum value of the array iounit Checksum logger IO unit mom_error_handler::is_root_pe subroutine, public subroutine, public mom_checksums::mom_checksums_init (param_file) mom_checksums_init param_file param_file MOM_checksums_init initializes the MOM_checksums module. As it happens, the only thing that it does is to log the version of this module. param_file A structure to parse for run-time parameters mom_debugging::mom_debugging_init subroutine subroutine mom_checksums::chksum_error (signal, message) chksum_error signal signal message message A wrapper for MOM_error used in the checksum code. signal An error severity level, such as FATAL or WARNING message An error message mom_error_handler::mom_error chksum0 chksum_b_2d chksum_b_3d chksum_h_2d chksum_h_3d chksum_u_2d chksum_u_3d chksum_v_2d chksum_v_3d zchksum integer function integer function mom_checksums::bitcount (x) bitcount x x Does a bitcount of a number by first casting to an integer and then using BTEST to check bit by bit. x Number to be bitcount chksum0 chksum1d chksum2d chksum3d subchk Routines to calculate checksums of various array and vector types.