From 187a40aa40ef84abd3842727e55504fd015ade92 Mon Sep 17 00:00:00 2001 From: Robert Hallberg Date: Thu, 3 May 2018 11:12:46 -0400 Subject: [PATCH] Added dOxyGen comments for alloc_BT_cont_type Added dOxyGen comments for MOM_thermovar_chksum and alloc_BT_cont_type, and eliminated some unused variables and inapplicable comments. All answers are bitwise identical. --- src/core/MOM_variables.F90 | 31 +++++++++++-------------------- 1 file changed, 11 insertions(+), 20 deletions(-) diff --git a/src/core/MOM_variables.F90 b/src/core/MOM_variables.F90 index f7fa45f12c..7425906de4 100644 --- a/src/core/MOM_variables.F90 +++ b/src/core/MOM_variables.F90 @@ -359,9 +359,10 @@ end subroutine deallocate_surface_state !> alloc_BT_cont_type allocates the arrays contained within a BT_cont_type and !! initializes them to 0. subroutine alloc_BT_cont_type(BT_cont, G, alloc_faces) - type(BT_cont_type), pointer :: BT_cont + type(BT_cont_type), pointer :: BT_cont !< The BT_cont_type whose elements will be allocated type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure - logical, optional, intent(in) :: alloc_faces + logical, optional, intent(in) :: alloc_faces !< If present and true, allocate + !! memory for effective face thicknesses. integer :: isd, ied, jsd, jed, IsdB, IedB, JsdB, JedB isd = G%isd ; ied = G%ied ; jsd = G%jsd ; jed = G%jed @@ -416,33 +417,23 @@ end subroutine dealloc_BT_cont_type !> MOM_thermovar_chksum does diagnostic checksums on various elements of a !! thermo_var_ptrs type for debugging. subroutine MOM_thermovar_chksum(mesg, tv, G) - character(len=*), intent(in) :: mesg - type(thermo_var_ptrs), intent(in) :: tv !< A structure pointing to various thermodynamic variables - type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure -! 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. - integer :: is, ie, js, je, nz - is = G%isc ; ie = G%iec ; js = G%jsc ; je = G%jec ; nz = G%ke + character(len=*), intent(in) :: mesg !< A message that appears in the checksum lines + type(thermo_var_ptrs), intent(in) :: tv !< A structure pointing to various thermodynamic variables + type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure ! 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. if (associated(tv%T)) & - call hchksum(tv%T, mesg//" tv%T",G%HI) + call hchksum(tv%T, mesg//" tv%T", G%HI) if (associated(tv%S)) & - call hchksum(tv%S, mesg//" tv%S",G%HI) + call hchksum(tv%S, mesg//" tv%S", G%HI) if (associated(tv%frazil)) & - call hchksum(tv%frazil, mesg//" tv%frazil",G%HI) + call hchksum(tv%frazil, mesg//" tv%frazil", G%HI) if (associated(tv%salt_deficit)) & - call hchksum(tv%salt_deficit, mesg//" tv%salt_deficit",G%HI) + call hchksum(tv%salt_deficit, mesg//" tv%salt_deficit", G%HI) if (associated(tv%TempxPmE)) & - call hchksum(tv%TempxPmE, mesg//" tv%TempxPmE",G%HI) + call hchksum(tv%TempxPmE, mesg//" tv%TempxPmE", G%HI) end subroutine MOM_thermovar_chksum end module MOM_variables