From ec5536ced3b8ca6c5a4ad64a47887f303e357fad Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 25 Feb 2021 13:18:52 -0700 Subject: [PATCH] improving module documentation in chgres_cube --- sorc/chgres_cube.fd/atmosphere.F90 | 7 ++++--- sorc/chgres_cube.fd/grib2_util.F90 | 5 ++++- sorc/chgres_cube.fd/input_data.F90 | 5 +++-- sorc/chgres_cube.fd/model_grid.F90 | 5 +++-- sorc/chgres_cube.fd/program_setup.F90 | 5 +++-- sorc/chgres_cube.fd/search_util.F90 | 5 +++-- sorc/chgres_cube.fd/static_data.F90 | 7 ++++--- sorc/chgres_cube.fd/surface.F90 | 5 +++-- sorc/chgres_cube.fd/thompson_mp_climo_data.F90 | 5 +++-- sorc/chgres_cube.fd/utils.F90 | 5 ++--- 10 files changed, 32 insertions(+), 22 deletions(-) diff --git a/sorc/chgres_cube.fd/atmosphere.F90 b/sorc/chgres_cube.fd/atmosphere.F90 index 5d0bacf35..5563e4b3e 100644 --- a/sorc/chgres_cube.fd/atmosphere.F90 +++ b/sorc/chgres_cube.fd/atmosphere.F90 @@ -1,7 +1,8 @@ !> @file !! @brief Process atmospheric fields -!! -!! Process atmospheric fields: Horizontally interpolate input +!! @author George Gayno NCEP/EMC + +!> Process atmospheric fields: Horizontally interpolate input !! fields to the target grid. Adjust surface pressure according to !! terrain difference between input and target grids. Vertically !! interpolate to target grid vertical levels. Processing based on @@ -14,7 +15,7 @@ !! 'west' edge of the grid box. Otherwise, fields are at the center !! of the grid box. !! -!! @author gayno NCEP/EMC +!! @author George Gayno NCEP/EMC module atmosphere use esmf diff --git a/sorc/chgres_cube.fd/grib2_util.F90 b/sorc/chgres_cube.fd/grib2_util.F90 index 3f7be14f4..bbb9829de 100644 --- a/sorc/chgres_cube.fd/grib2_util.F90 +++ b/sorc/chgres_cube.fd/grib2_util.F90 @@ -1,6 +1,9 @@ !> @file !! @brief Utilities for use when reading grib2 data. -!! +!! @author George Gayno NCEP/EMC + +!> Utilities for use when reading grib2 data. +!! @author George Gayno NCEP/EMC module grib2_util use esmf diff --git a/sorc/chgres_cube.fd/input_data.F90 b/sorc/chgres_cube.fd/input_data.F90 index 8d8e8c4b2..809c46859 100644 --- a/sorc/chgres_cube.fd/input_data.F90 +++ b/sorc/chgres_cube.fd/input_data.F90 @@ -1,8 +1,8 @@ !> @file !! @brief Read input data !! @author George Gayno NCEP/EMC -!! -!! Read atmospheric, surface and nst data on the input grid. + +!> Read atmospheric, surface and nst data on the input grid. !! Supported formats include fv3 tiled 'restart' files, fv3 tiled !! 'history' files, fv3 gaussian history files, spectral gfs !! gaussian nemsio files, and spectral gfs sigio/sfcio files. @@ -10,6 +10,7 @@ !! Public variables are defined below: "input" indicates field !! associated with the input grid. !! +!! @author George Gayno NCEP/EMC module input_data use esmf diff --git a/sorc/chgres_cube.fd/model_grid.F90 b/sorc/chgres_cube.fd/model_grid.F90 index c245ca5cb..aa1b43fb1 100644 --- a/sorc/chgres_cube.fd/model_grid.F90 +++ b/sorc/chgres_cube.fd/model_grid.F90 @@ -1,7 +1,8 @@ !> @file !! @brief Specify input and target model grids. -!! -!! Specify input and target model grids via ESMF grid objects. +!! @author George Gayno NCEP/EMC + +!> Specify input and target model grids via ESMF grid objects. !! !! @author George Gayno NCEP/EMC module model_grid diff --git a/sorc/chgres_cube.fd/program_setup.F90 b/sorc/chgres_cube.fd/program_setup.F90 index 49964b44e..8381a34ec 100644 --- a/sorc/chgres_cube.fd/program_setup.F90 +++ b/sorc/chgres_cube.fd/program_setup.F90 @@ -1,7 +1,8 @@ !> @file !! @brief Set up program execution. -!! -!! This module contains code to read the setup namelist file, handle +!! @author George Gayno NCEP/EMC + +!> This module contains code to read the setup namelist file, handle !! the varmap file for GRIB2 data, and calculate the soil parameters. !! !! @author George Gayno NCEP/EMC diff --git a/sorc/chgres_cube.fd/search_util.F90 b/sorc/chgres_cube.fd/search_util.F90 index 15d6750ce..c0dd35d3b 100644 --- a/sorc/chgres_cube.fd/search_util.F90 +++ b/sorc/chgres_cube.fd/search_util.F90 @@ -1,7 +1,8 @@ !> @file !! @brief Replace undefined surface values. -!! -!! Replace undefined values with a valid value. This can +!! @author George Gayno NCEP/EMC + +!> Replace undefined values with a valid value. This can !! happen for an isolated lake or island that is unresolved by !! the input grid. !! diff --git a/sorc/chgres_cube.fd/static_data.F90 b/sorc/chgres_cube.fd/static_data.F90 index 5e5859bf5..5ff854b71 100644 --- a/sorc/chgres_cube.fd/static_data.F90 +++ b/sorc/chgres_cube.fd/static_data.F90 @@ -1,8 +1,9 @@ !> @file !! @brief Process static surface data -!! -!! Read pre-computed static/climatological data on the fv3 -!! target grid. Time interpolate if necessary (for example a +!! @author George Gayno NCEP/EMC + +!> Read pre-computed static/climatological data on the fv3 +!! target grid. Time interpolate if necessary (for example a !! monthly climo field). !! !! @author George Gayno NCEP/EMC diff --git a/sorc/chgres_cube.fd/surface.F90 b/sorc/chgres_cube.fd/surface.F90 index d31727b49..868213289 100644 --- a/sorc/chgres_cube.fd/surface.F90 +++ b/sorc/chgres_cube.fd/surface.F90 @@ -1,7 +1,8 @@ !> @file !! @brief Process surface and nst fields. -!! -!! Process surface and nst fields. Interpolates fields from the input +!! @author George Gayno NCEP/EMC + +!> Process surface and nst fields. Interpolates fields from the input !! to target grids. Adjusts soil temperature according to differences !! in input and target grid terrain. Rescales soil moisture for soil !! type differences between input and target grid. Computes frozen diff --git a/sorc/chgres_cube.fd/thompson_mp_climo_data.F90 b/sorc/chgres_cube.fd/thompson_mp_climo_data.F90 index 23040a41f..1dfd98d31 100644 --- a/sorc/chgres_cube.fd/thompson_mp_climo_data.F90 +++ b/sorc/chgres_cube.fd/thompson_mp_climo_data.F90 @@ -1,7 +1,8 @@ !> @file !! @brief Process Thompson climatological MP data. -!! -!! Module to read the Thompson climatological MP data file +!! @author George Gayno NOAA/EMC + +!> Module to read the Thompson climatological MP data file !! and set up the associated esmf field and grid objects. !! !! @author George Gayno NOAA/EMC diff --git a/sorc/chgres_cube.fd/utils.F90 b/sorc/chgres_cube.fd/utils.F90 index 7ddb06288..964e5b8a7 100644 --- a/sorc/chgres_cube.fd/utils.F90 +++ b/sorc/chgres_cube.fd/utils.F90 @@ -1,9 +1,8 @@ !> @file -!! @brief Contains utility routines +!! @brief Contains utility routines. !! - -!> @brief General error handler. +!> General error handler. !! !! @param[in] string error message !! @param[in] rc error status code