mom_checksum_packages::mom_state_chksum Interface Reference

Detailed Description

Definition at line 38 of file MOM_checksum_packages.F90.

Private functions
subroutine	mom_state_chksum_5arg (mesg, u, v, h, uh, vh, G, GV, haloshift, symmetric)
subroutine	mom_state_chksum_3arg (mesg, u, v, h, G, GV, haloshift, symmetric)

Functions and subroutines

mom_state_chksum_3arg()

subroutine mom_checksum_packages::mom_state_chksum::mom_state_chksum_3arg ( character(len=*), intent(in)  mesg, real, dimension(szib_(g),szj_(g),szk_(g)), intent(in)  u, real, dimension(szi_(g),szjb_(g),szk_(g)), intent(in)  v, real, dimension(szi_(g),szj_(g),szk_(g)), intent(in)  h, type(ocean_grid_type), intent(in)  G, type(verticalgrid_type), intent(in)  GV, integer, intent(in), optional  haloshift, logical, intent(in), optional  symmetric  )

private

Parameters

[in]	mesg	A message that appears on the chksum lines.
[in]	g	The ocean's grid structure.
[in]	gv	The ocean's vertical grid structure.
[in]	u	Zonal velocity, in m s-1.
[in]	v	Meridional velocity, in m s-1.
[in]	h	Layer thicknesses, in H (usually m or kg m-2).

Definition at line 99 of file MOM_checksum_packages.F90.

  character(len=*),        intent(in) :: mesg !< A message that appears on the chksum lines.
  type(ocean_grid_type),   intent(in) :: g    !< The ocean's grid structure.
  type(verticalgrid_type), intent(in) :: gv   !< The ocean's vertical grid structure.
  real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
                           intent(in) :: u    !< Zonal velocity, in m s-1.
  real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
                           intent(in) :: v    !< Meridional velocity, in m s-1.
  real, dimension(SZI_(G),SZJ_(G),SZK_(G)),  &
                           intent(in) :: h    !< Layer thicknesses, in H (usually m or kg m-2).
  integer, optional,       intent(in) :: haloshift
  logical, optional,       intent(in) :: symmetric
!   This subroutine writes out chksums for the model's basic state variables.
! Arguments: mesg - A message that appears on the chksum lines.
!  (in)      u - Zonal velocity, in m s-1.
!  (in)      v - Meridional velocity, in m s-1.
!  (in)      h - Layer thickness, in m.
!  (in)      uh - Volume flux through zonal faces = u*h*dy, m3 s-1.
!  (in)      vh - Volume flux through meridional faces = v*h*dx, in m3 s-1.
!  (in)      G - The ocean's grid structure.
!  (in)      GV - The ocean's vertical grid structure.
  integer :: is, ie, js, je, nz, hs
  logical :: sym
  is = g%isc ; ie = g%iec ; js = g%jsc ; je = g%jec ; nz = g%ke

  ! Note that for the chksum calls to be useful for reproducing across PE
  ! counts, there must be no redundant points, so all variables use is..ie
  ! and js...je as their extent.
  hs=1; if (present(haloshift)) hs=haloshift
  sym=.false.; if (present(symmetric)) sym=symmetric
  call uvchksum(mesg//" u", u, v, g%HI,haloshift=hs, symmetric=sym)
  call hchksum(h, mesg//" h",g%HI, haloshift=hs, scale=gv%H_to_m)

mom_state_chksum_5arg()

subroutine mom_checksum_packages::mom_state_chksum::mom_state_chksum_5arg ( character(len=*), intent(in)  mesg, real, dimension( g %isdb: g %iedb, g %jsd: g %jed, g %ke), intent(in)  u, real, dimension( g %isd: g %ied, g %jsdb: g %jedb, g %ke), intent(in)  v, real, dimension( g %isd: g %ied, g %jsd: g %jed, g %ke), intent(in)  h, real, dimension( g %isdb: g %iedb, g %jsd: g %jed, g %ke), intent(in)  uh, real, dimension( g %isd: g %ied, g %jsdb: g %jedb, g %ke), intent(in)  vh, type(ocean_grid_type), intent(in)  G, type(verticalgrid_type), intent(in)  GV, integer, intent(in), optional  haloshift, logical, intent(in), optional  symmetric  )

private

Parameters

[in]	mesg	A message that appears on the chksum lines.
[in]	g	The ocean's grid structure.
[in]	gv	The ocean's vertical grid structure.
[in]	u	The zonal velocity, in m s-1.
[in]	v	The meridional velocity, in m s-1.
[in]	h	Layer thicknesses, in H (usually m or kg m-2).
[in]	uh	Volume flux through zonal faces = u*h*dy, m3 s-1.
[in]	vh	Volume flux through meridional

Definition at line 55 of file MOM_checksum_packages.F90.

  character(len=*),                          &
                           intent(in) :: mesg !< A message that appears on the chksum lines.
  type(ocean_grid_type),   intent(in) :: g    !< The ocean's grid structure.
  type(verticalgrid_type), intent(in) :: gv   !< The ocean's vertical grid structure.
  real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
                           intent(in) :: u    !< The zonal velocity, in m s-1.
  real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
                           intent(in) :: v    !< The meridional velocity, in m s-1.
  real, dimension(SZI_(G),SZJ_(G),SZK_(G)),  &
                           intent(in) :: h    !< Layer thicknesses, in H (usually m or kg m-2).
  real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
                           intent(in) :: uh   !< Volume flux through zonal faces = u*h*dy, m3 s-1.
  real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
                           intent(in) :: vh   !< Volume flux through meridional
                                              !! faces = v*h*dx, in m3 s-1.
  integer, optional,       intent(in) :: haloshift
  logical, optional,       intent(in) :: symmetric
!   This subroutine writes out chksums for the model's basic state variables.
! Arguments: mesg - A message that appears on the chksum lines.
!  (in)      u - Zonal velocity, in m s-1.
!  (in)      v - Meridional velocity, in m s-1.
!  (in)      h - Layer thickness, in m.
!  (in)      uh - Volume flux through zonal faces = u*h*dy, m3 s-1.
!  (in)      vh - Volume flux through meridional faces = v*h*dx, in m3 s-1.
!  (in)      G - The ocean's grid structure.
!  (in)      GV - The ocean's vertical grid structure.
  integer :: is, ie, js, je, nz, hs
  logical :: sym
  is = g%isc ; ie = g%iec ; js = g%jsc ; je = g%jec ; nz = g%ke

  ! Note that for the chksum calls to be useful for reproducing across PE
  ! counts, there must be no redundant points, so all variables use is..ie
  ! and js...je as their extent.
  hs=1; if (present(haloshift)) hs=haloshift
  sym=.false.; if (present(symmetric)) sym=symmetric
  call uvchksum(mesg//" [uv]", u, v, g%HI, haloshift=hs, symmetric=sym)
  call hchksum(h, mesg//" h", g%HI, haloshift=hs, scale=gv%H_to_m)
  call uvchksum(mesg//" [uv]h", uh, vh, g%HI, haloshift=hs, &
                symmetric=sym, scale=gv%H_to_m)

---

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

• /home/adcroft/GitHub/workspace/Gaea-stats-MOM6-examples/MOM6-examples/src/MOM6/src/core/MOM_checksum_packages.F90