Skip to content

Commit

Permalink
dOxyGenized MOM_grid_initialization.F90
Browse files Browse the repository at this point in the history 
  Added dOxyGen comments for all remaining routines and arguments in
MOM_grid_initialization.F90.  All answers are bitwise identical.
  • Loading branch information
@Hallberg-NOAA
Hallberg-NOAA committed May 8, 2018
1 parent 1d10503 commit 28da3a2
Showing 1 changed file with 70 additions and 37 deletions.
107 changes: 70 additions & 37 deletions src/initialization/MOM_grid_initialize.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,27 @@ module MOM_grid_initialize
public set_grid_metrics, initialize_masks, Adcroft_reciprocal

type, public :: GPS ; private
real :: len_lon
real :: len_lat
real :: west_lon
real :: south_lat
real :: Rad_Earth
real :: Lat_enhance_factor
real :: Lat_eq_enhance
logical :: isotropic
logical :: equator_reference
integer :: niglobal, njglobal ! Duplicates of niglobal and njglobal from MOM_dom
real :: len_lon !< The longitudinal or x-direction length of the domain.
real :: len_lat !< The latitudinal or y-direction length of the domain.
real :: west_lon !< The western longitude of the domain or the equivalent
!! starting value for the x-axis.
real :: south_lat !< The southern latitude of the domain or the equivalent
!! starting value for the y-axis.
real :: Rad_Earth !< The radius of the Earth, in m.
real :: Lat_enhance_factor !< The amount by which the meridional resolution
!! is enhanced within LAT_EQ_ENHANCE of the equator.
real :: Lat_eq_enhance !< The latitude range to the north and south of the equator
!! over which the resolution is enhanced, in degrees.
logical :: isotropic !< If true, an isotropic grid on a sphere (also known as a Mercator grid)
!! is used. With an isotropic grid, the meridional extent of the domain
!! (LENLAT), the zonal extent (LENLON), and the number of grid points in each
!! direction are _not_ independent. In MOM the meridional extent is determined
!! to fit the zonal extent and the number of grid points, while grid is
!! perfectly isotropic.
logical :: equator_reference !< If true, the grid is defined to have the equator at the
!! nearest q- or h- grid point to (-LOWLAT*NJGLOBAL/LENLAT).
integer :: niglobal !< The number of i-points in the global grid computational domain
integer :: njglobal !< The number of j-points in the global grid computational domain
end type GPS

contains
Expand Down Expand Up @@ -966,9 +977,11 @@ subroutine set_grid_metrics_mercator(G, param_file)
end subroutine set_grid_metrics_mercator


!> This function returns the grid spacing in the logical x direction.
function ds_di(x, y, GP)
real, intent(in) :: x, y
type(GPS), intent(in) :: GP
real, intent(in) :: x !< The longitude in question
real, intent(in) :: y !< The latitude in question
type(GPS), intent(in) :: GP !< A structure of grid parameters
real :: ds_di
! This function returns the grid spacing in the logical x direction.
! Arguments: x - The latitude in question.
Expand All @@ -979,9 +992,11 @@ function ds_di(x, y, GP)
! dy_di(x,y,GP)*dy_di(x,y,GP))
end function ds_di

!> This function returns the grid spacing in the logical y direction.
function ds_dj(x, y, GP)
real, intent(in) :: x, y
type(GPS), intent(in) :: GP
real, intent(in) :: x !< The longitude in question
real, intent(in) :: y !< The latitude in question
type(GPS), intent(in) :: GP !< A structure of grid parameters
real :: ds_dj
! This function returns the grid spacing in the logical y direction.
! Arguments: x - The latitude in question.
Expand All @@ -993,13 +1008,18 @@ function ds_dj(x, y, GP)
end function ds_dj


!> This function returns the contribution from the line integral along one of the four sides of a
!! cell face to the area of a cell, assuming that the sides follow a linear path in latitude and
!! longitude (i.e., on a Mercator grid).
function dL(x1, x2, y1, y2)
real, intent(in) :: x1, x2, y1, y2
real, intent(in) :: x1 !< Segment starting longitude, in degrees E.
real, intent(in) :: x2 !< Segment ending longitude, in degrees E.
real, intent(in) :: y1 !< Segment ending latitude, in degrees N.
real, intent(in) :: y2 !< Segment ending latitude, in degrees N.
real :: dL
! This subroutine calculates the contribution from the line integral
! along one of the four sides of a cell face to the area of a cell,
! assuming that the sides follow a linear path in latitude and long-
! itude (i.e., on a Mercator grid).
! This subroutine calculates the contribution from the line integral along one
! of the four sides of a cell face to the area of a cell, assuming that the
! sides follow a linear path in latitude and longitude (i.e., on a Mercator grid).
! Argumnts: x1 - Segment starting longitude.
! (in) x2 - Segment ending longitude.
! (in) y1 - Segment ending latitude.
Expand All @@ -1017,17 +1037,25 @@ function dL(x1, x2, y1, y2)

end function dL

!> This subroutine finds and returns the value of y at which the monotonically increasing
!! function fn takes the value fnval, also returning in ittmax the number of iterations of
!! Newton's method that were used to polish the root.
function find_root( fn, dy_df, GP, fnval, y1, ymin, ymax, ittmax)
real :: find_root
real, external :: fn, dy_df
type(GPS), intent(in) :: GP
real, intent(in) :: fnval, y1, ymin, ymax
integer, intent(out) :: ittmax
real :: y, y_next
real :: find_root !< The value of y where fn(y) = fnval that will be returned
real, external :: fn !< The external function whose root is being sought
real, external :: dy_df !< The inverse of the derivative of that function
type(GPS), intent(in) :: GP !< A structure of grid parameters
real, intent(in) :: fnval !< The value of fn being sought
real, intent(in) :: y1 !< A first guess for y
real, intent(in) :: ymin !< The minimum permitted value of y
real, intent(in) :: ymax !< The maximum permitted value of y
integer, intent(out) :: ittmax !< The number of iterations used to polish the root

! This subroutine finds and returns the value of y at which the
! monotonically increasing function fn takes the value fnval, also returning
! in ittmax the number of iterations of Newton's method that were
! used to polish the root.
real :: y, y_next
real :: ybot, ytop, fnbot, fntop
integer :: itt
character(len=256) :: warnmesg
Expand Down Expand Up @@ -1126,21 +1154,24 @@ function find_root( fn, dy_df, GP, fnval, y1, ymin, ymax, ittmax)
find_root = y
end function find_root

!> This function calculates and returns the value of dx/di, where x is the
!! longitude in Radians, and i is the integral north-south grid index.
function dx_di(x, GP)
real, intent(in) :: x
type(GPS), intent(in) :: GP
real, intent(in) :: x !< The longitude in question
type(GPS), intent(in) :: GP !< A structure of grid parameters
real :: dx_di
! This subroutine calculates and returns the value of dx/di, where
! x is the longitude in Radians, and i is the integral north-south
! grid index.
! x is the longitude in Radians, and i is the integral north-south grid index.

dx_di = (GP%len_lon * 4.0*atan(1.0)) / (180.0 * GP%niglobal)

end function dx_di

!> This function calculates and returns the integral of the inverse
!! of dx/di to the point x, in radians.
function Int_di_dx(x, GP)
real, intent(in) :: x
type(GPS), intent(in) :: GP
real, intent(in) :: x !< The longitude in question
type(GPS), intent(in) :: GP !< A structure of grid parameters
real :: Int_di_dx
! This subroutine calculates and returns the integral of the inverse
! of dx/di to the point x, in radians.
Expand All @@ -1149,9 +1180,11 @@ function Int_di_dx(x, GP)

end function Int_di_dx

!> This subroutine calculates and returns the value of dy/dj, where y is the
!! latitude in Radians, and j is the integral north-south grid index.
function dy_dj(y, GP)
real, intent(in) :: y
type(GPS), intent(in) :: GP
real, intent(in) :: y !< The latitude in question
type(GPS), intent(in) :: GP !< A structure of grid parameters
real :: dy_dj
! This subroutine calculates and returns the value of dy/dj, where
! y is the latitude in Radians, and j is the integral north-south
Expand All @@ -1178,9 +1211,11 @@ function dy_dj(y, GP)

end function dy_dj

!> This subroutine calculates and returns the integral of the inverse
!! of dy/dj to the point y, in radians.
function Int_dj_dy(y, GP)
real, intent(in) :: y
type(GPS), intent(in) :: GP
real, intent(in) :: y !< The latitude in question
type(GPS), intent(in) :: GP !< A structure of grid parameters
real :: Int_dj_dy
! This subroutine calculates and returns the integral of the inverse
! of dy/dj to the point y, in radians.
Expand Down Expand Up @@ -1223,8 +1258,6 @@ end function Int_dj_dy

! ------------------------------------------------------------------------------

! ------------------------------------------------------------------------------

!> extrapolate_metric extrapolates missing metric data into all the halo regions.
subroutine extrapolate_metric(var, jh, missing)
real, dimension(:,:), intent(inout) :: var !< The array in which to fill in halos
Expand Down

0 comments on commit 28da3a2

Please sign in to comment.