mom_checksums module reference¶

Routines to calculate checksums of various array and vector types.

Functions/Subroutines¶

`chksum0()`	Checksum a scalar field (consistent with array checksums)
`zchksum()`	Checksum a 1d array (typically a column).
`chksum_pair_h_2d()`	Checksums on a pair of 2d arrays staggered at tracer points.
`chksum_pair_h_3d()`	Checksums on a pair of 3d arrays staggered at tracer points.
`chksum_h_2d()`	Checksums a 2d array staggered at tracer points.
`chksum_pair_b_2d()`	Checksums on a pair of 2d arrays staggered at q-points.
`chksum_pair_b_3d()`	Checksums on a pair of 3d arrays staggered at q-points.
`chksum_b_2d()`	Checksums a 2d array staggered at corner points.
`chksum_uv_2d()`	Checksums a pair of 2d velocity arrays staggered at C-grid locations.
`chksum_uv_3d()`	Checksums a pair of 3d velocity arrays staggered at C-grid locations.
`chksum_u_2d()`	Checksums a 2d array staggered at C-grid u points.
`chksum_v_2d()`	Checksums a 2d array staggered at C-grid v points.
`chksum_h_3d()`	Checksums a 3d array staggered at tracer points.
`chksum_b_3d()`	Checksums a 3d array staggered at corner points.
`chksum_u_3d()`	Checksums a 3d array staggered at C-grid u points.
`chksum_v_3d()`	Checksums a 3d array staggered at C-grid v points.
`chksum1d()`	chksum1d does a checksum of a 1-dimensional array.
`chksum2d()`	chksum2d does a checksum of all data in a 2-d array.
`chksum3d()`	chksum3d does a checksum of all data in a 2-d array.
`is_nan_0d()`	This function returns .true.
`is_nan_1d()`	Returns .true.
`is_nan_2d()`	Returns .true.
`is_nan_3d()`	Returns .true.
`chk_sum_msg1()`	Write a message including the checksum of the non-shifted array.
`chk_sum_msg5()`	Write a message including checksums of non-shifted and diagonally shifted arrays.
`chk_sum_msg_nsew()`	Write a message including checksums of non-shifted and laterally shifted arrays.
`chk_sum_msg_s()`	Write a message including checksums of non-shifted and southward shifted arrays.
`chk_sum_msg_w()`	Write a message including checksums of non-shifted and westward shifted arrays.
`chk_sum_msg2()`	Write a message including checksums of non-shifted and southwestward shifted arrays.
`chk_sum_msg3()`	Write a message including the global mean, maximum and minimum of an array.
`mom_checksums_init()`	MOM_checksums_init initializes the MOM_checksums module.
`chksum_error()`	A wrapper for MOM_error used in the checksum code.
`bitcount()`	Does a bitcount of a number by first casting to an integer and then using BTEST to check bit by bit.

Detailed Description¶

Routines to calculate checksums of various array and vector types.

Function/Subroutine Documentation¶

subroutine mom_checksums/chksum0(scalar, mesg, scale, logunit)¶

Checksum a scalar field (consistent with array checksums)

Parameters

scalar :: [in] The array to be checksummed
mesg :: [in] An identifying message
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging

Call to

bc_modulus bitcount calculatestatistics checkfornans chksum_error mom_error_handler::is_root_pe writechksums

subroutine mom_checksums/zchksum(array, mesg, scale, logunit)¶

Checksum a 1d array (typically a column).

Parameters

array :: [in] The array to be checksummed
mesg :: [in] An identifying message
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging

Call to

calculatestatistics checkfornans chksum_error mom_error_handler::is_root_pe subchk substats writechksums

subroutine mom_checksums/chksum_pair_h_2d(mesg, arrayA, arrayB, HI, haloshift, omit_corners, scale, logunit, scalar_pair)¶

Checksums on a pair of 2d arrays staggered at tracer points.

Parameters

mesg :: [in] Identifying messages
hi :: [in] A horizontal index type
arraya :: [in] The first array to be checksummed
arrayb :: [in] The second array to be checksummed
haloshift :: [in] The width of halos to check (default 0)
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging
scalar_pair :: [in] If true, then the arrays describe a scalar, rather than vector

Call to

chksum_h_2d mom_hor_index::rotate_hor_index

subroutine mom_checksums/chksum_pair_h_3d(mesg, arrayA, arrayB, HI, haloshift, omit_corners, scale, logunit, scalar_pair)¶

Checksums on a pair of 3d arrays staggered at tracer points.

Parameters

mesg :: [in] Identifying messages
hi :: [in] A horizontal index type
arraya :: [in] The first array to be checksummed
arrayb :: [in] The second array to be checksummed
haloshift :: [in] The width of halos to check (default 0)
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging
scalar_pair :: [in] If true, then the arrays describe a scalar, rather than vector

Call to

chksum_h_3d mom_hor_index::rotate_hor_index

subroutine mom_checksums/chksum_h_2d(array_m, mesg, HI_m, haloshift, omit_corners, scale, logunit)¶

Checksums a 2d array staggered at tracer points.

Parameters

hi_m :: [in] Horizontal index bounds of the model grid
array_m :: [in] Field array on the model grid
mesg :: [in] An identifying message
haloshift :: [in] The width of halos to check (default 0)
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging

Call to

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

Called from

chksum_pair_h_2d

subroutine mom_checksums/chksum_pair_b_2d(mesg, arrayA, arrayB, HI, haloshift, symmetric, omit_corners, scale, logunit, scalar_pair)¶

Checksums on a pair of 2d arrays staggered at q-points.

Parameters

mesg :: [in] Identifying messages
hi :: [in] A horizontal index type
arraya :: [in] The first array to be checksummed
arrayb :: [in] The second array to be checksummed
symmetric :: [in] If true, do the checksums on the full symmetric computational domain.
haloshift :: [in] The width of halos to check (default 0)
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging
scalar_pair :: [in] If true, then the arrays describe a scalar, rather than vector

Call to

chksum_b_2d mom_hor_index::rotate_hor_index

subroutine mom_checksums/chksum_pair_b_3d(mesg, arrayA, arrayB, HI, haloshift, symmetric, omit_corners, scale, logunit, scalar_pair)¶

Checksums on a pair of 3d arrays staggered at q-points.

Parameters

mesg :: [in] Identifying messages
hi :: [in] A horizontal index type
arraya :: [in] The first array to be checksummed
arrayb :: [in] The second array to be checksummed
haloshift :: [in] The width of halos to check (default 0)
symmetric :: [in] If true, do the checksums on the full symmetric computational domain.
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging
scalar_pair :: [in] If true, then the arrays describe a scalar, rather than vector

Call to

chksum_b_3d mom_hor_index::rotate_hor_index

subroutine mom_checksums/chksum_b_2d(array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit)¶

Checksums a 2d array staggered at corner points.

Parameters

hi_m :: [in] A horizontal index type
array_m :: [in] The array to be checksummed
mesg :: [in] An identifying message
haloshift :: [in] The width of halos to check (default 0)
symmetric :: [in] If true, do the checksums on the full symmetric computational domain.
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging

Call to

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

Called from

chksum_pair_b_2d

subroutine mom_checksums/chksum_uv_2d(mesg, arrayU, arrayV, HI, haloshift, symmetric, omit_corners, scale, logunit, scalar_pair)¶

Checksums a pair of 2d velocity arrays staggered at C-grid locations.

Parameters

mesg :: [in] Identifying messages
hi :: [in] A horizontal index type
arrayu :: [in] The u-component array to be checksummed
arrayv :: [in] The v-component array to be checksummed
haloshift :: [in] The width of halos to check (default 0)
symmetric :: [in] If true, do the checksums on the full symmetric computational domain.
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for these arrays.
logunit :: [in] IO unit for checksum logging
scalar_pair :: [in] If true, then the arrays describe a a scalar, rather than vector

Call to

chksum_u_2d chksum_v_2d mom_hor_index::rotate_hor_index

subroutine mom_checksums/chksum_uv_3d(mesg, arrayU, arrayV, HI, haloshift, symmetric, omit_corners, scale, logunit, scalar_pair)¶

Checksums a pair of 3d velocity arrays staggered at C-grid locations.

Parameters

mesg :: [in] Identifying messages
hi :: [in] A horizontal index type
arrayu :: [in] The u-component array to be checksummed
arrayv :: [in] The v-component array to be checksummed
haloshift :: [in] The width of halos to check (default 0)
symmetric :: [in] If true, do the checksums on the full symmetric computational domain.
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for these arrays.
logunit :: [in] IO unit for checksum logging
scalar_pair :: [in] If true, then the arrays describe a a scalar, rather than vector

Call to

chksum_u_3d chksum_v_3d mom_hor_index::rotate_hor_index

subroutine mom_checksums/chksum_u_2d(array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit)¶

Checksums a 2d array staggered at C-grid u points.

Parameters

hi_m :: [in] A horizontal index type
array_m :: [in] The array to be checksummed
mesg :: [in] An identifying message
haloshift :: [in] The width of halos to check (default 0)
symmetric :: [in] If true, do the checksums on the full symmetric computational domain.
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging

Call to

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

Called from

chksum_uv_2d

subroutine mom_checksums/chksum_v_2d(array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit)¶

Checksums a 2d array staggered at C-grid v points.

Parameters

hi_m :: [in] A horizontal index type
array_m :: [in] The array to be checksummed
mesg :: [in] An identifying message
haloshift :: [in] The width of halos to check (default 0)
symmetric :: [in] If true, do the checksums on the full symmetric computational domain.
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging

Call to

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

Called from

chksum_uv_2d

subroutine mom_checksums/chksum_h_3d(array_m, mesg, HI_m, haloshift, omit_corners, scale, logunit)¶

Checksums a 3d array staggered at tracer points.

Parameters

hi_m :: [in] A horizontal index type
array_m :: [in] The array to be checksummed
mesg :: [in] An identifying message
haloshift :: [in] The width of halos to check (default 0)
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging

Call to

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

Called from

chksum_pair_h_3d

subroutine mom_checksums/chksum_b_3d(array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit)¶

Checksums a 3d array staggered at corner points.

Parameters

hi_m :: [in] A horizontal index type
array_m :: [in] The array to be checksummed
mesg :: [in] An identifying message
haloshift :: [in] The width of halos to check (default 0)
symmetric :: [in] If true, do the checksums on the full symmetric computational domain.
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging

Call to

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

Called from

chksum_pair_b_3d

subroutine mom_checksums/chksum_u_3d(array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit)¶

Checksums a 3d array staggered at C-grid u points.

Parameters

hi_m :: [in] A horizontal index type
array_m :: [in] The array to be checksummed
mesg :: [in] An identifying message
haloshift :: [in] The width of halos to check (default 0)
symmetric :: [in] If true, do the checksums on the full symmetric computational domain.
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging

Call to

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

Called from

chksum_uv_3d

subroutine mom_checksums/chksum_v_3d(array_m, mesg, HI_m, haloshift, symmetric, omit_corners, scale, logunit)¶

Checksums a 3d array staggered at C-grid v points.

Parameters

hi_m :: [in] A horizontal index type
array_m :: [in] The array to be checksummed
mesg :: [in] An identifying message
haloshift :: [in] The width of halos to check (default 0)
symmetric :: [in] If true, do the checksums on the full symmetric computational domain.
omit_corners :: [in] If true, avoid checking diagonal shifts
scale :: [in] A scaling factor for this array.
logunit :: [in] IO unit for checksum logging

Call to

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

Called from

chksum_uv_3d

subroutine mom_checksums/chksum1d(array, mesg, start_i, end_i, compare_PEs)¶

chksum1d does a checksum of a 1-dimensional array.

Parameters

array :: [in] The array to be summed (index starts at 1).
mesg :: [in] An identifying message.
start_i :: [in] The starting index for the sum (default 1)
end_i :: [in] The ending index for the sum (default all)
compare_pes :: [in] If true, compare across PEs instead of summing and list the root_PE value (default true)

Call to