Skip to content

Commit

Permalink
More doxygen updates to ./orog.fd/mtnlm7_oclsm.f
Browse files Browse the repository at this point in the history
  • Loading branch information
GeorgeGayno-NOAA committed Mar 16, 2021
1 parent b36df62 commit e0a5bc2
Showing 1 changed file with 20 additions and 16 deletions.
36 changes: 20 additions & 16 deletions sorc/orog_mask_tools.fd/orog.fd/mtnlm7_oclsm.f
Original file line number Diff line number Diff line change
Expand Up @@ -2876,14 +2876,16 @@ SUBROUTINE MAKEOA(ZAVG,VAR,GLAT,OA4,OL,IOA4,ELVMAX,
WRITE(6,*) "! MAKEOA EXIT"
C
RETURN
END
END SUBROUTINE MAKEOA

!> Get longitude angle
!> Convert the 'x' direction distance of a cubed-sphere grid
!! point to the corresponding distance in longitude.
!!
!! @param[in] dx ???
!! @param[in] lat ???
!! @param[in] degrad ???
!! @return get_lon_angle Longitude angle.
!! @param[in] dx Distance along the 'x' direction of a
!! cubed-sphere grid point.
!! @param[in] lat Latitude of the cubed-sphere point.
!! @param[in] degrad Conversion from radians to degrees.
!! @return get_lon_angle Corresponding distance in longitude.
!! @author GFDL programmer
function get_lon_angle(dx,lat, DEGRAD)
implicit none
Expand All @@ -2896,11 +2898,13 @@ function get_lon_angle(dx,lat, DEGRAD)

end function get_lon_angle

!> Get latitude angle
!> Convert the 'y' direction distance of a cubed-sphere grid
!! point to the corresponding distance in latitude.
!!
!! @param[in] dy ???
!! @param[in] degrad ???
!! @return get_lat_angle ???
!! @param[in] dy Distance along the 'y' direction of a cubed-sphere
!! point.
!! @param[in] degrad Conversion from radians to degrees.
!! @return get_lat_angle Corresponding distance in latitude.
!! @author GFDL programmer
function get_lat_angle(dy, DEGRAD)
implicit none
Expand Down Expand Up @@ -3333,14 +3337,14 @@ SUBROUTINE MAKEOA2(ZAVG,zslm,VAR,GLAT,OA4,OL,IOA4,ELVMAX,
WRITE(6,*) "! MAKEOA2 EXIT"
C
RETURN
END
END SUBROUTINE MAKEOA2

!> Compute a great circle distance
!> Compute a great circle distance between two points.
!!
!! @param[in] theta1 ???
!! @param[in] phi1 ???
!! @param[in] theta2 ???
!! @param[in] phi2 ???
!! @param[in] theta1 Longitude of point 1.
!! @param[in] phi1 Latitude of point 1.
!! @param[in] theta2 Longitude of point 2.
!! @param[in] phi2 Latitude of point2.
!! @return spherical_distance Great circle distance.
!! @author GFDL programmer
function spherical_distance(theta1,phi1,theta2,phi2)
Expand Down

0 comments on commit e0a5bc2

Please sign in to comment.