Skip to content

improving module documentation in chgres_cube #363

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
edwardhartnett merged 3 commits into from
Feb 25, 2021
Merged

improving module documentation in chgres_cube #363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec5536c
improving module documentation in chgres_cube
edwardhartnett Feb 25, 2021
57db46b
Merge branch 'develop' into ejh_fix_mod_docs
edwardhartnett Feb 25, 2021
80400bb
Merge branch 'develop' into ejh_fix_mod_docs
edwardhartnett Feb 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions sorc/chgres_cube.fd/atmosphere.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
5 changes: 4 additions & 1 deletion sorc/chgres_cube.fd/grib2_util.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 3 additions & 2 deletions sorc/chgres_cube.fd/input_data.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
!> @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.
!!
!! Public variables are defined below: "input" indicates field
!! associated with the input grid.
!!
!! @author George Gayno NCEP/EMC
module input_data

use esmf
Expand Down
5 changes: 3 additions & 2 deletions sorc/chgres_cube.fd/model_grid.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 3 additions & 2 deletions sorc/chgres_cube.fd/program_setup.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 3 additions & 2 deletions sorc/chgres_cube.fd/search_util.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
!!
Expand Down
7 changes: 4 additions & 3 deletions sorc/chgres_cube.fd/static_data.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 3 additions & 2 deletions sorc/chgres_cube.fd/surface.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 3 additions & 2 deletions sorc/chgres_cube.fd/thompson_mp_climo_data.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 2 additions & 3 deletions sorc/chgres_cube.fd/utils.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down