From 714cfe7042f4f535f52264bc47a505727f101199 Mon Sep 17 00:00:00 2001 From: Grant Firl Date: Mon, 26 Aug 2024 21:35:48 -0400 Subject: [PATCH] add back Doxygen comments for passing ccpp_prebuild.py --- physics/GWD/ugwpv1_gsldrag.F90 | 1 + .../UFS_SCM_NEPTUNE/GFS_rad_time_vary.fv3.F90 | 2 ++ .../UFS_SCM_NEPTUNE/GFS_rad_time_vary.scm.F90 | 2 ++ .../UFS_SCM_NEPTUNE/GFS_radiation_surface.F90 | 2 ++ .../UFS_SCM_NEPTUNE/GFS_rrtmgp_cloud_overlap.F90 | 1 + physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_post.F90 | 1 + physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_pre.F90 | 2 ++ .../Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_setup.F90 | 3 +++ .../UFS_SCM_NEPTUNE/GFS_surface_loop_control_part1.F90 | 1 + .../UFS_SCM_NEPTUNE/module_ccpp_suite_simulator.F90 | 6 +++++- physics/SFC_Models/Land/sfc_land.F90 | 1 + physics/SFC_Models/SeaIce/CICE/sfc_cice.f | 2 +- physics/hooks/machine.F | 4 ++++ physics/photochem/h2o_def.f | 4 ++++ physics/photochem/module_ozphys.F90 | 8 +++++++- 15 files changed, 37 insertions(+), 3 deletions(-) diff --git a/physics/GWD/ugwpv1_gsldrag.F90 b/physics/GWD/ugwpv1_gsldrag.F90 index 3688218b3..5dd76b8d1 100644 --- a/physics/GWD/ugwpv1_gsldrag.F90 +++ b/physics/GWD/ugwpv1_gsldrag.F90 @@ -63,6 +63,7 @@ module ugwpv1_gsldrag !>@brief The subroutine initializes the unified UGWP !> \section arg_table_ugwpv1_gsldrag_init Argument Table !! \htmlinclude ugwpv1_gsldrag_init.html +!! subroutine ugwpv1_gsldrag_init ( & me, master, nlunit, input_nml_file, logunit, & fn_nml2, jdat, lonr, latr, levs, ak, bk, dtp, & diff --git a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rad_time_vary.fv3.F90 b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rad_time_vary.fv3.F90 index 9cda780d3..cbd660414 100644 --- a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rad_time_vary.fv3.F90 +++ b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rad_time_vary.fv3.F90 @@ -11,8 +11,10 @@ module GFS_rad_time_vary contains !> This module contains code related to GFS radiation setup. + !> \section arg_table_GFS_rad_time_vary_timestep_init Argument Table !! \htmlinclude GFS_rad_time_vary_timestep_init.html +!! subroutine GFS_rad_time_vary_timestep_init (lrseeds, rseeds, & lslwr, lsswr, isubc_lw, isubc_sw, icsdsw, icsdlw, cnx, cny, isc, jsc, & imap, jmap, sec, kdt, imp_physics, imp_physics_zhao_carr, ipsd0, ipsdlim,& diff --git a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rad_time_vary.scm.F90 b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rad_time_vary.scm.F90 index cd745bcc1..46585c9da 100644 --- a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rad_time_vary.scm.F90 +++ b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rad_time_vary.scm.F90 @@ -11,8 +11,10 @@ module GFS_rad_time_vary contains !> This module contains code related to GFS radiation setup. + !> \section arg_table_GFS_rad_time_vary_timestep_init Argument Table !! \htmlinclude GFS_rad_time_vary_timestep_init.html +!! subroutine GFS_rad_time_vary_timestep_init (lrseeds, rseeds, & lslwr, lsswr, isubc_lw, isubc_sw, icsdsw, icsdlw, cnx, cny, isc, jsc, & imap, jmap, sec, kdt, imp_physics, imp_physics_zhao_carr, ipsd0, ipsdlim,& diff --git a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_radiation_surface.F90 b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_radiation_surface.F90 index ccce95ebd..5e8c5bc9d 100644 --- a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_radiation_surface.F90 +++ b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_radiation_surface.F90 @@ -12,8 +12,10 @@ module GFS_radiation_surface !> This module contains calls to module_radiation_surface::setemis() to set up !! surface emissivity for LW radiation and to module_radiation_surface::setalb() !! to set up surface albedo for SW radiation. + !> \section arg_table_GFS_radiation_surface_init Argument Table !! \htmlinclude GFS_radiation_surface_init.html +!! subroutine GFS_radiation_surface_init (me, ialb, iems, semis_file, con_pi, errmsg, errflg) use module_radiation_surface, only: sfc_init diff --git a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_cloud_overlap.F90 b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_cloud_overlap.F90 index ed0445361..069f7545c 100644 --- a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_cloud_overlap.F90 +++ b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_cloud_overlap.F90 @@ -14,6 +14,7 @@ module GFS_rrtmgp_cloud_overlap !> \section arg_table_GFS_rrtmgp_cloud_overlap_run Argument Table !! \htmlinclude GFS_rrtmgp_cloud_overlap_run.html +!! !! This is identical (shares common-code) to RRTMG. The motivation for RRTMGP to have !! its own scheme is both organizational and philosophical*. !! diff --git a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_post.F90 b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_post.F90 index a89e5c961..ec22f24d3 100644 --- a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_post.F90 +++ b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_post.F90 @@ -15,6 +15,7 @@ module GFS_rrtmgp_post !> \section arg_table_GFS_rrtmgp_post_run Argument Table !! \htmlinclude GFS_rrtmgp_post_run.html +!! !!The all-sky radiation tendency is computed, the clear-sky tendency is computed !! if requested. !! diff --git a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_pre.F90 b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_pre.F90 index 9da0d6cf9..0a747aa44 100644 --- a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_pre.F90 +++ b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_pre.F90 @@ -33,6 +33,7 @@ module GFS_rrtmgp_pre !> \section arg_table_GFS_rrtmgp_pre_init Argument Table !! \htmlinclude GFS_rrtmgp_pre_init.html +!! !! Actuve gas-names are read from namelist. Set to interstitial%active_gases. subroutine GFS_rrtmgp_pre_init(nGases, active_gases, active_gases_array, errmsg, errflg) ! Inputs @@ -95,6 +96,7 @@ end subroutine GFS_rrtmgp_pre_init !> \section arg_table_GFS_rrtmgp_pre_run Argument Table !! \htmlinclude GFS_rrtmgp_pre_run.html +!! !! Sanitize inputs for use in RRTMGP. subroutine GFS_rrtmgp_pre_run(me, nCol, nLev, i_o3, doSWrad, doLWrad, fhswr, fhlwr, & xlat, xlon, prsl, tgrs, prslk, prsi, qgrs, tsfc, coslat, sinlat, con_g, con_rd, & diff --git a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_setup.F90 b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_setup.F90 index 679185746..0ed936410 100644 --- a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_setup.F90 +++ b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_setup.F90 @@ -33,6 +33,7 @@ module GFS_rrtmgp_setup !> \section arg_table_GFS_rrtmgp_setup_init Argument Table !! \htmlinclude GFS_rrtmgp_setup_init.html +!! subroutine GFS_rrtmgp_setup_init(do_RRTMGP, imp_physics, imp_physics_fer_hires, & imp_physics_gfdl, imp_physics_thompson, imp_physics_wsm6, imp_physics_zhao_carr, & imp_physics_zhao_carr_pdf, imp_physics_mg, si, levr, ictm, isol, ico2, iaer, & @@ -140,6 +141,7 @@ end subroutine GFS_rrtmgp_setup_init !> \section arg_table_GFS_rrtmgp_setup_timestep_init Argument Table !! \htmlinclude GFS_rrtmgp_setup_timestep_init.html +!! subroutine GFS_rrtmgp_setup_timestep_init (idate, jdate, deltsw, deltim, doSWrad, me, & iaermdl, aeros_file, isol, slag, sdec, cdec, solcon, con_pi, co2dat_file, & co2gbl_file, ictm, ico2, ntoz, ozphys, errmsg, errflg) @@ -247,6 +249,7 @@ end subroutine GFS_rrtmgp_setup_timestep_init !> \section arg_table_GFS_rrtmgp_setup_finalize Argument Table !! \htmlinclude GFS_rrtmgp_setup_finalize.html +!! subroutine GFS_rrtmgp_setup_finalize (errmsg, errflg) character(len=*), intent( out) :: errmsg integer, intent( out) :: errflg diff --git a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_surface_loop_control_part1.F90 b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_surface_loop_control_part1.F90 index 32d15f867..913c1a7b6 100644 --- a/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_surface_loop_control_part1.F90 +++ b/physics/Interstitials/UFS_SCM_NEPTUNE/GFS_surface_loop_control_part1.F90 @@ -9,6 +9,7 @@ module GFS_surface_loop_control_part1 !! !! \section arg_table_GFS_surface_loop_control_part1_run Arguments !! \htmlinclude GFS_surface_loop_control_part1_run.html +!! subroutine GFS_surface_loop_control_part1_run (im, iter, & wind, flag_guess, errmsg, errflg) diff --git a/physics/Interstitials/UFS_SCM_NEPTUNE/module_ccpp_suite_simulator.F90 b/physics/Interstitials/UFS_SCM_NEPTUNE/module_ccpp_suite_simulator.F90 index e8a4188d3..45d3dd4e0 100644 --- a/physics/Interstitials/UFS_SCM_NEPTUNE/module_ccpp_suite_simulator.F90 +++ b/physics/Interstitials/UFS_SCM_NEPTUNE/module_ccpp_suite_simulator.F90 @@ -52,7 +52,11 @@ module module_ccpp_suite_simulator real(kind_phys), dimension(:,:,:,:), allocatable :: q end type phys_tend_4d -!> This type contains the meta information and data for each physics process. +!> \section arg_table_base_physics_process Argument Table +!! \htmlinclude base_physics_process.html +!! +!! This type contains the meta information and data for each physics process. +!! type base_physics_process character(len=16) :: name !< Physics process name logical :: time_split = .false. !< Is process time-split? diff --git a/physics/SFC_Models/Land/sfc_land.F90 b/physics/SFC_Models/Land/sfc_land.F90 index 3580f2e64..6f52452db 100644 --- a/physics/SFC_Models/Land/sfc_land.F90 +++ b/physics/SFC_Models/Land/sfc_land.F90 @@ -16,6 +16,7 @@ module sfc_land !> \brief Brief description of the subroutine !! \section arg_table_sfc_land_run Arguments !! \htmlinclude sfc_land_run.html +!! subroutine sfc_land_run(im, cpllnd, cpllnd2atm, flag_iter, dry, & sncovr1_lnd, qsurf_lnd, evap_lnd, hflx_lnd, & ep_lnd, t2mmp_lnd, q2mp_lnd, gflux_lnd, & diff --git a/physics/SFC_Models/SeaIce/CICE/sfc_cice.f b/physics/SFC_Models/SeaIce/CICE/sfc_cice.f index 334de4137..369e24cf0 100644 --- a/physics/SFC_Models/SeaIce/CICE/sfc_cice.f +++ b/physics/SFC_Models/SeaIce/CICE/sfc_cice.f @@ -14,7 +14,7 @@ module sfc_cice !> \brief Brief description of the subroutine !! \section arg_table_sfc_cice_run Arguments !! \htmlinclude sfc_cice_run.html - +!! !! use physcons, only : hvap => con_hvap, cp => con_cp, & !! & rvrdm1 => con_fvirt, rd => con_rd diff --git a/physics/hooks/machine.F b/physics/hooks/machine.F index d6f36305b..88cd28eae 100644 --- a/physics/hooks/machine.F +++ b/physics/hooks/machine.F @@ -2,6 +2,10 @@ !! module machine +!! \section arg_table_machine +!! \htmlinclude machine.html +!! + implicit none integer, parameter :: kind_sngl_prec = 4 & diff --git a/physics/photochem/h2o_def.f b/physics/photochem/h2o_def.f index 7602b1ffe..72748a613 100644 --- a/physics/photochem/h2o_def.f +++ b/physics/photochem/h2o_def.f @@ -5,6 +5,10 @@ !! This module defines arrays in H2O scheme. module h2o_def +!> \section arg_table_h2o_def +!! \htmlinclude h2o_def.html +!! + use machine , only : kind_phys implicit none diff --git a/physics/photochem/module_ozphys.F90 b/physics/photochem/module_ozphys.F90 index f9740d439..5ebec5af4 100644 --- a/physics/photochem/module_ozphys.F90 +++ b/physics/photochem/module_ozphys.F90 @@ -45,8 +45,14 @@ module module_ozphys public ty_ozphys -!> Derived type containing data and procedures needed by ozone photochemistry parameterization +! ######################################################################################### +!> \section arg_table_ty_ozphys Argument Table +!! \htmlinclude ty_ozphys.html +!! +!! Derived type containing data and procedures needed by ozone photochemistry parameterization !! *Note* All data field are ordered from surface-to-toa. +!! +! ######################################################################################### type ty_ozphys ! Prognostic ozone. integer :: nlat !< Number of latitudes.