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

Changes needed to compile scidoc v7 updates #10

Merged
merged 2 commits into from
Aug 27, 2024
Merged

Changes needed to compile scidoc v7 updates #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
714cfe7
add back Doxygen comments for passing ccpp_prebuild.py
grantfirl Aug 27, 2024
2139d39
Merge branch 'scidoc_v7' into scidoc_v7_gjf
grantfirl Aug 27, 2024
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
1 change: 1 addition & 0 deletions physics/GWD/ugwpv1_gsldrag.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
!!
Copy link
Author

Choose a reason for hiding this comment

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

@mzhangw We need to keep an empty line with !! after the htmlinclude line in order for ccpp_prebuild to properly parse the file.

subroutine ugwpv1_gsldrag_init ( &
me, master, nlunit, input_nml_file, logunit, &
fn_nml2, jdat, lonr, latr, levs, ak, bk, dtp, &
Expand Down
2 changes: 2 additions & 0 deletions physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rad_time_vary.fv3.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,&
Expand Down
2 changes: 2 additions & 0 deletions physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rad_time_vary.scm.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,&
Expand Down
2 changes: 2 additions & 0 deletions physics/Interstitials/UFS_SCM_NEPTUNE/GFS_radiation_surface.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_cloud_overlap.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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*.
!!
Expand Down
1 change: 1 addition & 0 deletions physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_post.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
!!
Expand Down
2 changes: 2 additions & 0 deletions physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_pre.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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, &
Expand Down
3 changes: 3 additions & 0 deletions physics/Interstitials/UFS_SCM_NEPTUNE/GFS_rrtmgp_setup.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, &
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions physics/Interstitials/UFS_SCM_NEPTUNE/GFS_surface_loop_control_part1.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
6 changes: 5 additions & 1 deletion physics/Interstitials/UFS_SCM_NEPTUNE/module_ccpp_suite_simulator.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down
1 change: 1 addition & 0 deletions physics/SFC_Models/Land/sfc_land.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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, &
Expand Down
2 changes: 1 addition & 1 deletion physics/SFC_Models/SeaIce/CICE/sfc_cice.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions physics/hooks/machine.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
!!
module machine

!! \section arg_table_machine
Copy link
Author

Choose a reason for hiding this comment

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

@mzhangw Whenever a type (DDT) is defined that is required for the CCPP, it must have this same Doxygen markup in order for ccpp_prebuild to find it.

!! \htmlinclude machine.html
!!

implicit none

integer, parameter :: kind_sngl_prec = 4 &
Expand Down
4 changes: 4 additions & 0 deletions physics/photochem/h2o_def.f
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 7 additions & 1 deletion physics/photochem/module_ozphys.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading