Skip to content
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

Jump to bottom

for chgres_cube - soil parameter references in program_setup.f90, turned on doxygen documentation for private functions #352

Merged
merged 10 commits into from
Feb 25, 2021
Merged

for chgres_cube - soil parameter references in program_setup.f90, turned on doxygen documentation for private functions #352

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9e0e80b
turned on documentation of private functions
edwardhartnett Feb 24, 2021
31fe306
turned on documentation of private functions
edwardhartnett Feb 24, 2021
cf4342a
documentation cleanup, references for soil params
edwardhartnett Feb 24, 2021
d116c78
Merge branch 'develop' into ejh_soil_doc
edwardhartnett Feb 24, 2021
384427a
fixed links
edwardhartnett Feb 25, 2021
de46b71
fixed links
edwardhartnett Feb 25, 2021
b3c7e41
undoing
edwardhartnett Feb 25, 2021
89441e0
Merge branch 'develop' into ejh_soil_doc
edwardhartnett Feb 25, 2021
5abcd90
reapplied doc changes
edwardhartnett Feb 25, 2021
dc74fa3
Merge branch 'develop' into ejh_soil_doc
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
4 changes: 2 additions & 2 deletions docs/Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,13 +402,13 @@ EXTRACT_ALL = NO
# be included in the documentation.
# The default value is: NO.

EXTRACT_PRIVATE = NO
EXTRACT_PRIVATE = YES

# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.

EXTRACT_PACKAGE = NO
EXTRACT_PACKAGE = YES

# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
# included in the documentation.
Expand Down
31 changes: 26 additions & 5 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
!! @brief Set up program execution.
!!
!! Set up program execution
!! 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
module program_setup
Expand Down Expand Up @@ -144,7 +145,8 @@ module program_setup

!> Reads program configuration namelist.
!!
!! @param filename the name of the configuration file (defaults to ./fort.41).
!! @param filename the name of the configuration file (defaults to
!! ./fort.41).
!! @author George Gayno NCEP/EMC
subroutine read_setup_namelist(filename)
implicit none
Expand Down Expand Up @@ -443,6 +445,25 @@ end subroutine get_var_cond
!> Driver routine to compute soil parameters for each
!! soil type. Works for Zobler and STATSGO soil categories.
!!
!! The calculations are those used in the Noah Land Surface Model. For
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can build your branch with no warnings. But the hyperlinks are not displaying right. Some documentation I found said the link should be enclosed in ( ) and the wording in the square brackets.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stand by, I got that backwards. I will fix...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, the href tag from html seems to work best. I have changed to that.

!! more information see (Implementation of Noah land surface model
!! advances in the National Centers for Environmental Prediction
!! operational mesoscale Eta
!! model)[https://doi.org/10.1029/2002JD003296].
!!
!! For more details about the soil parameters/properties see (Coupling
!! an Advanced Land Surface–Hydrology Model with the Penn State–NCAR
!! MM5 Modeling System. Part I: Model Implementation and Sensitivity)
!! [https://journals.ametsoc.org/view/journals/mwre/129/4/1520-0493_2001_129_0569_caalsh_2.0.co_2.xml].
!!
!! The original source for soil properties is here:
!!
!! Cosby, B. J., G. M. Hornberger, R. B. Clapp, and T. R. Ginn, 1984:
!! (A statistical exploration of the relationships of soil moisture
!! characteristics to the physical properties of
!! soils)[https://agupubs.onlinelibrary.wiley.com/doi/10.1029/WR020i006p00682]. Water
!! Resour. Res.,20, 682–690.
!!
!! @param [in] localpet ESMF local persistent execution thread
!! @author George Gayno NCEP/EMC
subroutine calc_soil_params_driver(localpet)
Expand Down Expand Up @@ -588,8 +609,8 @@ subroutine calc_soil_params_driver(localpet)

end subroutine calc_soil_params_driver

!> Compute soil parameters. Will be used to rescale soil moisture
!! differences in soil type between the input grid and target
!> Compute soil parameters. These will be used to rescale soil
!! moisture differences in soil type between the input grid and target
!! model grid.
!!
!! @param [in] num_soil_cats number of soil type categories
Expand Down