MOM6
mom_checksums::chk_sum_msg Interface Reference

Detailed Description

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

Definition at line 69 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...
 

Detailed Description

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

Definition at line 69 of file MOM_checksums.F90.

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 2077 of file MOM_checksums.F90.

2077  character(len=*), intent(in) :: fmsg !< A checksum code-location specific preamble
2078  character(len=*), intent(in) :: mesg !< An identifying message supplied by top-level caller
2079  integer, intent(in) :: bc0 !< The bitcount of the non-shifted array
2080  integer, intent(in) :: iounit !< Checksum logger IO unit
2081 
2082  if (is_root_pe()) &
2083  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 2142 of file MOM_checksums.F90.

2142  character(len=*), intent(in) :: fmsg !< A checksum code-location specific preamble
2143  character(len=*), intent(in) :: mesg !< An identifying message supplied by top-level caller
2144  integer, intent(in) :: bc0 !< The bitcount of the non-shifted array
2145  integer, intent(in) :: bcsw !< The bitcount of the southwest-shifted array
2146  integer, intent(in) :: iounit !< Checksum logger IO unit
2147 
2148  if (is_root_pe()) write(iounit, '(A,2(A,I9,1X),A)') &
2149  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 2154 of file MOM_checksums.F90.

2154  character(len=*), intent(in) :: fmsg !< A checksum code-location specific preamble
2155  character(len=*), intent(in) :: mesg !< An identifying message supplied by top-level caller
2156  real, intent(in) :: amean !< The mean value of the array
2157  real, intent(in) :: amin !< The minimum value of the array
2158  real, intent(in) :: amax !< The maximum value of the array
2159  integer, intent(in) :: iounit !< Checksum logger IO unit
2160 
2161  ! NOTE: We add zero to aMin and aMax to remove any negative zeros.
2162  ! This is due to inconsistencies of signed zero in local vs MPI calculations.
2163 
2164  if (is_root_pe()) write(iounit, '(A,3(A,ES25.16,1X),A)') &
2165  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 2088 of file MOM_checksums.F90.

2088  character(len=*), intent(in) :: fmsg !< A checksum code-location specific preamble
2089  character(len=*), intent(in) :: mesg !< An identifying message supplied by top-level caller
2090  integer, intent(in) :: bc0 !< The bitcount of the non-shifted array
2091  integer, intent(in) :: bcsw !< The bitcount for SW shifted array
2092  integer, intent(in) :: bcse !< The bitcount for SE shifted array
2093  integer, intent(in) :: bcnw !< The bitcount for NW shifted array
2094  integer, intent(in) :: bcne !< The bitcount for NE shifted array
2095  integer, intent(in) :: iounit !< Checksum logger IO unit
2096 
2097  if (is_root_pe()) write(iounit, '(A,5(A,I10,1X),A)') &
2098  fmsg, " c=", bc0, "sw=", bcsw, "se=", bcse, "nw=", bcnw, "ne=", bcne, trim(mesg)

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