tl_uv3drelax_mod Module Reference

Functions/Subroutines
subroutine, public	tl_uv3drelax (ng, tile)
subroutine	tl_uv3drelax_tile (ng, tile, lbi, ubi, lbj, ubj, imins, imaxs, jmins, jmaxs, nrhs, nnew, pmask, hz, pm, pmon_p, pmon_r, pn, pnom_p, pnom_r, tl_u, tl_v)

Function/Subroutine Documentation

tl_uv3drelax()

subroutine, public tl_uv3drelax_mod::tl_uv3drelax	(	integer, intent(in)	ng,
		integer, intent(in)	tile )

Definition at line 31 of file tl_uv3drelax.F.

!***********************************************************************
!
      USE mod_param
      USE mod_coupling
      USE mod_grid
      USE mod_ocean
      USE mod_stepping
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, tile
!
!  Local variable declarations.
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__
!
# include "tile.h"
!
# ifdef PROFILE
      CALL wclock_on (ng, itlm, 30, __line__, myfile)
# endif
      CALL tl_uv3drelax_tile (ng, tile,                                 &
     &                        lbi, ubi, lbj, ubj,                       &
     &                        imins, imaxs, jmins, jmaxs,               &
     &                        nrhs(ng), nnew(ng),                       &
# ifdef MASKING
     &                        grid(ng) % pmask,                         &
# endif
     &                        grid(ng) % Hz,                            &
     &                        grid(ng) % pm,                            &
     &                        grid(ng) % pmon_p,                        &
     &                        grid(ng) % pmon_r,                        &
     &                        grid(ng) % pn,                            &
     &                        grid(ng) % pnom_p,                        &
     &                        grid(ng) % pnom_r,                        &
     &                        ocean(ng) % tl_u,                         &
     &                        ocean(ng) % tl_v)
# ifdef PROFILE
      CALL wclock_off (ng, itlm, 30, __line__, myfile)
# endif
!
      RETURN

References mod_grid::grid, mod_param::itlm, mod_stepping::nnew, mod_stepping::nrhs, mod_ocean::ocean, tl_uv3drelax_tile(), wclock_off(), and wclock_on().

Referenced by tl_rhs3d_mod::tl_rhs3d().

Here is the call graph for this function:

Here is the caller graph for this function:

tl_uv3drelax_tile()

subroutine tl_uv3drelax_mod::tl_uv3drelax_tile ( integer, intent(in) ng, integer, intent(in) tile, integer, intent(in) lbi, integer, intent(in) ubi, integer, intent(in) lbj, integer, intent(in) ubj, integer, intent(in) imins, integer, intent(in) imaxs, integer, intent(in) jmins, integer, intent(in) jmaxs, integer, intent(in) nrhs, integer, intent(in) nnew, real(r8), dimension(lbi:,lbj:), intent(in) pmask, real(r8), dimension(lbi:,lbj:,:), intent(in) hz, real(r8), dimension(lbi:,lbj:), intent(in) pm, real(r8), dimension(lbi:,lbj:), intent(in) pmon_p, real(r8), dimension(lbi:,lbj:), intent(in) pmon_r, real(r8), dimension(lbi:,lbj:), intent(in) pn, real(r8), dimension(lbi:,lbj:), intent(in) pnom_p, real(r8), dimension(lbi:,lbj:), intent(in) pnom_r, real(r8), dimension(lbi:,lbj:,:,:), intent(inout) tl_u, real(r8), dimension(lbi:,lbj:,:,:), intent(inout) tl_v )

private

Definition at line 79 of file tl_uv3drelax.F.

!***********************************************************************
!
      USE mod_param
      USE mod_scalars
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, tile
      integer, intent(in) :: LBi, UBi, LBj, UBj
      integer, intent(in) :: IminS, ImaxS, JminS, JmaxS
      integer, intent(in) :: nrhs, nnew
 
# ifdef ASSUMED_SHAPE
#  ifdef MASKING
      real(r8), intent(in) :: pmask(LBi:,LBj:)
#  endif
      real(r8), intent(in) :: Hz(LBi:,LBj:,:)
      real(r8), intent(in) :: pm(LBi:,LBj:)
      real(r8), intent(in) :: pmon_p(LBi:,LBj:)
      real(r8), intent(in) :: pmon_r(LBi:,LBj:)
      real(r8), intent(in) :: pn(LBi:,LBj:)
      real(r8), intent(in) :: pnom_p(LBi:,LBj:)
      real(r8), intent(in) :: pnom_r(LBi:,LBj:)
 
      real(r8), intent(inout) :: tl_u(LBi:,LBj:,:,:)
      real(r8), intent(inout) :: tl_v(LBi:,LBj:,:,:)
# else
#  ifdef MASKING
      real(r8), intent(in) :: pmask(LBi:UBi,LBj:UBj)
#  endif
      real(r8), intent(in) :: Hz(LBi:UBi,LBj:UBj,N(ng))
      real(r8), intent(in) :: pm(LBi:UBi,LBj:UBj)
      real(r8), intent(in) :: pmon_p(LBi:UBi,LBj:UBj)
      real(r8), intent(in) :: pmon_r(LBi:UBi,LBj:UBj)
      real(r8), intent(in) :: pn(LBi:UBi,LBj:UBj)
      real(r8), intent(in) :: pnom_p(LBi:UBi,LBj:UBj)
      real(r8), intent(in) :: pnom_r(LBi:UBi,LBj:UBj)
 
      real(r8), intent(inout) :: tl_u(LBi:UBi,LBj:UBj,N(ng),2)
      real(r8), intent(inout) :: tl_v(LBi:UBi,LBj:UBj,N(ng),2)
# endif
!
!  Local variable declarations.
!
      integer :: i, j, k
 
      real(r8) :: cff
 
      real(r8), dimension(IminS:ImaxS,JminS:JmaxS) :: UFe
      real(r8), dimension(IminS:ImaxS,JminS:JmaxS) :: UFx
      real(r8), dimension(IminS:ImaxS,JminS:JmaxS) :: VFe
      real(r8), dimension(IminS:ImaxS,JminS:JmaxS) :: VFx
 
# include "set_bounds.h"
!
!-----------------------------------------------------------------------
!  Compute horizontal diffusion relaxation of 3D momentum between
!  current and previous representer tangent linear Picard iteration
!  trajectory (basic state).
!-----------------------------------------------------------------------
!
!  This is the tangent linear of the relaxation terms that appear in
!  the representer model. Since the representer model is linear, we
!  DO NOT need to include the tangent linear of the Hz terms below
!  because Hz is computed from the background trajectory (AMM).
!
      IF (tl_m3diff(ng).gt.0.0_r8) THEN
!
        k_loop : DO k=1,n(ng)
!
!  Compute flux-components of the diffusive relaxation (m4/s2) in XI-
!  and ETA-directions.
!
          DO j=jstr,jend
            DO i=istru-1,iend
              ufx(i,j)=tl_m3diff(ng)*pmon_r(i,j)*                       &
     &                 hz(i,j,k)*                                       &
     &                 (tl_u(i+1,j,k,nrhs)-                             &
     &                  tl_u(i  ,j,k,nrhs))
            END DO
          END DO
          DO j=jstr,jend+1
            DO i=istru,iend
              ufe(i,j)=tl_m3diff(ng)*pnom_p(i,j)*                       &
     &                 0.25_r8*(hz(i,j  ,k)+hz(i-1,j  ,k)+              &
     &                          hz(i,j-1,k)+hz(i-1,j-1,k))*             &
     &                 (tl_u(i,j  ,k,nrhs)-                             &
     &                  tl_u(i,j-1,k,nrhs))
# ifdef MASKING
              ufe(i,j)=ufe(i,j)*pmask(i,j)
# endif
            END DO
          END DO
          DO j=jstrv,jend
            DO i=istr,iend+1
              vfx(i,j)=tl_m3diff(ng)*pmon_p(i,j)*                       &
     &                 0.25_r8*(hz(i,j  ,k)+hz(i-1,j  ,k)+              &
     &                          hz(i,j-1,k)+hz(i-1,j-1,k))*             &
     &                 (tl_v(i  ,j,k,nrhs)-                             &
     &                  tl_v(i-1,j,k,nrhs))
# ifdef MASKING
              vfx(i,j)=vfx(i,j)*pmask(i,j)
# endif
            END DO
          END DO
          DO j=jstrv-1,jend
            DO i=istr,iend
              vfe(i,j)=tl_m3diff(ng)*pnom_r(i,j)*                       &
     &                 hz(i,j,k)*                                       &
     &                 (tl_v(i,j+1,k,nrhs)-                             &
     &                  tl_v(i,j  ,k,nrhs))
            END DO
          END DO
!
! Time-step diffusive relaxation term.  Notice that momentum at this
! stage is HzU and HzV and has m2/s units.
!
          cff=dt(ng)*0.25_r8
          DO j=jstr,jend
            DO i=istru,iend
              tl_u(i,j,k,nnew)=tl_u(i,j,k,nnew)+                        &
     &                         cff*(pm(i-1,j)+pm(i,j))*                 &
     &                             (pn(i-1,j)+pn(i,j))*                 &
     &                         (ufx(i,j)-ufx(i-1,j)+                    &
     &                          ufe(i,j+1)-ufe(i,j))
 
            END DO
          END DO
          DO j=jstrv,jend
            DO i=istr,iend
              tl_v(i,j,k,nnew)=tl_v(i,j,k,nnew)+                        &
     &                         cff*(pm(i,j)+pm(i,j-1))*                 &
     &                             (pn(i,j)+pn(i,j-1))*                 &
     &                         (vfx(i+1,j)-vfx(i,j)+                    &
     &                          vfe(i,j)-vfe(i,j-1))
            END DO
          END DO
        END DO k_loop
      END IF
!
      RETURN

References mod_scalars::dt, and mod_scalars::tl_m3diff.

Referenced by tl_uv3drelax().

Here is the caller graph for this function: