Skip to content

Commit

Permalink
Clear some doxygen warnings from orog.fd
Browse files Browse the repository at this point in the history 
Part of ufs-community#191
Part of ufs-community#344
Fixes ufs-community#408
  • Loading branch information
@GeorgeGayno-NOAA
GeorgeGayno-NOAA committed Mar 11, 2021
1 parent d1d06d6 commit ec88010
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 63 deletions.
117 changes: 68 additions & 49 deletions sorc/orog_mask_tools.fd/orog.fd/mtnlm7_oclsm.f
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,6 @@
!! @param EFAC
!! @param BLAT
!! @param OUTGRID
!! @param IFAC
!! @param EFAC
!! @param BLAT
!! @param OUTGRID
Expand Down Expand Up @@ -3708,15 +3707,21 @@ SUBROUTINE MAKEOA3(ZAVG,zslm,VAR,GLAT,OA4,OL,IOA4,ELVMAX,
RETURN
END

!> Reverse the east-west and north-south axes
!! in a two-dimensional array.
!!
!! @param [in] im 'i' dimension of the 2-d array.
!! @param [in] jm 'j' dimension of the 2-d array.
!! @param [in] numi Not used.
!! @param [inout] f The two-dimensional array to
!! be processed.
!! @param [out] wrk Two-dimensional work array.
!! @author Jordan Alpert NOAA/EMC
SUBROUTINE REVERS(IM, JM, numi, F, WRK)
!
REAL F(IM,JM), WRK(IM,JM)
integer numi(jm)
C
C reverse east-west and north-south
c...... fix this routine up to take numi (*j*)
C..... at least have 5 variables ....and keep REVLAT .FALSE.
imb2 = im / 2
imb2 = im / 2
do i=1,im*jm
WRK(i,1) = F(i,1)
enddo
Expand Down Expand Up @@ -3775,10 +3780,16 @@ subroutine gg2rg(im,jm,numi,a)
enddo
enddo
end subroutine
SUBROUTINE minmxj(IM,JM,A,title)

c this routine is using real*4 on the sp

!> Print out the maximum and minimum values of
!! an array.
!!
!! @param[in] im The 'i' dimension of the array.
!! @param[in] jm The 'i' dimension of the array.
!! @param[in] a The array to check.
!! @param[in] title Name of the data to be checked.
!! @author Jordan Alpert NOAA/EMC
SUBROUTINE minmxj(IM,JM,A,title)
implicit none

real A(IM,JM),rmin,rmax
Expand All @@ -3801,10 +3812,19 @@ SUBROUTINE minmxj(IM,JM,A,title)
C
RETURN
END
SUBROUTINE mnmxja(IM,JM,A,imax,jmax,title)

c this routine is using real*4 on the sp

!> Print out the maximum and minimum values of
!! an array. Pass back the i/j location of the
!! maximum value.
!!
!! @param[in] im The 'i' dimension of the array.
!! @param[in] jm The 'i' dimension of the array.
!! @param[in] a The array to check.
!! @param[out] imax 'i' location of maximum
!! @param[out] jmax 'j' location of maximum
!! @param[in] title Name of the data to be checked.
!! @author Jordan Alpert NOAA/EMC
SUBROUTINE mnmxja(IM,JM,A,imax,jmax,title)
implicit none

real A(IM,JM),rmin,rmax
Expand Down Expand Up @@ -3929,16 +3949,13 @@ SUBROUTINE SPFFT1(IMAX,INCW,INCG,KMAX,W,G,IDIR)
END SELECT
END SELECT
END SUBROUTINE

!> Read input global 30-arc second orography data.
!!
!! @param[out] glob The orography data.
!! @param[in] itopo Not used.
!! @author Jordan Alpert NOAA/EMC
subroutine read_g(glob,ITOPO)
!
! --- if ITOPO = 1 then read gtopo30_gg.fine 43200X21600 30" file
! --- if ITOPO = 2 then read topo 30" .DEM tile files
! --- in either case, glob will be n Interger*2 array.
! --- This routine write out a grads ctl file for displaying the
! --- tiles in the output working dir. The glob array can not be
! --- acted on with grads, but the tiles can be if lat/lon are reduced slightly
cc
use machine
implicit none
cc
integer*2 glob(360*120,180*120)
Expand All @@ -3951,12 +3968,6 @@ subroutine read_g(glob,ITOPO)
cc
integer*2 idat(ix,jx)
integer itopo
cc
ccmr integer*2 m9999
ccmr data m9999 / -9999 /
cc
ccmr integer i_count(360*120)
ccmr integer j_max_y(360*120)
cc
integer i,j,inttyp
cc
Expand All @@ -3965,7 +3976,6 @@ subroutine read_g(glob,ITOPO)
open(235, file="./fort.235", access='direct', recl=43200*21600*2)
read(235,rec=1)glob
close(235)
cc
cc
print*,' '
call maxmin (glob,360*120*180*120,'global0')
Expand All @@ -3988,6 +3998,13 @@ subroutine read_g(glob,ITOPO)
cc
return
end
!> Print the maximum, mininum, mean and
!! standard deviation of an array.
!!
!! @param [in] ia The array to be checked.
!! @param [in] len The number of points to be checked.
!! @param [in] tile A name associated with the array.
!! @author Jordan Alpert NOAA/EMC
subroutine maxmin(ia,len,tile)
ccmr
implicit none
Expand Down Expand Up @@ -4036,10 +4053,17 @@ subroutine maxmin(ia,len,tile)
& ' ko9s=',kount,kount_9,kount+kount_9
return
end
SUBROUTINE minmaxj(IM,JM,A,title)

c this routine is using real*4 on the sp

!> Print out the maximum and minimum values of
!! an array and their i/j location. Also print out
!! the number of undefined points.
!!
!! @param[in] im The 'i' dimension of the array.
!! @param[in] jm The 'i' dimension of the array.
!! @param[in] a The array to check.
!! @param[in] title Name of the data to be checked.
!! @author Jordan Alpert NOAA/EMC
SUBROUTINE minmaxj(IM,JM,A,title)
implicit none

real(kind=4) A(IM,JM),rmin,rmax,undef
Expand Down Expand Up @@ -4081,7 +4105,6 @@ SUBROUTINE minmaxj(IM,JM,A,title)
C
RETURN
END


!routine to map (lon, lat) to (x,y,z)
subroutine latlon2xyz(siz,lon, lat, x, y, z)
Expand Down Expand Up @@ -4411,24 +4434,20 @@ subroutine get_xnsum3(lon1,lat1,lon2,lat2,IMN,JMN,

end subroutine get_xnsum3

!> Report NaNS and NaNQ within an address range for
!! 8-byte real words.
!!
!! This routine prints a single line for each call
!! and prints a message and returns to the caller on
!! detection of the FIRST NaN in the range. If no NaN values
!! are found it returns silently.
!!
!! @param[in] A Real*8 variable or array
!! @param[in] L Number of words to scan (length of array)
!! @param[in] C Distinctive message set in caller to indicate where
!! the routine was called.
!! @author Jordan Alpert NOAA/EMC
subroutine nanc(a,l,c)
c compiler opt TRAPS= -qinitauto=FF911299 -qflttrap=ov:zero:inv:en -qsig trap
c or call subroutine below
c subroutine to report NaNS and NaNQ within an address
c range for real*8 words.
c as written the routine prints a single line for each call
c and prints a message and returns to the caller on detection of the FIRST
c NaN in the range. The message is passed in the third
c argument. If no NaN values are found it returns silently.
c A real*4 version can be created by making A real*4

c arguments (all are input only)
c
c A real*8 variable or array
c L number of words to scan (length of array)
c C distinctive message set in caller to indicate where
c the routine was called.
c
integer inan1,inan2,inan3,inan4,inaq1,inaq2,inaq3,inaq4
real word
integer itest
Expand Down
28 changes: 14 additions & 14 deletions sorc/orog_mask_tools.fd/orog.fd/netcdf_io.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,20 @@

!> Write out orography file in netcdf format.
!!
!! @param[in] im ???
!! @param[in] jm ???
!! @param[in] slm ???
!! @param[in] land_frac ???
!! @param[in] oro ???
!! @param[in] orf ???
!! @param[in] hprime ???
!! @param[in] ntiles ???
!! @param[in] tile ???
!! @param[in] geolon ???
!! @param[in] geolat ???
!! @param[in] lon ???
!! @param[in] lat ???
!! @author Jordan Alpert NOAA/EMC
!! @param[in] im 'i' dimension of a model grid tile.
!! @param[in] jm 'j' dimension of a model grid tile.
!! @param[in] slm Land-sea mask.
!! @param[in] land_frac Land fraction.
!! @param[in] oro Orography
!! @param[in] orf Filtered orography. Currently the same as 'oro'.
!! @param[in] hprime The gravity wave drag fields on the model grid tile.
!! @param[in] ntiles Number of tiles to output.
!! @param[in] tile Tile number to output.
!! @param[in] geolon Longitude on the model grid tile.
!! @param[in] geolat Latitude on the model grid tile.
!! @param[in] lon Longitude of the first row of the model grid tile.
!! @param[in] lat Latitude of the first column of the model grid tile.
!! @author Jordan Alpert NOAA/EMC GFDL Programmer
subroutine write_netcdf(im, jm, slm, land_frac, oro, orf, hprime, ntiles, tile, geolon, geolat, lon, lat)
implicit none
integer, intent(in):: im, jm, ntiles, tile
Expand Down

0 comments on commit ec88010

Please sign in to comment.