Skip to content

Use MOM_io in Surface_Bands_by_data_override #1388

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
marshallward merged 4 commits into from
May 14, 2021
Merged

Use MOM_io in Surface_Bands_by_data_override #1388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc72b31
Use MOM_io in Surface_Bands_by_data_override
Hallberg-NOAA Apr 30, 2021
58d01d1
Merge branch 'dev/gfdl' into MOM_io_in_wave_interface
Hallberg-NOAA May 13, 2021
c5a45c6
+Avoid using field_exists in MOM_wave_interface
Hallberg-NOAA May 14, 2021
55a93d8
Merge branch 'dev/gfdl' into MOM_io_in_wave_interface
Hallberg-NOAA May 14, 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
11 changes: 6 additions & 5 deletions src/framework/MOM_io.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -647,15 +647,16 @@ subroutine get_var_sizes(filename, varname, ndims, sizes, match_case, caller, al
do n=2,nval ; sizes(n-1) = size_msg(n) ; enddo
deallocate(size_msg)

if (present(dim_names)) then
if (present(dim_names) .and. (ndims > 0)) then
nval = min(ndims, size(dim_names))
call broadcast(dim_names(1:nval), len(dim_names(1)), blocking=.true.)
endif
endif

end subroutine get_var_sizes

!> read_var_sizes returns the number and size of dimensions associate with a variable in a file.
!> read_var_sizes returns the number and size of dimensions associated with a variable in a file.
!! If the variable is not in the file the returned sizes are all 0 and ndims is -1.
!! Every processor for which this is called does the reading.
subroutine read_var_sizes(filename, varname, ndims, sizes, match_case, caller, dim_names, ncid_in)
character(len=*), intent(in) :: filename !< Name of the file to read, used here in messages
Expand All @@ -675,7 +676,7 @@ subroutine read_var_sizes(filename, varname, ndims, sizes, match_case, caller, d
character(len=256) :: hdr, dimname
integer, allocatable :: dimids(:)
integer :: varid, ncid, n, status
logical :: success
logical :: success, found
hdr = "get_var_size: " ; if (present(caller)) hdr = trim(hdr)//": "
sizes(:) = 0 ; ndims = -1

Expand All @@ -687,8 +688,8 @@ subroutine read_var_sizes(filename, varname, ndims, sizes, match_case, caller, d
endif

! Get the dimension sizes of the variable varname.
call get_varid(varname, ncid, filename, varid, match_case=match_case)
if (varid < 0) return
call get_varid(varname, ncid, filename, varid, match_case=match_case, found=found)
if (.not.found) return

status = NF90_inquire_variable(ncid, varid, ndims=ndims)
if (status /= NF90_NOERR) then
Expand Down
162 changes: 51 additions & 111 deletions src/user/MOM_wave_interface.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,13 @@ module MOM_wave_interface
use MOM_file_parser, only : get_param, log_version, param_file_type
use MOM_forcing_type, only : mech_forcing
use MOM_grid, only : ocean_grid_type
use MOM_io, only : file_exists, get_var_sizes, read_variable
use MOM_safe_alloc, only : safe_alloc_ptr
use MOM_time_manager, only : time_type, operator(+), operator(/)
use MOM_unit_scaling, only : unit_scale_type
use MOM_variables, only : thermo_var_ptrs, surface
use MOM_verticalgrid, only : verticalGrid_type

use netcdf, only : NF90_open, NF90_inq_varid, NF90_inquire_variable, NF90_get_var
use netcdf, only : NF90_inquire_dimension, NF90_close, NF90_NOWRITE, NF90_NOERR

implicit none ; private

#include <MOM_memory.h>
Expand Down Expand Up @@ -405,13 +403,13 @@ subroutine MOM_wave_interface_init(time, G, GV, US, param_file, CS, diag )

! Initialize Wave related outputs
CS%id_surfacestokes_y = register_diag_field('ocean_model','surface_stokes_y', &
CS%diag%axesCu1,Time,'Surface Stokes drift (y)','m s-1')
CS%diag%axesCv1,Time,'Surface Stokes drift (y)','m s-1')
CS%id_surfacestokes_x = register_diag_field('ocean_model','surface_stokes_x', &
CS%diag%axesCv1,Time,'Surface Stokes drift (x)','m s-1')
CS%diag%axesCu1,Time,'Surface Stokes drift (x)','m s-1')
CS%id_3dstokes_y = register_diag_field('ocean_model','3d_stokes_y', &
CS%diag%axesCvL,Time,'3d Stokes drift (y)','m s-1')
CS%id_3dstokes_x = register_diag_field('ocean_model','3d_stokes_x', &
CS%diag%axesCuL,Time,'3d Stokes drift (y)','m s-1')
CS%diag%axesCuL,Time,'3d Stokes drift (x)','m s-1')
CS%id_La_turb = register_diag_field('ocean_model','La_turbulent',&
CS%diag%axesT1,Time,'Surface (turbulent) Langmuir number','nondim')

Expand Down Expand Up @@ -785,134 +783,76 @@ subroutine Surface_Bands_by_data_override(day_center, G, GV, US, CS)
! Local variables
real :: temp_x(SZI_(G),SZJ_(G)) ! Pseudo-zonal Stokes drift of band at h-points [m s-1]
real :: temp_y(SZI_(G),SZJ_(G)) ! Psuedo-meridional Stokes drift of band at h-points [m s-1]
real :: Top, MidPoint
integer :: b
integer :: i, j
integer, dimension(4) :: start, counter, dims, dim_id
character(len=12) :: dim_name(4)
character(20) :: varname, varread1, varread2
integer :: rcode_fr, rcode_wn, ncid, varid_fr, varid_wn, id, ndims
integer, dimension(4) :: sizes ! The sizes of the various dimensions of the variable.
character(len=48) :: dim_name(4) ! The names of the dimensions of the variable.
character(len=20) :: varname ! The name of an input variable for data override.
logical :: wavenumber_exists
integer :: ndims, b, i, j

if (.not.dataOverrideIsInitialized) then
call data_override_init(G%Domain)
dataOverrideIsInitialized = .true.

! Read in number of wavenumber bands in file to set number to be read in
! Hardcoded filename/variables
varread1 = 'wavenumber' !Old method gives wavenumber
varread2 = 'frequency' !New method gives frequency
rcode_wn = NF90_OPEN(trim(SurfBandFileName), NF90_NOWRITE, ncid)
if (rcode_wn /= 0) then
call MOM_error(FATAL,"error opening file "//trim(SurfBandFileName)//&
" in MOM_wave_interface.")
endif
if (.not.file_exists(SurfBandFileName)) &
call MOM_error(FATAL, "MOM_wave_interface is unable to find file "//trim(SurfBandFileName))

! Check if rcode_wn or rcode_fr is 0 (checks if input has wavenumber or frequency)
rcode_wn = NF90_INQ_VARID(ncid, varread1, varid_wn)
rcode_fr = NF90_INQ_VARID(ncid, varread2, varid_fr)
! Check if input has wavenumber or frequency variables.

if (rcode_wn /= 0 .and. rcode_fr /= 0) then
call MOM_error(FATAL,"error finding variable "//trim(varread1)//&
" or "//trim(varread2)//" in file "//trim(SurfBandFileName)//" in MOM_wave_interface.")
! Read the number of wavenumber bands in the file, if the variable 'wavenumber' exists.
call get_var_sizes(SurfBandFileName, 'wavenumber', ndims, sizes, dim_names=dim_name)
wavenumber_exists = (ndims > -1)

if (.not.wavenumber_exists) then
! Read the number of frequency bands in the file, if the variable 'frequency' exists.
call get_var_sizes(SurfBandFileName, 'frequency', ndims, sizes, dim_names=dim_name)
if (ndims < 0) &
call MOM_error(FATAL, "error finding variable 'wavenumber' or 'frequency' in file "//&
trim(SurfBandFileName)//" in MOM_wave_interface.")
endif

elseif (rcode_wn == 0) then
! wavenumbers found:
CS%NUMBANDS = sizes(1)
! Allocate the wavenumber bins
allocate( CS%WaveNum_Cen(CS%NUMBANDS) ) ; CS%WaveNum_Cen(:) = 0.0

if (wavenumber_exists) then
! Wavenumbers found, so this file uses the old method:
PartitionMode = 0
rcode_wn = NF90_INQUIRE_VARIABLE(ncid, varid_wn, ndims=ndims, &
dimids=dims)
if (rcode_wn /= 0) then
call MOM_error(FATAL, &
'error inquiring dimensions MOM_wave_interface.')
endif
rcode_wn = NF90_INQUIRE_DIMENSION(ncid, dims(1), dim_name(1), len=id)
if (rcode_wn /= 0) then
call MOM_error(FATAL,"error reading dimension 1 data for "// &
trim(varread1)//" in file "// trim(SurfBandFileName)// &
" in MOM_wave_interface.")
endif
rcode_wn = NF90_INQ_VARID(ncid, dim_name(1), dim_id(1))
if (rcode_wn /= 0) then
call MOM_error(FATAL,"error finding variable "//trim(dim_name(1))//&
" in file "//trim(SurfBandFileName)//" in MOM_wave_interace.")
endif
! Allocating size of wavenumber bins
allocate( CS%WaveNum_Cen(1:id) )
CS%WaveNum_Cen(:) = 0.0
elseif (rcode_fr == 0) then
! frequencies found:

! Reading wavenumber bins
call read_variable(SurfBandFileName, dim_name(1), CS%WaveNum_Cen, scale=US%Z_to_m)

else
! Frequencies found, so this file uses the newer method:
PartitionMode = 1
rcode_fr = NF90_INQUIRE_VARIABLE(ncid, varid_fr, ndims=ndims, &
dimids=dims)
if (rcode_fr /= 0) then
call MOM_error(FATAL,&
'error inquiring dimensions MOM_wave_interface.')
endif
rcode_fr = NF90_INQUIRE_DIMENSION(ncid, dims(1), dim_name(1), len=id)
if (rcode_fr /= 0) then
call MOM_error(FATAL,"error reading dimension 1 data for "// &
trim(varread2)//" in file "// trim(SurfBandFileName)// &
" in MOM_wave_interface.")
endif
rcode_fr = NF90_INQ_VARID(ncid, dim_name(1), dim_id(1))
if (rcode_fr /= 0) then
call MOM_error(FATAL,"error finding variable "//trim(dim_name(1))//&
" in file "//trim(SurfBandFileName)//" in MOM_wave_interace.")
endif
! Allocating size of frequency bins
allocate( CS%Freq_Cen(1:id) )
CS%Freq_Cen(:) = 0.0
! Allocating size of wavenumber bins
allocate( CS%WaveNum_Cen(1:id) )
CS%WaveNum_Cen(:) = 0.0
allocate( CS%STKx0(G%isdB:G%iedB,G%jsd:G%jed,1:id))
CS%STKx0(:,:,:) = 0.0
allocate( CS%STKy0(G%isd:G%ied,G%jsdB:G%jedB,1:id))
CS%STKy0(:,:,:) = 0.0
endif

! Reading wavenumber bins/Frequencies
start(:) = 1 ! Set all start to 1
counter(:) = 1 ! Set all counter to 1
counter(1) = id ! Set counter(1) to id (number of frequency bins)
if (PartitionMode==0) then
rcode_wn = NF90_GET_VAR(ncid, dim_id(1), CS%WaveNum_Cen, start, counter)
if (rcode_wn /= 0) then
call MOM_error(FATAL,&
"error reading dimension 1 values for var_name "// &
trim(varread1)//",dim_name "//trim(dim_name(1))// &
" in file "// trim(SurfBandFileName)//" in MOM_wave_interface")
endif
CS%NUMBANDS = ID
do B = 1,CS%NumBands ; CS%WaveNum_Cen(b) = US%Z_to_m*CS%WaveNum_Cen(b) ; enddo
elseif (PartitionMode==1) then
rcode_fr = NF90_GET_VAR(ncid, dim_id(1), CS%Freq_Cen, start, counter)
if (rcode_fr /= 0) then
call MOM_error(FATAL,&
"error reading dimension 1 values for var_name "// &
trim(varread2)//",dim_name "//trim(dim_name(1))// &
" in file "// trim(SurfBandFileName)//" in MOM_wave_interface")
endif
CS%NUMBANDS = ID
! Allocate the frequency bins
allocate( CS%Freq_Cen(CS%NUMBANDS) ) ; CS%Freq_Cen(:) = 0.0

! Reading frequencies
call read_variable(SurfBandFileName, dim_name(1), CS%Freq_Cen) !, scale=US%T_to_s)

do B = 1,CS%NumBands
CS%WaveNum_Cen(b) = (2.*PI*CS%Freq_Cen(b)*US%T_to_s)**2 / (US%L_to_Z**2*GV%g_Earth)
enddo
endif

rcode_wn = NF90_close(ncid)
if (rcode_wn /= 0) call MOM_error(WARNING, &
"Error closing file "//trim(SurfBandFileName)//" in MOM_wave_interface.")

if (.not.allocated(CS%STKx0)) then
allocate( CS%STKx0(G%isdB:G%iedB,G%jsd:G%jed,CS%NUMBANDS) ) ; CS%STKx0(:,:,:) = 0.0
endif
if (.not.allocated(CS%STKy0)) then
allocate( CS%STKy0(G%isd:G%ied,G%jsdB:G%jedB,CS%NUMBANDS) ) ; CS%STKy0(:,:,:) = 0.0
endif
endif

do b = 1,CS%NumBands
temp_x(:,:) = 0.0
temp_y(:,:) = 0.0
varname = ' '
write(varname,"(A3,I0)")'Usx',b
call data_override('OCN',trim(varname), temp_x, day_center)
call data_override('OCN', trim(varname), temp_x, day_center)
varname = ' '
write(varname,'(A3,I0)')'Usy',b
call data_override('OCN',trim(varname), temp_y, day_center)
call data_override('OCN', trim(varname), temp_y, day_center)
! Disperse into halo on h-grid
call pass_vector(temp_x, temp_y, G%Domain, To_All, AGRID)
!Filter land values
Expand All @@ -937,8 +877,8 @@ subroutine Surface_Bands_by_data_override(day_center, G, GV, US, CS)
CS%STKy0(i,J,b) = 0.5 * (temp_y(i,j) + temp_y(i,j+1))
enddo
enddo
! Disperse into halo on u/v grids
call pass_vector(CS%STKx0(:,:,b),CS%STKy0(:,:,b), G%Domain, To_ALL)
! Disperse into halo on u/v grids (This would be faster if it were moved out of the b-loop.)
call pass_vector(CS%STKx0(:,:,b), CS%STKy0(:,:,b), G%Domain, To_ALL)
enddo !Closes b-loop

end subroutine Surface_Bands_by_data_override
Expand Down