Skip to content

improved chgres_cube doxygen docs with info from chgres_cube.rst, added some formatting in other utility user guides #410

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

Merged
edwardhartnett merged 9 commits into from
Mar 11, 2021
Merged

improved chgres_cube doxygen docs with info from chgres_cube.rst, added some formatting in other utility user guides #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6c1a400
improved chgres_cube docs with info from chgres_cube.rst
edwardhartnett Mar 11, 2021
59e841d
fixed typo
edwardhartnett Mar 11, 2021
3720e76
cleanup user guide
edwardhartnett Mar 11, 2021
39f0518
clean up user guide
edwardhartnett Mar 11, 2021
e32b92c
clean up user guide
edwardhartnett Mar 11, 2021
4c2ab2b
clean up user guide
edwardhartnett Mar 11, 2021
62c9855
clean up surface.f90
edwardhartnett Mar 11, 2021
3b87d82
Merge branch 'develop' into ejh_more_docs_13
edwardhartnett Mar 11, 2021
f9f756b
Merge branch 'develop' into ejh_more_docs_13
edwardhartnett Mar 11, 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
63 changes: 33 additions & 30 deletions sorc/chgres_cube.fd/atmosphere.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
!> @file
!! @brief Process atmospheric fields
!! @brief Process atmospheric fields.
!! @author George Gayno NCEP/EMC

!> Process atmospheric fields: Horizontally interpolate input
!! fields to the target grid. Adjust surface pressure according to
!! terrain difference between input and target grids. Vertically
!! interpolate to target grid vertical levels. Processing based on
!! the spectral GFS version of CHGRES.
!> Process atmospheric fields. Horizontally interpolate from input to
!! target FV3 grid using ESMF regridding. Adjust surface pressure
!! according to terrain differences between input and target
!! grid. Vertically interpolate to target FV3 grid vertical
!! levels. Processing based on the spectral GFS version of CHGRES.
!!
!! Variables defined below. Here "b4adj" indicates fields on the target
!! grid before vertical adjustment. "target" indicates data on target
!! grid. "input" indicates data on input grid. "_s" indicates fields
!! on the 'south' edge of the grid box. "_w" indicate fields on the
!! 'west' edge of the grid box. Otherwise, fields are at the center
!! of the grid box.
!! For variables "b4adj" indicates fields on the target grid before
!! vertical adjustment. "target" indicates data on target grid.
!! "input" indicates data on input grid. "_s" indicates fields on the
!! 'south' edge of the grid box. "_w" indicate fields on the 'west'
!! edge of the grid box. Otherwise, fields are at the center of the
!! grid box.
!!
!! @author George Gayno NCEP/EMC
module atmosphere
Expand Down Expand Up @@ -105,7 +105,7 @@ module atmosphere

!> Driver routine to process for atmospheric fields.
!!
!! @param localpet ESMF local persistent execution thread
!! @param[in] localpet ESMF local persistent execution thread
!! @author George Gayno
subroutine atmosphere_driver(localpet)

Expand Down Expand Up @@ -424,9 +424,9 @@ subroutine atmosphere_driver(localpet)

end subroutine atmosphere_driver

!> Create target grid field objects to hold data before vertical interpolation.
!! These will be defined with the same number of vertical levels as
!! the input grid.
!> Create target grid field objects to hold data before vertical
!! interpolation. These will be defined with the same number of
!! vertical levels as the input grid.
!!
!! @author George Gayno
subroutine create_atm_b4adj_esmf_fields
Expand Down Expand Up @@ -755,7 +755,7 @@ subroutine convert_winds

end subroutine convert_winds

!> Compute model level pressures.
!> Computes 3-D pressure given an adjusted surface pressure.
!!
!! PROGRAM HISTORY LOG:
!! 2005-04-11 HANN_MING HENRY JUANG hybrid sigma, sigma-p, and sigma-
Expand Down Expand Up @@ -783,9 +783,9 @@ end subroutine convert_winds
!! PM REAL (IX,KM) MID-LAYER PRESSURE (PA)
!! DP REAL (IX,KM) LAYER DELTA PRESSURE (PA)
!!
!! @param localpet ESMF local persistent execution thread
!! @param[in] localpet ESMF local persistent execution thread
!!
!! @author HANN_MING HENRY JUANG, JUANG, Fanglin Yang, S. Moorthi
!! @author Hann Ming Henry Juang, Juang, Fanglin Yang, S. Moorthi
subroutine newpr1(localpet)
implicit none

Expand Down Expand Up @@ -884,7 +884,7 @@ subroutine newpr1(localpet)

end subroutine newpr1

!> Compute new surface pressure.
!> Computes adjusted surface pressure given a new terrain height.
!!
!! Computes a new surface pressure given a new orography. The new
!! pressure is computed assuming a hydrostatic balance and a constant
Expand All @@ -895,8 +895,8 @@ end subroutine newpr1
!! - 91-10-31 mark iredell
!! - 2018-apr adapt for fv3. george gayno
!!
!! @param [in] localpet ESMF local persistent execution thread
!! @author iredell org: w/nmc23, George Gayno @date 92-10-31
!! @param[in] localpet ESMF local persistent execution thread
!! @author Mark Iredell, George Gayno @date 92-10-31
subroutine newps(localpet)

implicit none
Expand Down Expand Up @@ -1090,7 +1090,9 @@ subroutine newps(localpet)

end subroutine newps

!> Read vertical coordinate information.
!> Reads model vertical coordinate definition file (as specified by
!! namelist variable vcoord_file_target_grid).
!!
!! @author George Gayno
subroutine read_vcoord_info
implicit none
Expand Down Expand Up @@ -1233,8 +1235,11 @@ subroutine horiz_interp_thomp_mp_climo

end subroutine horiz_interp_thomp_mp_climo

!> Vertically interpolate thompson microphysics climo tracers to the target
!! model levels.
!> Vertically interpolate atmospheric fields to target FV3 grid.
!!
!! Vertically interpolate thompson microphysics climo tracers to the
!! target model levels.
!!
!! @author George Gayno
SUBROUTINE VINTG_THOMP_MP_CLIMO

Expand Down Expand Up @@ -1358,7 +1363,7 @@ END SUBROUTINE VINTG_THOMP_MP_CLIMO
!! relative humidity is held constant. This routine expects fields
!! ordered from bottom to top of atmosphere.
!!
!! @author IREDELL ORG: W/NMC23 @date 92-10-31
!! @author Mark Iredell @date 92-10-31
SUBROUTINE VINTG
use mpi

Expand Down Expand Up @@ -1764,9 +1769,6 @@ END SUBROUTINE TERP3
!! values z1(1+(i-1)*ixz1+(l-1)*kxz1) and z1(1+(i-1)*ixz1+(l-0)*kxz1)
!! and may equal the former.
!!
!! PROGRAM HISTORY LOG:
!! - 1999-01-05 MARK IREDELL
!!
!! @param[in] im integer number of sequences to search
!! @param[in] km1 integer number of points in each sequence
!! @param[in] ixz1 integer sequence skip number for z1
Expand Down Expand Up @@ -1924,7 +1926,8 @@ subroutine compute_zh

end subroutine compute_zh

!> Cleanup atmospheric field (before adjustment) objects
!> Cleanup atmospheric field (before adjustment) objects.
!!
!! @author George Gayno
subroutine cleanup_target_atm_b4adj_data

Expand Down
4 changes: 4 additions & 0 deletions sorc/chgres_cube.fd/chgres.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
!! with a multiple of six mpi tasks (an ESMF library requirement for
!! fv3 cubed sphere grids).
!!
!! @note For variable names “input” refers to the data input to the
!! program (i.e., GRIB2, NEMSIO, NetCDF). “Target” refers to the
!! target or FV3 model grid.
!!
!! @author George Gayno NOAA/EMC
!! @return 0 for success, error code otherwise.
program chgres
Expand Down
Loading