MOM6
mom_checksums::chk_sum_msg Interface Reference

Detailed Description

Write a message with either checksums or numerical statistics of arrays.

Definition at line 68 of file MOM_checksums.F90.

Private functions

subroutine chk_sum_msg1 (fmsg, bc0, mesg, iounit)
 Write a message including the checksum of the non-shifted array. More...
 
subroutine chk_sum_msg2 (fmsg, bc0, bcSW, mesg, iounit)
 Write a message including checksums of non-shifted and southwestward shifted arrays. More...
 
subroutine chk_sum_msg3 (fmsg, aMean, aMin, aMax, mesg, iounit)
 Write a message including the global mean, maximum and minimum of an array. More...
 
subroutine chk_sum_msg5 (fmsg, bc0, bcSW, bcSE, bcNW, bcNE, mesg, iounit)
 Write a message including checksums of non-shifted and diagonally shifted arrays. More...
 

Functions and subroutines

◆ chk_sum_msg1()

subroutine mom_checksums::chk_sum_msg::chk_sum_msg1 ( character(len=*), intent(in)  fmsg,
integer, intent(in)  bc0,
character(len=*), intent(in)  mesg,
integer, intent(in)  iounit 
)
private

Write a message including the checksum of the non-shifted array.

Parameters
[in]fmsgA checksum code-location specific preamble
[in]mesgAn identifying message supplied by top-level caller
[in]bc0The bitcount of the non-shifted array
[in]iounitChecksum logger IO unit

Definition at line 1741 of file MOM_checksums.F90.

1741  character(len=*), intent(in) :: fmsg !< A checksum code-location specific preamble
1742  character(len=*), intent(in) :: mesg !< An identifying message supplied by top-level caller
1743  integer, intent(in) :: bc0 !< The bitcount of the non-shifted array
1744  integer, intent(in) :: iounit !< Checksum logger IO unit
1745 
1746  if (is_root_pe()) &
1747  write(iounit, '(A,1(A,I10,X),A)') fmsg, " c=", bc0, trim(mesg)

◆ chk_sum_msg2()

subroutine mom_checksums::chk_sum_msg::chk_sum_msg2 ( character(len=*), intent(in)  fmsg,
integer, intent(in)  bc0,
integer, intent(in)  bcSW,
character(len=*), intent(in)  mesg,
integer, intent(in)  iounit 
)
private

Write a message including checksums of non-shifted and southwestward shifted arrays.

Parameters
[in]fmsgA checksum code-location specific preamble
[in]mesgAn identifying message supplied by top-level caller
[in]bc0The bitcount of the non-shifted array
[in]bcswThe bitcount of the southwest-shifted array
[in]iounitChecksum logger IO unit

Definition at line 1806 of file MOM_checksums.F90.

1806  character(len=*), intent(in) :: fmsg !< A checksum code-location specific preamble
1807  character(len=*), intent(in) :: mesg !< An identifying message supplied by top-level caller
1808  integer, intent(in) :: bc0 !< The bitcount of the non-shifted array
1809  integer, intent(in) :: bcSW !< The bitcount of the southwest-shifted array
1810  integer, intent(in) :: iounit !< Checksum logger IO unit
1811 
1812  if (is_root_pe()) write(iounit, '(A,2(A,I9,1X),A)') &
1813  fmsg, " c=", bc0, "s/w=", bcsw, trim(mesg)

◆ chk_sum_msg3()

subroutine mom_checksums::chk_sum_msg::chk_sum_msg3 ( character(len=*), intent(in)  fmsg,
real, intent(in)  aMean,
real, intent(in)  aMin,
real, intent(in)  aMax,
character(len=*), intent(in)  mesg,
integer, intent(in)  iounit 
)
private

Write a message including the global mean, maximum and minimum of an array.

Parameters
[in]fmsgA checksum code-location specific preamble
[in]mesgAn identifying message supplied by top-level caller
[in]ameanThe mean value of the array
[in]aminThe minimum value of the array
[in]amaxThe maximum value of the array
[in]iounitChecksum logger IO unit

Definition at line 1818 of file MOM_checksums.F90.

1818  character(len=*), intent(in) :: fmsg !< A checksum code-location specific preamble
1819  character(len=*), intent(in) :: mesg !< An identifying message supplied by top-level caller
1820  real, intent(in) :: aMean !< The mean value of the array
1821  real, intent(in) :: aMin !< The minimum value of the array
1822  real, intent(in) :: aMax !< The maximum value of the array
1823  integer, intent(in) :: iounit !< Checksum logger IO unit
1824 
1825  ! NOTE: We add zero to aMin and aMax to remove any negative zeros.
1826  ! This is due to inconsistencies of signed zero in local vs MPI calculations.
1827 
1828  if (is_root_pe()) write(iounit, '(A,3(A,ES25.16,1X),A)') &
1829  fmsg, " mean=", amean, "min=", (0. + amin), "max=", (0. + amax), trim(mesg)

◆ chk_sum_msg5()

subroutine mom_checksums::chk_sum_msg::chk_sum_msg5 ( character(len=*), intent(in)  fmsg,
integer, intent(in)  bc0,
integer, intent(in)  bcSW,
integer, intent(in)  bcSE,
integer, intent(in)  bcNW,
integer, intent(in)  bcNE,
character(len=*), intent(in)  mesg,
integer, intent(in)  iounit 
)
private

Write a message including checksums of non-shifted and diagonally shifted arrays.

Parameters
[in]fmsgA checksum code-location specific preamble
[in]mesgAn identifying message supplied by top-level caller
[in]bc0The bitcount of the non-shifted array
[in]bcswThe bitcount for SW shifted array
[in]bcseThe bitcount for SE shifted array
[in]bcnwThe bitcount for NW shifted array
[in]bcneThe bitcount for NE shifted array
[in]iounitChecksum logger IO unit

Definition at line 1752 of file MOM_checksums.F90.

1752  character(len=*), intent(in) :: fmsg !< A checksum code-location specific preamble
1753  character(len=*), intent(in) :: mesg !< An identifying message supplied by top-level caller
1754  integer, intent(in) :: bc0 !< The bitcount of the non-shifted array
1755  integer, intent(in) :: bcSW !< The bitcount for SW shifted array
1756  integer, intent(in) :: bcSE !< The bitcount for SE shifted array
1757  integer, intent(in) :: bcNW !< The bitcount for NW shifted array
1758  integer, intent(in) :: bcNE !< The bitcount for NE shifted array
1759  integer, intent(in) :: iounit !< Checksum logger IO unit
1760 
1761  if (is_root_pe()) write(iounit, '(A,5(A,I10,1X),A)') &
1762  fmsg, " c=", bc0, "sw=", bcsw, "se=", bcse, "nw=", bcnw, "ne=", bcne, trim(mesg)

The documentation for this interface was generated from the following file: