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.

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

Doxygen updates to chgres_cube.fd/surface.F90 #359

Merged
merged 3 commits into from
Feb 25, 2021
Merged
Changes from all commits
Commits
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
25 changes: 21 additions & 4 deletions sorc/chgres_cube.fd/surface.F90
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
!! associated with the target grid. "input" indicates field associated
!! with the input grid.
!!
!! @author gayno NCEP/EMC
!! @author George Gayno NCEP/EMC
module surface

use esmf
Expand All @@ -20,8 +20,11 @@ module surface

private

! noah land ice option is applied at these vegetation types.
integer, parameter :: veg_type_landice_target = 15
!< Vegetation type category that
!< defines permanent land ice points.
!< The Noah LSM land ice physics
!< are applied at these points.

! surface fields (not including nst)
type(esmf_field), public :: canopy_mc_target_grid
Expand Down Expand Up @@ -133,10 +136,11 @@ module surface

contains

!> @brief Driver routine to process surface/nst data
!> Driver routine to process surface/nst data
!!
!! @author gayno NCEP/EMC
!! @param[in] localpet ESMF local persistent execution thread
!!
!! @author George Gayno NCEP/EMC
subroutine surface_driver(localpet)

use input_data, only : cleanup_input_sfc_data, &
Expand Down Expand Up @@ -292,6 +296,8 @@ end subroutine surface_driver

!> Horizontally interpolate surface fields using esmf routines.
!!
!! @param[in] localpet ESMF local persistent execution thread
!!
!! @author George Gayno NOAA/EMC
subroutine interp(localpet)

Expand Down Expand Up @@ -3659,6 +3665,9 @@ subroutine adjust_soil_levels(localpet)
end subroutine adjust_soil_levels

!> Set roughness length at land and sea ice.
!! At land, roughness is set from a lookup table
!! based on the vegetation type. At sea ice, roughness is
!! set to 1 cm.
!!
!! @author George Gayno NOAA/EMC
subroutine roughness
Expand Down Expand Up @@ -4765,6 +4774,10 @@ subroutine ij_to_i_j(ij, itile, jtile, i, j)

end subroutine ij_to_i_j

!> Free up memory once the target grid surface fields are
!! no longer needed.
!!
!! @author George Gayno NOAA/EMC
subroutine cleanup_target_sfc_data

implicit none
Expand Down Expand Up @@ -4797,6 +4810,10 @@ subroutine cleanup_target_sfc_data

end subroutine cleanup_target_sfc_data

!> Free up memory once the target grid nst fields are
!! no longer needed.
!!
!! @author George Gayno NOAA/EMC
subroutine cleanup_target_nst_data

implicit none
Expand Down