mom_checksums::bchksum_pair Interface Reference

Detailed Description

Checksums a pair of arrays (2d or 3d) staggered at corner points.

Definition at line 43 of file MOM_checksums.F90.

Private functions
subroutine	chksum_pair_b_2d (mesg, arrayA, arrayB, HI, haloshift, symmetric, omit_corners, scale, logunit)
	Checksums on a pair of 2d arrays staggered at q-points. More...
subroutine	chksum_pair_b_3d (mesg, arrayA, arrayB, HI, haloshift, symmetric, omit_corners, scale, logunit)
	Checksums on a pair of 3d arrays staggered at q-points. More...

Functions and subroutines

chksum_pair_b_2d()

subroutine mom_checksums::bchksum_pair::chksum_pair_b_2d ( character(len=*), intent(in)  mesg, real, dimension(hi%isd:,hi%jsd:), intent(in)  arrayA, real, dimension(hi%isd:,hi%jsd:), intent(in)  arrayB, type(hor_index_type), intent(in)  HI, integer, intent(in), optional  haloshift, logical, intent(in), optional  symmetric, logical, intent(in), optional  omit_corners, real, intent(in), optional  scale, integer, intent(in), optional  logunit  )

private

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

Parameters

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

Definition at line 377 of file MOM_checksums.F90.

  character(len=*),                 intent(in) :: mesg   !< Identifying messages
  type(hor_index_type),             intent(in) :: HI     !< A horizontal index type
  real, dimension(HI%isd:,HI%jsd:), intent(in) :: arrayA !< The first array to be checksummed
  real, dimension(HI%isd:,HI%jsd:), intent(in) :: arrayB !< The second array to be checksummed
  logical,                optional, intent(in) :: symmetric !< If true, do the checksums on the full
                                                            !! symmetric computational domain.
  integer,                optional, intent(in) :: haloshift !< The width of halos to check (default 0)
  logical,                optional, intent(in) :: omit_corners !< If true, avoid checking diagonal shifts
  real,                   optional, intent(in) :: scale     !< A scaling factor for this array.
  integer,                optional, intent(in) :: logunit !< IO unit for checksum logging
 
  logical :: sym
 
  sym = .false. ; if (present(symmetric)) sym = symmetric
 
  if (present(haloshift)) then
    call chksum_b_2d(arraya, 'x '//mesg, hi, haloshift, symmetric=sym, &
                     omit_corners=omit_corners, scale=scale, logunit=logunit)
    call chksum_b_2d(arrayb, 'y '//mesg, hi, haloshift, symmetric=sym, &
                     omit_corners=omit_corners, scale=scale, logunit=logunit)
  else
    call chksum_b_2d(arraya, 'x '//mesg, hi, symmetric=sym, scale=scale, &
                     logunit=logunit)
    call chksum_b_2d(arrayb, 'y '//mesg, hi, symmetric=sym, scale=scale, &
                     logunit=logunit)
  endif
 

chksum_pair_b_3d()

subroutine mom_checksums::bchksum_pair::chksum_pair_b_3d ( character(len=*), intent(in)  mesg, real, dimension(hi%isdb:,hi%jsdb:, :), intent(in)  arrayA, real, dimension(hi%isdb:,hi%jsdb:, :), intent(in)  arrayB, type(hor_index_type), intent(in)  HI, integer, intent(in), optional  haloshift, logical, intent(in), optional  symmetric, logical, intent(in), optional  omit_corners, real, intent(in), optional  scale, integer, intent(in), optional  logunit  )

private

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

Parameters

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

Definition at line 409 of file MOM_checksums.F90.

  character(len=*),                    intent(in) :: mesg !< Identifying messages
  type(hor_index_type),                intent(in) :: HI     !< A horizontal index type
  real, dimension(HI%IsdB:,HI%JsdB:, :), intent(in) :: arrayA !< The first array to be checksummed
  real, dimension(HI%IsdB:,HI%JsdB:, :), intent(in) :: arrayB !< The second array to be checksummed
  integer,                   optional, intent(in) :: haloshift !< The width of halos to check (default 0)
  logical,                   optional, intent(in) :: symmetric !< If true, do the checksums on the full
                                                               !! symmetric computational domain.
  logical,                   optional, intent(in) :: omit_corners !< If true, avoid checking diagonal shifts
  real,                      optional, intent(in) :: scale     !< A scaling factor for this array.
  integer,                   optional, intent(in) :: logunit !< IO unit for checksum logging
 
  logical :: sym
 
  if (present(haloshift)) then
    call chksum_b_3d(arraya, 'x '//mesg, hi, haloshift, symmetric, &
                     omit_corners, scale=scale, logunit=logunit)
    call chksum_b_3d(arrayb, 'y '//mesg, hi, haloshift, symmetric, &
                     omit_corners, scale=scale, logunit=logunit)
  else
    call chksum_b_3d(arraya, 'x '//mesg, hi, symmetric=symmetric, scale=scale, &
                     logunit=logunit)
    call chksum_b_3d(arrayb, 'y '//mesg, hi, symmetric=symmetric, scale=scale, &
                     logunit=logunit)
  endif
 

---

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

• /glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/framework/MOM_checksums.F90