mom_debugging::vec_chksum Interface Reference

Detailed Description

Do checksums on the components of a C-grid vector.

Definition at line 52 of file MOM_debugging.F90.

Private functions
subroutine	chksum_vec_c3d (mesg, u_comp, v_comp, G, halos, scalars)
	Do a checksum and redundant point check on a 3d C-grid vector. More...
subroutine	chksum_vec_c2d (mesg, u_comp, v_comp, G, halos, scalars)
	Do a checksum and redundant point check on a 2d C-grid vector. More...

Functions and subroutines

chksum_vec_c2d()

subroutine mom_debugging::vec_chksum::chksum_vec_c2d ( character(len=*), intent(in)  mesg, real, dimension(g%isdb:,g%jsd:), intent(in)  u_comp, real, dimension(g%isd:,g%jsdb:), intent(in)  v_comp, type(ocean_grid_type), intent(inout)  G, integer, intent(in), optional  halos, logical, intent(in), optional  scalars  )

private

Do a checksum and redundant point check on a 2d C-grid vector.

Parameters

[in]	mesg	An identifying message
[in,out]	g	The ocean's grid structure
[in]	u_comp	The u-component of the vector
[in]	v_comp	The v-component of the vector
[in]	halos	The width of halos to check (default 0)
[in]	scalars	If true this is a pair of scalars that are being checked.

Definition at line 590 of file MOM_debugging.F90.

  character(len=*),                intent(in)    :: mesg   !< An identifying message
  type(ocean_grid_type),           intent(inout) :: G      !< The ocean's grid structure
  real, dimension(G%IsdB:,G%jsd:), intent(in)    :: u_comp !< The u-component of the vector
  real, dimension(G%isd:,G%JsdB:), intent(in)    :: v_comp !< The v-component of the vector
  integer,               optional, intent(in)    :: halos  !< The width of halos to check (default 0)
  logical,               optional, intent(in)    :: scalars !< If true this is a pair of
                                                           !! scalars that are being checked.
  ! Local variables
  logical :: are_scalars
  are_scalars = .false. ; if (present(scalars)) are_scalars = scalars
 
  if (debug_chksums) then
    call uvchksum(mesg, u_comp, v_comp, g%HI, halos)
  endif
  if (debug_redundant) then
    if (are_scalars) then
      call check_redundant_c(mesg, u_comp, v_comp, g, direction=to_all+scalar_pair)
    else
      call check_redundant_c(mesg, u_comp, v_comp, g)
    endif
  endif
 

chksum_vec_c3d()

subroutine mom_debugging::vec_chksum::chksum_vec_c3d ( character(len=*), intent(in)  mesg, real, dimension(g%isdb:,g%jsd:,:), intent(in)  u_comp, real, dimension(g%isd:,g%jsdb:,:), intent(in)  v_comp, type(ocean_grid_type), intent(inout)  G, integer, intent(in), optional  halos, logical, intent(in), optional  scalars  )

private

Do a checksum and redundant point check on a 3d C-grid vector.

Parameters

[in]	mesg	An identifying message
[in,out]	g	The ocean's grid structure
[in]	u_comp	The u-component of the vector
[in]	v_comp	The v-component of the vector
[in]	halos	The width of halos to check (default 0)
[in]	scalars	If true this is a pair of scalars that are being checked.

Definition at line 564 of file MOM_debugging.F90.

  character(len=*),                  intent(in)    :: mesg   !< An identifying message
  type(ocean_grid_type),             intent(inout) :: G      !< The ocean's grid structure
  real, dimension(G%IsdB:,G%jsd:,:), intent(in)    :: u_comp !< The u-component of the vector
  real, dimension(G%isd:,G%JsdB:,:), intent(in)    :: v_comp !< The v-component of the vector
  integer,                 optional, intent(in)    :: halos  !< The width of halos to check (default 0)
  logical,                 optional, intent(in)    :: scalars !< If true this is a pair of
                                                             !! scalars that are being checked.
  ! Local variables
  logical :: are_scalars
  are_scalars = .false. ; if (present(scalars)) are_scalars = scalars
 
  if (debug_chksums) then
    call uvchksum(mesg, u_comp, v_comp, g%HI, halos)
  endif
  if (debug_redundant) then
    if (are_scalars) then
      call check_redundant_c(mesg, u_comp, v_comp, g, direction=to_all+scalar_pair)
    else
      call check_redundant_c(mesg, u_comp, v_comp, g)
    endif
  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/diagnostics/MOM_debugging.F90