From 9e0e80b88aef2d1bbd81dad47622c73302d6fa44 Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Wed, 24 Feb 2021 08:19:49 -0700 Subject: [PATCH 1/7] turned on documentation of private functions --- docs/Doxyfile.in | 4 ++-- sorc/chgres_cube.fd/program_setup.f90 | 25 ++++++++++++++++++++++--- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 20e6fbc7e..d596f9b16 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -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. diff --git a/sorc/chgres_cube.fd/program_setup.f90 b/sorc/chgres_cube.fd/program_setup.f90 index 4ec07d3e9..f44324811 100644 --- a/sorc/chgres_cube.fd/program_setup.f90 +++ b/sorc/chgres_cube.fd/program_setup.f90 @@ -588,9 +588,28 @@ 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 -!! model grid. +!> Compute soil parameters. Will be used to rescale soil moisture +!! differences in soil type between the input grid and target model +!! grid. +!! +!! The calculations are those used in the Noah Land Surface Model. For +!! 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] num_soil_cats number of soil type categories !! @param [in] smlow reference parameter for wltsmc From 31fe3060650c470afcfc33bdf53f1695219a3e45 Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Wed, 24 Feb 2021 08:21:35 -0700 Subject: [PATCH 2/7] turned on documentation of private functions --- sorc/chgres_cube.fd/program_setup.f90 | 44 +++++++++++++-------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/sorc/chgres_cube.fd/program_setup.f90 b/sorc/chgres_cube.fd/program_setup.f90 index f44324811..9aafe2a29 100644 --- a/sorc/chgres_cube.fd/program_setup.f90 +++ b/sorc/chgres_cube.fd/program_setup.f90 @@ -443,6 +443,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 +!! 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) @@ -588,28 +607,9 @@ 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 model -!! grid. -!! -!! The calculations are those used in the Noah Land Surface Model. For -!! 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. +!> 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 !! @param [in] smlow reference parameter for wltsmc From cf4342a261a3858b52ac05d1ebfd2b87bde4079c Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Wed, 24 Feb 2021 08:26:48 -0700 Subject: [PATCH 3/7] documentation cleanup, references for soil params --- sorc/chgres_cube.fd/program_setup.f90 | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/sorc/chgres_cube.fd/program_setup.f90 b/sorc/chgres_cube.fd/program_setup.f90 index 9aafe2a29..689dc1f6d 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 +!! @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 @@ -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 From 384427a7f2613c45726656f68c2c2a104a5bd588 Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 25 Feb 2021 05:08:56 -0700 Subject: [PATCH 4/7] fixed links --- sorc/chgres_cube.fd/program_setup.f90 | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/sorc/chgres_cube.fd/program_setup.f90 b/sorc/chgres_cube.fd/program_setup.f90 index 689dc1f6d..5ce02206e 100644 --- a/sorc/chgres_cube.fd/program_setup.f90 +++ b/sorc/chgres_cube.fd/program_setup.f90 @@ -446,22 +446,22 @@ end subroutine get_var_cond !! soil type. Works for Zobler and STATSGO soil categories. !! !! The calculations are those used in the Noah Land Surface Model. For -!! more information see (Implementation of Noah land surface model +!! 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]. +!! model](https://doi.org/10.1029/2002JD003296). !! -!! For more details about the soil parameters/properties see (Coupling +!! 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]. +!! 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 +!! [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 +!! soils](https://agupubs.onlinelibrary.wiley.com/doi/10.1029/WR020i006p00682). Water !! Resour. Res.,20, 682–690. !! !! @param [in] localpet ESMF local persistent execution thread From de46b714e44ebdc948b82ff5c9ca0c3c5166b6de Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 25 Feb 2021 05:14:22 -0700 Subject: [PATCH 5/7] fixed links --- sorc/chgres_cube.fd/program_setup.f90 | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/sorc/chgres_cube.fd/program_setup.f90 b/sorc/chgres_cube.fd/program_setup.f90 index 5ce02206e..49964b44e 100644 --- a/sorc/chgres_cube.fd/program_setup.f90 +++ b/sorc/chgres_cube.fd/program_setup.f90 @@ -446,22 +446,24 @@ end subroutine get_var_cond !! soil type. Works for Zobler and STATSGO soil categories. !! !! The calculations are those used in the Noah Land Surface Model. For -!! 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). +!! more information see Implementation of Noah +!! land surface model advances in the National Centers for +!! Environmental Prediction operational mesoscale Eta model. !! -!! For more details about the soil parameters/properties see [Coupling +!! 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). +!! MM5 Modeling System. Part I: Model Implementation and +!! Sensitivity. !! !! 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 +!! A +!! statistical exploration of the relationships of soil moisture +!! characteristics to the physical properties of soils. Water !! Resour. Res.,20, 682–690. !! !! @param [in] localpet ESMF local persistent execution thread From b3c7e417a9e4b030bc7dd4073cbfdf0bba6bfdc3 Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 25 Feb 2021 05:22:25 -0700 Subject: [PATCH 6/7] undoing --- sorc/chgres_cube.fd/program_setup.f90 | 33 ++++----------------------- 1 file changed, 5 insertions(+), 28 deletions(-) diff --git a/sorc/chgres_cube.fd/program_setup.f90 b/sorc/chgres_cube.fd/program_setup.f90 index 49964b44e..4ec07d3e9 100644 --- a/sorc/chgres_cube.fd/program_setup.f90 +++ b/sorc/chgres_cube.fd/program_setup.f90 @@ -1,8 +1,7 @@ !> @file -!! @brief Set up program execution. +!! @brief 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. +!! Set up program execution !! !! @author George Gayno NCEP/EMC module program_setup @@ -145,8 +144,7 @@ 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 @@ -445,27 +443,6 @@ 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 -!! more information see Implementation of Noah -!! land surface model advances in the National Centers for -!! Environmental Prediction operational mesoscale Eta model. -!! -!! 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. -!! -!! 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. 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) @@ -611,8 +588,8 @@ subroutine calc_soil_params_driver(localpet) end subroutine calc_soil_params_driver -!> Compute soil parameters. These will be used to rescale soil -!! moisture differences in soil type between the input grid and target +!> Compute soil parameters. 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 From 5abcd9095bb7f54634f7d5fcc958860850f30b9b Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 25 Feb 2021 05:24:31 -0700 Subject: [PATCH 7/7] reapplied doc changes --- sorc/chgres_cube.fd/program_setup.F90 | 33 +++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/sorc/chgres_cube.fd/program_setup.F90 b/sorc/chgres_cube.fd/program_setup.F90 index 4ec07d3e9..49964b44e 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 +!! @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 @@ -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 @@ -443,6 +445,27 @@ 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 +!! more information see Implementation of Noah +!! land surface model advances in the National Centers for +!! Environmental Prediction operational mesoscale Eta model. +!! +!! 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. +!! +!! 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. 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) @@ -588,8 +611,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