MOM6
mom_debugging::vec_chksum_a Interface Reference

Detailed Description

Do checksums on the components of an A-grid vector.

Definition at line 64 of file MOM_debugging.F90.

Private functions

subroutine chksum_vec_a3d (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_a2d (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_a2d()

subroutine mom_debugging::vec_chksum_a::chksum_vec_a2d ( character(len=*), intent(in)  mesg,
real, dimension(g%isd:,g%jsd:), intent(in)  u_comp,
real, dimension(g%isd:,g%jsd:), 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]mesgAn identifying message
[in,out]gThe ocean's grid structure
[in]u_compThe u-component of the vector
[in]v_compThe v-component of the vector
[in]halosThe width of halos to check (default 0)
[in]scalarsIf true this is a pair of scalars that are being checked.

Definition at line 699 of file MOM_debugging.F90.

699  character(len=*), intent(in) :: mesg !< An identifying message
700  type(ocean_grid_type), intent(inout) :: G !< The ocean's grid structure
701  real, dimension(G%isd:,G%jsd:), intent(in) :: u_comp !< The u-component of the vector
702  real, dimension(G%isd:,G%jsd:), intent(in) :: v_comp !< The v-component of the vector
703  integer, optional, intent(in) :: halos !< The width of halos to check (default 0)
704  logical, optional, intent(in) :: scalars !< If true this is a pair of
705  !! scalars that are being checked.
706  ! Local variables
707  logical :: are_scalars
708  are_scalars = .false. ; if (present(scalars)) are_scalars = scalars
709 
710  if (debug_chksums) then
711  call hchksum(u_comp, mesg//"(u)", g%HI, halos)
712  call hchksum(v_comp, mesg//"(v)", g%HI, halos)
713  endif
714  if (debug_redundant) then
715  if (are_scalars) then
716  call check_redundant_t(mesg, u_comp, v_comp, g, direction=to_all+scalar_pair)
717  else
718  call check_redundant_t(mesg, u_comp, v_comp, g)
719  endif
720  endif
721 

◆ chksum_vec_a3d()

subroutine mom_debugging::vec_chksum_a::chksum_vec_a3d ( character(len=*), intent(in)  mesg,
real, dimension(g%isd:,g%jsd:,:), intent(in)  u_comp,
real, dimension(g%isd:,g%jsd:,:), 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]mesgAn identifying message
[in,out]gThe ocean's grid structure
[in]u_compThe u-component of the vector
[in]v_compThe v-component of the vector
[in]halosThe width of halos to check (default 0)
[in]scalarsIf true this is a pair of scalars that are being checked.

Definition at line 672 of file MOM_debugging.F90.

672  character(len=*), intent(in) :: mesg !< An identifying message
673  type(ocean_grid_type), intent(inout) :: G !< The ocean's grid structure
674  real, dimension(G%isd:,G%jsd:,:), intent(in) :: u_comp !< The u-component of the vector
675  real, dimension(G%isd:,G%jsd:,:), intent(in) :: v_comp !< The v-component of the vector
676  integer, optional, intent(in) :: halos !< The width of halos to check (default 0)
677  logical, optional, intent(in) :: scalars !< If true this is a pair of
678  !! scalars that are being checked.
679  ! Local variables
680  logical :: are_scalars
681  are_scalars = .false. ; if (present(scalars)) are_scalars = scalars
682 
683  if (debug_chksums) then
684  call hchksum(u_comp, mesg//"(u)", g%HI, halos)
685  call hchksum(v_comp, mesg//"(v)", g%HI, halos)
686  endif
687  if (debug_redundant) then
688  if (are_scalars) then
689  call check_redundant_t(mesg, u_comp, v_comp, g, direction=to_all+scalar_pair)
690  else
691  call check_redundant_t(mesg, u_comp, v_comp, g)
692  endif
693  endif
694 

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