#include "cppdefs.h" MODULE omega_mod #ifdef SOLVE3D ! !svn $Id: omega.F 889 2018-02-10 03:32:52Z arango $ !======================================================================= ! Copyright (c) 2002-2019 The ROMS/TOMS Group ! ! Licensed under a MIT/X style license ! ! See License_ROMS.txt Hernan G. Arango ! !========================================== Alexander F. Shchepetkin === ! ! ! This routine computes S-coordinate vertical velocity (m^3/s), ! ! ! ! W=[Hz/(m*n)]*omega, ! ! ! ! diagnostically at horizontal RHO-points and vertical W-points. ! ! ! !======================================================================= ! implicit none ! PRIVATE PUBLIC :: omega, scale_omega ! CONTAINS ! !*********************************************************************** SUBROUTINE omega (ng, tile, model) !*********************************************************************** ! USE mod_param USE mod_grid USE mod_ocean # if defined SEDIMENT && defined SED_MORPH USE mod_sedbed USE mod_stepping # endif ! ! Imported variable declarations. ! integer, intent(in) :: ng, tile, model ! ! Local variable declarations. ! # include "tile.h" ! # ifdef PROFILE CALL wclock_on (ng, model, 13, __LINE__, __FILE__) # endif CALL omega_tile (ng, tile, model, & & LBi, UBi, LBj, UBj, & & IminS, ImaxS, JminS, JmaxS, & # if defined SEDIMENT && defined SED_MORPH & nstp(ng), nnew(ng), & & GRID(ng) % omn, & & SEDBED(ng) % bed_thick, & # endif & GRID(ng) % Huon, & & GRID(ng) % Hvom, & & GRID(ng) % z_w, & # if defined WEC_VF & OCEAN(ng) % W_stokes, & # endif & OCEAN(ng) % W) # ifdef PROFILE CALL wclock_off (ng, model, 13, __LINE__, __FILE__) # endif RETURN END SUBROUTINE omega ! !*********************************************************************** SUBROUTINE omega_tile (ng, tile, model, & & LBi, UBi, LBj, UBj, & & IminS, ImaxS, JminS, JmaxS, & # if defined SEDIMENT && defined SED_MORPH & nstp, nnew, & & omn, bed_thick, & # endif & Huon, Hvom, & & z_w, & # if defined WEC_VF & W_stokes, & # endif & W) !*********************************************************************** ! USE mod_param USE mod_scalars USE mod_sources ! USE bc_3d_mod, ONLY : bc_w3d_tile # ifdef DISTRIBUTE USE mp_exchange_mod, ONLY : mp_exchange3d # endif ! ! Imported variable declarations. ! integer, intent(in) :: ng, tile, model integer, intent(in) :: LBi, UBi, LBj, UBj integer, intent(in) :: IminS, ImaxS, JminS, JmaxS # if defined SEDIMENT && defined SED_MORPH integer, intent(in) :: nstp, nnew # endif ! # ifdef ASSUMED_SHAPE # if defined SEDIMENT && defined SED_MORPH real(r8), intent(in) :: omn(LBi:,LBj:) real(r8), intent(in):: bed_thick(LBi:,LBj:,:) # endif real(r8), intent(in) :: Huon(LBi:,LBj:,:) real(r8), intent(in) :: Hvom(LBi:,LBj:,:) real(r8), intent(in) :: z_w(LBi:,LBj:,0:) # if defined WEC_VF real(r8), intent(in) :: W_stokes(LBi:,LBj:,0:) # endif real(r8), intent(out) :: W(LBi:,LBj:,0:) # else # if defined SEDIMENT && defined SED_MORPH real(r8), intent(in) :: omn(LBi:UBi,LBj:UBj) real(r8), intent(in):: bed_thick(LBi:UBi,LBj:UBj,2) # endif real(r8), intent(in) :: Huon(LBi:UBi,LBj:UBj,N(ng)) real(r8), intent(in) :: Hvom(LBi:UBi,LBj:UBj,N(ng)) real(r8), intent(in) :: z_w(LBi:UBi,LBj:UBj,0:N(ng)) # if defined WEC_VF real(r8), intent(in) :: W_stokes(LBi:UBi,LBj:UBj,0:N(ng)) # endif real(r8), intent(out) :: W(LBi:UBi,LBj:UBj,0:N(ng)) # endif ! ! Local variable declarations. ! integer :: i, ii, is, j, jj, k # if defined SEDIMENT && defined SED_MORPH real(r8) :: cff1 # endif real(r8), dimension(IminS:ImaxS) :: wrk # include "set_bounds.h" ! !------------------------------------------------------------------------ ! Vertically integrate horizontal mass flux divergence. !------------------------------------------------------------------------ ! ! Starting with zero vertical velocity at the bottom, integrate ! from the bottom (k=0) to the free-surface (k=N). The w(:,:,N(ng)) ! contains the vertical velocity at the free-surface, d(zeta)/d(t). ! Notice that barotropic mass flux divergence is not used directly. ! # if defined SEDIMENT && defined SED_MORPH cff1=1.0_r8/dt(ng) # endif DO j=Jstr,Jend DO i=Istr,Iend # if defined SEDIMENT && defined SED_MORPH W(i,j,0)=-cff1*(bed_thick(i,j,nstp)- & & bed_thick(i,j,nnew))*omn(i,j) # else W(i,j,0)=0.0_r8 # endif END DO DO k=1,N(ng) DO i=Istr,Iend W(i,j,k)=W(i,j,k-1)- & & (Huon(i+1,j,k)-Huon(i,j,k)+ & & Hvom(i,j+1,k)-Hvom(i,j,k)) END DO END DO ! ! Apply mass point sources (volume vertical influx), if any. ! IF (LwSrc(ng)) THEN DO is=1,Nsrc(ng) ii=SOURCES(ng)%Isrc(is) jj=SOURCES(ng)%Jsrc(is) IF (((IstrR.le.ii).and.(ii.le.IendR)).and. & & ((JstrR.le.jj).and.(jj.le.JendR)).and. & & (j.eq.jj)) THEN DO k=1,N(ng) W(ii,jj,k)=W(ii,jj,k)+SOURCES(ng)%Qsrc(is,k) END DO END IF END DO END IF ! DO i=Istr,Iend wrk(i)=W(i,j,N(ng))/(z_w(i,j,N(ng))-z_w(i,j,0)) END DO ! ! In order to insure zero vertical velocity at the free-surface, ! subtract the vertical velocities of the moving S-coordinates ! isosurfaces. These isosurfaces are proportional to d(zeta)/d(t). ! The proportionally coefficients are a linear function of the ! S-coordinate with zero value at the bottom (k=0) and unity at ! the free-surface (k=N). ! DO k=N(ng)-1,1,-1 DO i=Istr,Iend W(i,j,k)=W(i,j,k)- & # if defined WEC_VF & W_stokes(i,j,k)- & # endif & wrk(i)*(z_w(i,j,k)-z_w(i,j,0)) END DO END DO DO i=Istr,Iend W(i,j,N(ng))=0.0_r8 END DO END DO ! ! Set lateral boundary conditions. ! CALL bc_w3d_tile (ng, tile, & & LBi, UBi, LBj, UBj, 0, N(ng), & & W) # ifdef DISTRIBUTE CALL mp_exchange3d (ng, tile, model, 1, & & LBi, UBi, LBj, UBj, 0, N(ng), & & NghostPoints, & & EWperiodic(ng), NSperiodic(ng), & & W) # endif RETURN END SUBROUTINE omega_tile ! !*********************************************************************** SUBROUTINE scale_omega (ng, tile, LBi, UBi, LBj, UBj, LBk, UBk, & & pm, pn, W, Wscl) !*********************************************************************** ! USE mod_param USE mod_ncparam USE mod_scalars ! USE exchange_3d_mod, ONLY : exchange_w3d_tile # ifdef DISTRIBUTE USE mp_exchange_mod, ONLY : mp_exchange3d # endif ! ! Imported variable declarations. ! integer, intent(in) :: ng, tile integer, intent(in) :: LBi, UBi, LBj, UBj, LBk, UBk ! # ifdef ASSUMED_SHAPE real(r8), intent(in) :: pm(LBi:,LBj:) real(r8), intent(in) :: pn(LBi:,LBj:) real(r8), intent(in) :: W(LBi:,LBj:,LBk:) real(r8), intent(out) :: Wscl(LBi:,LBj:,LBk:) # else real(r8), intent(in) :: pm(LBi:UBi,LBj:UBj) real(r8), intent(in) :: pn(LBi:UBi,LBj:UBj) real(r8), intent(in) :: W(LBi:UBi,LBj:UBj,LBk:UBk) real(r8), intent(out) :: Wscl(LBi:UBi,LBj:UBj,LBk:UBk) # endif ! ! Local variable declarations. ! integer :: i, j, k # include "set_bounds.h" ! !----------------------------------------------------------------------- ! Scale omega vertical velocity to m/s. !----------------------------------------------------------------------- ! DO k=LBk,UBk DO j=JstrR,JendR DO i=IstrR,IendR Wscl(i,j,k)=W(i,j,k)*pm(i,j)*pn(i,j) END DO END DO END DO ! ! Exchange boundary data. ! IF (EWperiodic(ng).or.NSperiodic(ng)) THEN CALL exchange_w3d_tile (ng, tile, & & LBi, UBi, LBj, UBj, LBk, UBk, & & Wscl) END IF # ifdef DISTRIBUTE CALL mp_exchange3d (ng, tile, iNLM, 1, & & LBi, UBi, LBj, UBj, 0, N(ng), & & NghostPoints, & & EWperiodic(ng), NSperiodic(ng), & & Wscl) # endif RETURN END SUBROUTINE scale_omega #endif END MODULE omega_mod