From 6f7f67bc8bb4412ebee35447666c5e61a687bfdc Mon Sep 17 00:00:00 2001 From: Robert Hallberg Date: Thu, 3 May 2018 11:13:07 -0400 Subject: [PATCH] dOxyGenized the vertical_grid_type Added dOxyGen comments for elements of the verticalGrid_type and the arguments to verticalGridInit. All answers are bitwise identical. --- src/core/MOM_verticalGrid.F90 | 80 +++++++++++++++++------------------ 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/src/core/MOM_verticalGrid.F90 b/src/core/MOM_verticalGrid.F90 index a57bd1f61f..c03a811400 100644 --- a/src/core/MOM_verticalGrid.F90 +++ b/src/core/MOM_verticalGrid.F90 @@ -16,50 +16,50 @@ module MOM_verticalGrid type, public :: verticalGrid_type ! Commonly used parameters - integer :: ke ! The number of layers/levels in the vertical - real :: max_depth ! The maximum depth of the ocean in meters. - real :: g_Earth ! The gravitational acceleration in m s-2. - real :: Rho0 ! The density used in the Boussinesq approximation or - ! nominal density used to convert depths into mass - ! units, in kg m-3. + integer :: ke !< The number of layers/levels in the vertical + real :: max_depth !< The maximum depth of the ocean in meters. + real :: g_Earth !< The gravitational acceleration in m s-2. + real :: Rho0 !< The density used in the Boussinesq approximation or + !! nominal density used to convert depths into mass + !! units, in kg m-3. ! Vertical coordinate descriptions for diagnostics and I/O character(len=40) :: & - zAxisUnits, & ! The units that vertical coordinates are written in - zAxisLongName ! Coordinate name to appear in files, - ! e.g. "Target Potential Density" or "Height" - real ALLOCABLE_, dimension(NKMEM_) :: sLayer ! Coordinate values of layer centers - real ALLOCABLE_, dimension(NK_INTERFACE_) :: sInterface ! Coordinate values on interfaces - integer :: direction = 1 ! Direction defaults to 1, positive up. + zAxisUnits, & !< The units that vertical coordinates are written in + zAxisLongName !< Coordinate name to appear in files, + !! e.g. "Target Potential Density" or "Height" + real ALLOCABLE_, dimension(NKMEM_) :: sLayer !< Coordinate values of layer centers + real ALLOCABLE_, dimension(NK_INTERFACE_) :: sInterface !< Coordinate values on interfaces + integer :: direction = 1 !< Direction defaults to 1, positive up. ! The following variables give information about the vertical grid. - logical :: Boussinesq ! If true, make the Boussinesq approximation. - real :: Angstrom ! A one-Angstrom thickness in the model's thickness - ! units. (This replaces the old macro EPSILON.) - real :: Angstrom_z ! A one-Angstrom thickness in m. - real :: H_subroundoff ! A thickness that is so small that it can be added to - ! a thickness of Angstrom or larger without changing it - ! at the bit level, in thickness units. If Angstrom is - ! 0 or exceedingly small, this is negligible compared to - ! a thickness of 1e-17 m. + logical :: Boussinesq !< If true, make the Boussinesq approximation. + real :: Angstrom !< A one-Angstrom thickness in the model's thickness + !! units. (This replaces the old macro EPSILON.) + real :: Angstrom_z !< A one-Angstrom thickness in m. + real :: H_subroundoff !< A thickness that is so small that it can be added to + !! a thickness of Angstrom or larger without changing it + !! at the bit level, in thickness units. If Angstrom is + !! 0 or exceedingly small, this is negligible compared to + !! a thickness of 1e-17 m. real ALLOCABLE_, dimension(NK_INTERFACE_) :: & - g_prime, & ! The reduced gravity at each interface, in m s-2. - Rlay ! The target coordinate value (potential density) in - ! in each layer in kg m-3. - integer :: nkml = 0 ! The number of layers at the top that should be treated - ! as parts of a homogenous region. - integer :: nk_rho_varies = 0 ! The number of layers at the top where the - ! density does not track any target density. - real :: H_to_kg_m2 ! A constant that translates thicknesses from the units - ! of thickness to kg m-2. - real :: kg_m2_to_H ! A constant that translates thicknesses from kg m-2 to - ! the units of thickness. - real :: m_to_H ! A constant that translates distances in m to the - ! units of thickness. - real :: H_to_m ! A constant that translates distances in the units of - ! thickness to m. - real :: H_to_Pa ! A constant that translates the units of thickness to - ! to pressure in Pa. + g_prime, & !< The reduced gravity at each interface, in m s-2. + Rlay !< The target coordinate value (potential density) in + !! in each layer in kg m-3. + integer :: nkml = 0 !< The number of layers at the top that should be treated + !! as parts of a homogenous region. + integer :: nk_rho_varies = 0 !< The number of layers at the top where the + !! density does not track any target density. + real :: H_to_kg_m2 !< A constant that translates thicknesses from the units + !! of thickness to kg m-2. + real :: kg_m2_to_H !< A constant that translates thicknesses from kg m-2 to + !! the units of thickness. + real :: m_to_H !< A constant that translates distances in m to the + !! units of thickness. + real :: H_to_m !< A constant that translates distances in the units of + !! thickness to m. + real :: H_to_Pa !< A constant that translates the units of thickness to + !! to pressure in Pa. end type verticalGrid_type contains @@ -68,8 +68,8 @@ module MOM_verticalGrid subroutine verticalGridInit( param_file, GV ) ! This routine initializes the verticalGrid_type structure (GV). ! All memory is allocated but not necessarily set to meaningful values until later. - type(param_file_type), intent(in) :: param_file ! Parameter file handle/type - type(verticalGrid_type), pointer :: GV ! The container for vertical grid data + type(param_file_type), intent(in) :: param_file !< Parameter file handle/type + type(verticalGrid_type), pointer :: GV !< The container for vertical grid data ! This include declares and sets the variable "version". #include "version_variable.h" integer :: nk, H_power