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

Update doxygen for orog_mask_tools.fd. #421

Merged
merged 26 commits into from
Mar 24, 2021
Merged

Update doxygen for orog_mask_tools.fd. #421

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
d1d06d6
doxygen updates to orog.fd.
GeorgeGayno-NOAA Mar 10, 2021
ec88010
Clear some doxygen warnings from orog.fd
GeorgeGayno-NOAA Mar 11, 2021
5bdc399
Add doxygen to ./orog.fd/mtnlm7_oclsm.f. Remove unused routine
GeorgeGayno-NOAA Mar 11, 2021
60c47f8
Merge branch 'develop' into feature/doxorog
GeorgeGayno-NOAA Mar 11, 2021
cb271d4
Doxygen updates to ./orog.fd/mtnlm7_oclsm.f
GeorgeGayno-NOAA Mar 11, 2021
3e4c291
Clear some doxygen warnings from orog.fd
GeorgeGayno-NOAA Mar 12, 2021
96c4a40
Clear more doxygen warnings from orog.fd
GeorgeGayno-NOAA Mar 12, 2021
4738d89
Get rid of unused machine.f90 from orog.fd.
GeorgeGayno-NOAA Mar 12, 2021
8522114
Clear doxygen warnings from lake.fd code.
GeorgeGayno-NOAA Mar 12, 2021
b74424f
Doxygen updates to ./orog.fd/mtnlm7_oclsm.f
GeorgeGayno-NOAA Mar 15, 2021
6bc0939
Add doxygen to ./orog.fd/mtnlm7_oclsm.f
GeorgeGayno-NOAA Mar 15, 2021
f3b248e
Doxygen updates to ./orog.fd/mtnlm7_oclsm.f
GeorgeGayno-NOAA Mar 16, 2021
128f2a1
Merge branch 'develop' into feature/doxorog
GeorgeGayno-NOAA Mar 16, 2021
f61d08e
Doxygen updates to ./orog.fd/mtnlm7_oclsm.f
GeorgeGayno-NOAA Mar 16, 2021
dd77b7e
Doxygen updates to ./orog.fd/mtnlm7_oclsm.f.
GeorgeGayno-NOAA Mar 16, 2021
b36df62
Doxygen updates to ./orog.fd/mtnlm7_oclsm.f
GeorgeGayno-NOAA Mar 16, 2021
e0a5bc2
More doxygen updates to ./orog.fd/mtnlm7_oclsm.f
GeorgeGayno-NOAA Mar 16, 2021
afd9cff
Doxygen updates to ./orog.fd/mtnlm7_oclsm.f
GeorgeGayno-NOAA Mar 16, 2021
faba1ee
Merge branch 'develop' into feature/doxorog
GeorgeGayno-NOAA Mar 17, 2021
6f3b082
Doxygen updates to ./orog.fd/mtnlm7_oclsm.f
GeorgeGayno-NOAA Mar 17, 2021
8428a32
Doxygen updates to ./orog.fd/mtnlm7_oclsm.f
GeorgeGayno-NOAA Mar 17, 2021
20e85f0
Doxygen updates to ./orog.fd/mtnlm7_oclsm.f
GeorgeGayno-NOAA Mar 17, 2021
5378c73
Doxygen updates to ./lake.fd/lakefrac.F90 and
GeorgeGayno-NOAA Mar 17, 2021
a05f8bb
Doxygen updates to ./lake.fd/find_limit.F90
GeorgeGayno-NOAA Mar 17, 2021
4a22fec
Merge branch 'develop' into feature/doxorog
GeorgeGayno-NOAA Mar 23, 2021
f4066c8
Doxygen update to ./lake.fd/find_limit.F90
GeorgeGayno-NOAA Mar 23, 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
Prev Previous commit
Next Next commit
Clear doxygen warnings from lake.fd code. 
Part of #191
Fixes #408
  • Loading branch information
@GeorgeGayno-NOAA
GeorgeGayno-NOAA committed Mar 12, 2021
commit 85221142b26c022c62992387a2fe83ac3e6346f0
10 changes: 10 additions & 0 deletions sorc/orog_mask_tools.fd/lake.fd/find_limit.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
!> @file
!! @brief Find limit
!! @author Ning Wang

!> Find limit
!!
!! @param[in] p1_in ???
!! @param[in] p2_in ???
!! @param[out] latmin ???
!! @param[out] latmax ???
!! @author Ning Wang
!#define DIAG
SUBROUTINE find_limit (p1_in, p2_in, latmin, latmax)
REAL*8, INTENT(IN) :: p1_in(2), p2_in(2)
Expand Down
54 changes: 51 additions & 3 deletions sorc/orog_mask_tools.fd/lake.fd/lakefrac.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
!> @file
!! This program computes lake fraction and depth numbers for FV3 cubed sphere
!! @brief Compute lake fraction and depth.
!! @author Ning Wang

!> This program computes lake fraction and depth numbers for FV3 cubed sphere
!! grid cells, from a high resolution lat/lon data set.
!!
!! @author Ning Wang @date July 2018
Expand All @@ -12,6 +15,7 @@
!! - Ning Wang, Apr. 2019: Extended the program to process the same lake data
!! for FV3 stand-alone regional (SAR) model.
!!
!! @return 0 for successful completion and for error.
!#define DIAG_N_VERBOSE
#define ADD_ATT_FOR_NEW_VAR
PROGRAM lake_frac
Expand Down Expand Up @@ -129,6 +133,13 @@ PROGRAM lake_frac
STOP
CONTAINS

!> Calculate lake fraction depth
!!
!! @param[in] lakestat ???
!! @param[in] lakedpth ???
!! @param[out] cs_lakestat ???
!! @param[out] cs_lakedpth ???
!! @author Ning Wang
SUBROUTINE cal_lake_frac_depth(lakestat,cs_lakestat,lakedpth,cs_lakedpth)
INTEGER*1, INTENT(IN) :: lakestat(:)
INTEGER*2, INTENT(IN) :: lakedpth(:)
Expand Down Expand Up @@ -358,7 +369,11 @@ SUBROUTINE cal_lake_frac_depth(lakestat,cs_lakestat,lakedpth,cs_lakedpth)

END SUBROUTINE cal_lake_frac_depth


!> Read cubed sphere grid
!!
!! @param[in] res ???
!! @param[out] grid ???
!! @author Ning Wang
SUBROUTINE read_cubed_sphere_grid(res, grid)
INTEGER, INTENT(IN) :: res
REAL, INTENT(OUT) :: grid(:,:)
Expand Down Expand Up @@ -411,6 +426,14 @@ SUBROUTINE read_cubed_sphere_grid(res, grid)

END SUBROUTINE read_cubed_sphere_grid

!> Read cubed sphere reg grid
!!
!! @param[in] res ???
!! @param[out] grid ???
!! @param[in] halo_depth ???
!! @param[out] res_x ???
!! @param[out] res_y ???
!! @author Ning Wang
SUBROUTINE read_cubed_sphere_reg_grid(res, grid, halo_depth, res_x, res_y)
INTEGER, INTENT(IN) :: res, halo_depth
INTEGER, INTENT(OUT) :: res_x, res_y
Expand Down Expand Up @@ -471,6 +494,13 @@ SUBROUTINE read_cubed_sphere_reg_grid(res, grid, halo_depth, res_x, res_y)

END SUBROUTINE read_cubed_sphere_reg_grid

!> Read lake data
!!
!! @param[in] lakedata_path ???
!! @param[out] lake_stat ???
!! @param[out] lake_dpth ???
!! @param[in] nlat ???
!! @param[in] nlon ???
SUBROUTINE read_lakedata(lakedata_path,lake_stat,lake_dpth,nlat,nlon)
CHARACTER(len=256), INTENT(IN) :: lakedata_path
INTEGER*1, INTENT(OUT) :: lake_stat(:)
Expand All @@ -495,7 +525,12 @@ SUBROUTINE read_lakedata(lakedata_path,lake_stat,lake_dpth,nlat,nlon)

END SUBROUTINE read_lakedata


!> Write lake data to oro data.
!!
!! @param[in] cs_res ???
!! @param[in] cs_lakestat ???
!! @param[in] cs_lakedpth ???
!! @author Ning Wang
SUBROUTINE write_lakedata_to_orodata(cs_res, cs_lakestat, cs_lakedpth)
USE netcdf
INTEGER, INTENT(IN) :: cs_res
Expand Down Expand Up @@ -685,6 +720,14 @@ SUBROUTINE write_lakedata_to_orodata(cs_res, cs_lakestat, cs_lakedpth)

END SUBROUTINE write_lakedata_to_orodata

!> write reg lake data to oro data.
!!
!! @param[in] cs_res ???
!! @param[in] tile_x_dim ???
!! @param[in] tile_y_dim ???
!! @param[in] cs_lakestat ???
!! @param[in] cs_lakedpth ???
!! @author Ning Wang
SUBROUTINE write_reg_lakedata_to_orodata(cs_res, tile_x_dim, tile_y_dim, cs_lakestat, cs_lakedpth)
USE netcdf
INTEGER, INTENT(IN) :: cs_res, tile_x_dim, tile_y_dim
Expand Down Expand Up @@ -887,6 +930,11 @@ SUBROUTINE write_reg_lakedata_to_orodata(cs_res, tile_x_dim, tile_y_dim, cs_lake

END SUBROUTINE write_reg_lakedata_to_orodata

!> Check NetCDF error code
!!
!! @param[in] stat Error code.
!! @param[in] opname NetCDF operation that failed.
!! @author Ning Wang
SUBROUTINE nc_opchk(stat,opname)
USE netcdf
IMPLICIT NONE
Expand Down