mom_checksums::uvchksum Interface Reference

Detailed Description

Checksums a pair velocity arrays (2d or 3d) staggered at C-grid locations.

Definition at line 28 of file MOM_checksums.F90.

Private functions
subroutine	chksum_uv_2d (mesg, arrayU, arrayV, HI, haloshift, symmetric, omit_corners, scale, logunit)
	Checksums a pair of 2d velocity arrays staggered at C-grid locations. More...
subroutine	chksum_uv_3d (mesg, arrayU, arrayV, HI, haloshift, symmetric, omit_corners, scale, logunit)
	Checksums a pair of 3d velocity arrays staggered at C-grid locations. More...

Functions and subroutines

chksum_uv_2d()

subroutine mom_checksums::uvchksum::chksum_uv_2d ( character(len=*), intent(in)  mesg, real, dimension(hi%isdb:,hi%jsd:), intent(in)  arrayU, real, dimension(hi%isd:,hi%jsdb:), intent(in)  arrayV, 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 a pair of 2d velocity arrays staggered at C-grid locations.

Parameters

[in]	mesg	Identifying messages
[in]	hi	A horizontal index type
[in]	arrayu	The u-component array to be checksummed
[in]	arrayv	The v-component 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 these arrays.
[in]	logunit	IO unit for checksum logging

Definition at line 589 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%jsd:), intent(in) :: arrayU !< The u-component array to be checksummed
  real, dimension(HI%isd:,HI%JsdB:), intent(in) :: arrayV !< The v-component 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 these arrays.
  integer,                 optional, intent(in) :: logunit !< IO unit for checksum logging
 
  if (present(haloshift)) then
    call chksum_u_2d(arrayu, 'u '//mesg, hi, haloshift, symmetric, &
                     omit_corners, scale, logunit=logunit)
    call chksum_v_2d(arrayv, 'v '//mesg, hi, haloshift, symmetric, &
                     omit_corners, scale, logunit=logunit)
  else
    call chksum_u_2d(arrayu, 'u '//mesg, hi, symmetric=symmetric, &
                     logunit=logunit)
    call chksum_v_2d(arrayv, 'v '//mesg, hi, symmetric=symmetric, &
                     logunit=logunit)
  endif
 

chksum_uv_3d()

subroutine mom_checksums::uvchksum::chksum_uv_3d ( character(len=*), intent(in)  mesg, real, dimension(hi%isdb:,hi%jsd:,:), intent(in)  arrayU, real, dimension(hi%isd:,hi%jsdb:,:), intent(in)  arrayV, 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 a pair of 3d velocity arrays staggered at C-grid locations.

Parameters

[in]	mesg	Identifying messages
[in]	hi	A horizontal index type
[in]	arrayu	The u-component array to be checksummed
[in]	arrayv	The v-component 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 these arrays.
[in]	logunit	IO unit for checksum logging

Definition at line 617 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%jsd:,:), intent(in) :: arrayU !< The u-component array to be checksummed
  real, dimension(HI%isd:,HI%JsdB:,:), intent(in) :: arrayV !< The v-component 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 these arrays.
  integer,                   optional, intent(in) :: logunit !< IO unit for checksum logging
 
  if (present(haloshift)) then
    call chksum_u_3d(arrayu, 'u '//mesg, hi, haloshift, symmetric, &
                     omit_corners, scale, logunit=logunit)
    call chksum_v_3d(arrayv, 'v '//mesg, hi, haloshift, symmetric, &
                     omit_corners, scale, logunit=logunit)
  else
    call chksum_u_3d(arrayu, 'u '//mesg, hi, symmetric=symmetric, &
                     logunit=logunit)
    call chksum_v_3d(arrayv, 'v '//mesg, hi, symmetric=symmetric, &
                     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