mom_checksums::chksum Interface Reference

Detailed Description

Definition at line 69 of file MOM_checksums.F90.

Private functions
subroutine	chksum1d (array, mesg, start_i, end_i, compare_PEs)
	chksum1d does a checksum of a 1-dimensional array. More...
subroutine	chksum2d (array, mesg)
	chksum2d does a checksum of all data in a 2-d array. More...
subroutine	chksum3d (array, mesg)
	chksum3d does a checksum of all data in a 2-d array. More...

Functions and subroutines

chksum1d()

subroutine mom_checksums::chksum::chksum1d ( real, dimension(:), intent(in)  array, character(len=*), intent(in)  mesg, integer, intent(in), optional  start_i, integer, intent(in), optional  end_i, logical, intent(in), optional  compare_PEs  )

private

chksum1d does a checksum of a 1-dimensional array.

Parameters

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

Definition at line 1201 of file MOM_checksums.F90.

  real, dimension(:), intent(in) :: array   !< The array to be summed (index starts at 1).
  character(len=*),   intent(in) :: mesg    !< An identifying message.
  integer, optional,  intent(in) :: start_i !< The starting index for the sum (default 1)
  integer, optional,  intent(in) :: end_i   !< The ending index for the sum (default all)
  logical, optional,  intent(in) :: compare_pes !< If true, compare across PEs instead of summing
                                                !! and list the root_PE value (default true)

  integer :: is, ie, i, bc, sum1, sum_bc
  integer :: bitcount
  real :: sum
  real, allocatable :: sum_here(:)
  logical :: compare
  integer :: pe_num   ! pe number of the data
  integer :: npes     ! Total number of processsors

  is = lbound(array,1) ; ie = ubound(array,1)
  if (present(start_i)) is = start_i
  if (present(end_i)) ie = end_i
  compare = .true. ; if (present(compare_pes)) compare = compare_pes

  sum = 0.0 ; sum_bc = 0
  do i=is,ie
    sum = sum + array(i)
    bc = bitcount(abs(array(i)))
    sum_bc = sum_bc + bc
  enddo

  pe_num = pe_here() + 1 - root_pe() ; npes = num_pes()
  allocate(sum_here(npes)) ; sum_here(:) = 0.0 ; sum_here(pe_num) = sum
  call sum_across_pes(sum_here,npes)

  sum1 = sum_bc
  call sum_across_pes(sum1)

  if (.not.compare) then
    sum = 0.0
    do i=1,npes ; sum = sum + sum_here(i) ; enddo
    sum_bc = sum1
  elseif (is_root_pe()) then
    if (sum1 /= npes*sum_bc) &
      write(0, '(A40," bitcounts do not match across PEs: ",I12,1X,I12)') &
            mesg, sum1, npes*sum_bc
    do i=1,npes ; if (sum /= sum_here(i)) then
      write(0, '(A40," PE ",i4," sum mismatches root_PE: ",3(ES22.13,1X))') &
            mesg, i, sum_here(i), sum, sum_here(i)-sum
    endif ; enddo
  endif
  deallocate(sum_here)

  if (is_root_pe()) &
    write(0,'(A50,1X,ES25.16,1X,I12)') mesg, sum, sum_bc

chksum2d()

subroutine mom_checksums::chksum::chksum2d ( real, dimension(:,:)  array, character(len=*)  mesg  )

private

chksum2d does a checksum of all data in a 2-d array.

Definition at line 1261 of file MOM_checksums.F90.

  real, dimension(:,:) :: array
  character(len=*) :: mesg

  integer :: bitcount
  integer :: xs,xe,ys,ye,i,j,sum1,bc
  real :: sum

  xs = lbound(array,1) ; xe = ubound(array,1)
  ys = lbound(array,2) ; ye = ubound(array,2)

  sum = 0.0 ; sum1 = 0
  do i=xs,xe ; do j=ys,ye
    bc = bitcount(abs(array(i,j)))
    sum1 = sum1 + bc
  enddo ; enddo
  call sum_across_pes(sum1)

  sum = reproducing_sum(array(:,:))

  if (is_root_pe()) &
    write(0,'(A50,1X,ES25.16,1X,I12)') mesg, sum, sum1
!    write(0,'(A40,1X,Z16.16,1X,Z16.16,1X,ES25.16,1X,I12)') &
!      mesg, sum, sum1, sum, sum1

chksum3d()

subroutine mom_checksums::chksum::chksum3d ( real, dimension(:,:,:)  array, character(len=*)  mesg  )

private

chksum3d does a checksum of all data in a 2-d array.

Definition at line 1290 of file MOM_checksums.F90.

  real, dimension(:,:,:) :: array
  character(len=*) :: mesg

  integer :: bitcount
  integer :: xs,xe,ys,ye,zs,ze,i,j,k, bc,sum1
  real :: sum

  xs = lbound(array,1) ; xe = ubound(array,1)
  ys = lbound(array,2) ; ye = ubound(array,2)
  zs = lbound(array,3) ; ze = ubound(array,3)

  sum = 0.0 ; sum1 = 0
  do i=xs,xe ; do j=ys,ye ; do k=zs,ze
    bc = bitcount(abs(array(i,j,k)))
    sum1 = sum1 + bc
  enddo ; enddo ; enddo

  call sum_across_pes(sum1)
  sum = reproducing_sum(array(:,:,:))

  if (is_root_pe()) &
    write(0,'(A50,1X,ES25.16,1X,I12)') mesg, sum, sum1
!    write(0,'(A40,1X,Z16.16,1X,Z16.16,1X,ES25.16,1X,I12)') &
!      mesg, sum, sum1, sum, sum1

---

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

• /home/adcroft/GitHub/workspace/Gaea-stats-MOM6-examples/MOM6-examples/src/MOM6/src/framework/MOM_checksums.F90