More chgres_cube doxygen (ufs-community#329)

* more doxygen changes * more doxygen * fixed comment * Minor doxygen updates to ./chgres_cube.fd/input_data.F90 Part of ufs-community#191 Fixes ufs-community#327 * More doxygen updates Part of ufs-community#191 Fixes ufs-community#327 * More doxygen updates to chgres_cube. Part of ufs-community#191. Fixes ufs-community#327. * More doxygen updates to ./chgres_cube.fd/surface.F90 Part of ufs-community#191 Fixes ufs-community#327 * Doxygen updates to ./chgres_cube.fd/surface.F90 Part of ufs-community#191 Fixes ufs-community#327 * More doxygen update to chgres_cube. Part of ufs-community#191 Fixes ufs-community#327 * Doxygen updates to ./chgres_cube.fd/search_util.f90 Part of ufs-community#191 Fixes of ufs-community#327 Co-authored-by: George Gayno <[email protected]>
GeorgeGayno-NOAA · Feb 23, 2021 · 7cb4339 · 7cb4339
1 parent 6e8ae7c
commit 7cb4339
Show file tree

Hide file tree

Showing 5 changed files with 296 additions and 357 deletions.
diff --git a/sorc/chgres_cube.fd/chgres.F90 b/sorc/chgres_cube.fd/chgres.F90
@@ -1,19 +1,22 @@
 !> @file
 !! @brief Initialize an FV3 model run.
 !!
+!! @author George Gayno NOAA/EMC
+
+!> Initialize an FV3 model run.
+!!
 !! Initialize an FV3 run using history or restart data from another
 !! FV3 run, the spectral GFS, and a few other models. Converts
 !! atmospheric, surface and nst data.
 !!
 !! This file reads a configuration namelist.
 !!
-!! Usage:
-!! Link the configuration namelist to ./fort.41.  Then run the
-!! program with a multiple of six mpi tasks (an ESMF library
-!! requirement for fv3 cubed sphere grids).
-!!
+!! Link the configuration namelist to ./fort.41. Then run the program
+!! with a multiple of six mpi tasks (an ESMF library requirement for
+!! fv3 cubed sphere grids).
 !!
 !! @author George Gayno NOAA/EMC
+!! @return 0 for success, error code otherwise.
  program chgres
 
  use mpi

diff --git a/sorc/chgres_cube.fd/input_data.F90 b/sorc/chgres_cube.fd/input_data.F90
@@ -104,24 +104,25 @@ module input_data
 
 ! Fields associated with the nst model.
 
- type(esmf_field), public        :: c_d_input_grid
- type(esmf_field), public        :: c_0_input_grid
- type(esmf_field), public        :: d_conv_input_grid
- type(esmf_field), public        :: dt_cool_input_grid
- type(esmf_field), public        :: ifd_input_grid
- type(esmf_field), public        :: qrain_input_grid
- type(esmf_field), public        :: tref_input_grid  !< reference temperature
- type(esmf_field), public        :: w_d_input_grid
- type(esmf_field), public        :: w_0_input_grid
- type(esmf_field), public        :: xs_input_grid
- type(esmf_field), public        :: xt_input_grid
- type(esmf_field), public        :: xu_input_grid
- type(esmf_field), public        :: xv_input_grid
- type(esmf_field), public        :: xz_input_grid
- type(esmf_field), public        :: xtts_input_grid
- type(esmf_field), public        :: xzts_input_grid
- type(esmf_field), public        :: z_c_input_grid
- type(esmf_field), public        :: zm_input_grid
+ type(esmf_field), public        :: c_d_input_grid   !< Coefficient 2 to calculate d(tz)/d(ts)
+ type(esmf_field), public        :: c_0_input_grid   !< Coefficient 1 to calculate d(tz)/d(ts)
+ type(esmf_field), public        :: d_conv_input_grid   !< Thickness of free convection layer
+ type(esmf_field), public        :: dt_cool_input_grid   !< Sub-layer cooling amount
+ type(esmf_field), public        :: ifd_input_grid   !< Model mode index. 0-diurnal model not
+                                                     !< started; 1-diurnal model started.
+ type(esmf_field), public        :: qrain_input_grid   !< Sensible heat flux due to rainfall
+ type(esmf_field), public        :: tref_input_grid  !< Reference temperature
+ type(esmf_field), public        :: w_d_input_grid   !< Coefficient 4 to calculate d(tz)/d(ts)
+ type(esmf_field), public        :: w_0_input_grid   !< Coefficient 3 to calculate d(tz)/d(ts)
+ type(esmf_field), public        :: xs_input_grid   !< Salinity content in diurnal thermocline layer
+ type(esmf_field), public        :: xt_input_grid   !< Heat content in diurnal thermocline layer
+ type(esmf_field), public        :: xu_input_grid   !< u-current content in diurnal thermocline layer
+ type(esmf_field), public        :: xv_input_grid   !< v-current content in diurnal thermocline layer
+ type(esmf_field), public        :: xz_input_grid   !< Diurnal thermocline layer thickness
+ type(esmf_field), public        :: xtts_input_grid   !< d(xt)/d(ts)
+ type(esmf_field), public        :: xzts_input_grid   !< d(xz)/d(ts)
+ type(esmf_field), public        :: z_c_input_grid   !< Sub-layer cooling thickness
+ type(esmf_field), public        :: zm_input_grid   !< Oceanic mixed layer depth
 
  public :: read_input_atm_data
  public :: cleanup_input_atm_data