tl_frc_adjust.F

Go to the documentation of this file.

#include "cppdefs.h"
      MODULE tl_frc_adjust_mod
 
#if defined ADJUST_STFLUX || defined ADJUST_WSTRESS
!
!git $Id$
!================================================== Hernan G. Arango ===
!  Copyright (c) 2002-2025 The ROMS Group                              !
!    Licensed under a MIT/X style license                              !
!    See License_ROMS.md                                               !
!=======================================================================
!                                                                      !
!  This routine time-interpolates 4DVar tangent linear model surface   !
!  forcing increments.  The increments can be constant (Nfrec=1)  or   !
!  time interpolated between snapshots (Nfrec>1).                      !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng        Nested grid number.                                    !
!     tile      Domain partition.                                      !
!     Linp      Tangent linear state time index to process.            !
!                                                                      !
!=======================================================================
!
      implicit none
 
      PRIVATE
      PUBLIC :: tl_frc_adjust
 
      CONTAINS
!
!***********************************************************************
      SUBROUTINE tl_frc_adjust (ng, tile, Linp)
!***********************************************************************
!
      USE mod_param
      USE mod_forces
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, tile, linp
!
!  Local variable declarations.
!
      character (len=*), parameter :: myfile =                          &
     &  __FILE__
!
# include "tile.h"
!
# ifdef PROFILE
      CALL wclock_on (ng, itlm, 7, __line__, myfile)
# endif
      CALL tl_frc_adjust_tile (ng, tile,                                &
     &                         lbi, ubi, lbj, ubj,                      &
     &                         imins, imaxs, jmins, jmaxs,              &
# ifdef ADJUST_WSTRESS
     &                         forces(ng) % tl_ustr,                    &
     &                         forces(ng) % tl_vstr,                    &
     &                         forces(ng) % tl_sustr,                   &
     &                         forces(ng) % tl_svstr,                   &
# endif
# if defined ADJUST_STFLUX && defined SOLVE3D
     &                         forces(ng) % tl_tflux,                   &
     &                         forces(ng) % tl_stflx,                   &
# endif
     &                         linp)
# ifdef PROFILE
      CALL wclock_off (ng, itlm, 7, __line__, myfile)
# endif
!
      RETURN
      END SUBROUTINE tl_frc_adjust
!
!***********************************************************************
      SUBROUTINE tl_frc_adjust_tile (ng, tile,                          &
     &                               LBi, UBi, LBj, UBj,                &
     &                               IminS, ImaxS, JminS, JmaxS,        &
# ifdef ADJUST_WSTRESS
     &                               tl_ustr,  tl_vstr,                 &
     &                               tl_sustr, tl_svstr,                &
# endif
# if defined ADJUST_STFLUX && defined SOLVE3D
     &                               tl_tflux, tl_stflx,                &
# endif
     &                               Linp)
!***********************************************************************
!
      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) :: Linp
!
# ifdef ASSUMED_SHAPE
#  ifdef ADJUST_WSTRESS
      real(r8), intent(in) :: tl_ustr(LBi:,LBj:,:,:)
      real(r8), intent(in) :: tl_vstr(LBi:,LBj:,:,:)
#  endif
#  if defined ADJUST_STFLUX && defined SOLVE3D
      real(r8), intent(inout) :: tl_tflux(LBi:,LBj:,:,:,:)
#  endif
#  ifdef ADJUST_WSTRESS
      real(r8), intent(inout) :: tl_sustr(LBi:,LBj:)
      real(r8), intent(inout) :: tl_svstr(LBi:,LBj:)
#  endif
#  if defined ADJUST_STFLUX && defined SOLVE3D
      real(r8), intent(inout) :: tl_stflx(LBi:,LBj:,:)
#  endif
# else
#  ifdef ADJUST_WSTRESS
      real(r8), intent(in) :: tl_ustr(LBi:UBi,LBj:UBj,Nfrec(ng),2)
      real(r8), intent(in) :: tl_vstr(LBi:UBi,LBj:UBj,Nfrec(ng),2)
#  endif
#  if defined ADJUST_STFLUX && defined SOLVE3D
      real(r8), intent(in) :: tl_tflux(LBi:UBi,LBj:UBj,                 &
     &                                 Nfrec(ng),2,NT(ng))
#  endif
#  ifdef ADJUST_WSTRESS
      real(r8), intent(inout) :: tl_sustr(LBi:UBi,LBj:UBj)
      real(r8), intent(inout) :: tl_svstr(LBi:UBi,LBj:UBj)
#  endif
#  if defined ADJUST_STFLUX && defined SOLVE3D
      real(r8), intent(inout) :: tl_stflx(LBi:UBi,LBj:UBj,NT(ng))
#  endif
# endif
!
!  Local variable declarations.
!
      integer :: i, it1, it2, j
# ifdef SOLVE3D
      integer :: itrc
# endif
      real(r8) :: fac, fac1, fac2
 
# include "set_bounds.h"
!
!-----------------------------------------------------------------------
!  Adjust tangent linear surface forcing fields with 4DVar increments.
!-----------------------------------------------------------------------
!
!  Set time records and interpolation factor, if any.
!
      IF (nfrec(ng).eq.1) THEN
        it1=1
        it2=1
        fac1=1.0_r8
        fac2=0.0_r8
      ELSE
# ifdef GENERIC_DSTART
        it1=max(0,(iic(ng)-ntstart(ng))/nsff(ng))+1
# else
        it1=max(0,(iic(ng)-1)/nsff(ng))+1
# endif
        it2=min(it1+1,nfrec(ng))
        fac1=sf_time(it2,ng)-(time(ng)+dt(ng))
        fac2=(time(ng)+dt(ng))-sf_time(it1,ng)
        fac=1.0_r8/(fac1+fac2)
        fac1=fac*fac1
        fac2=fac*fac2
      END IF
 
# ifdef ADJUST_WSTRESS
!
!  Adjust surface wind stress. Interpolate between surface forcing
!  increments, if appropriate.
!
      DO j=jstrr,jendr
        DO i=istr,iendr
          tl_sustr(i,j)=fac1*tl_ustr(i,j,it1,linp)+                     &
     &                  fac2*tl_ustr(i,j,it2,linp)
        END DO
      END DO
      DO j=jstr,jendr
        DO i=istrr,iendr
          tl_svstr(i,j)=fac1*tl_vstr(i,j,it1,linp)+                     &
     &                  fac2*tl_vstr(i,j,it2,linp)
        END DO
      END DO
# endif
# if defined ADJUST_STFLUX && defined SOLVE3D
!
!  Adjust surface tracer fluxes. Interpolate between surface forcing
!  increments, if appropriate.
!
      IF (lstflux(itemp,ng)) THEN
#  ifdef QCORRECTION
        DO j=jstrr,jendr
          DO i=istrr,iendr
            tl_stflx(i,j,itemp)=tl_stflx(i,j,itemp)+                    &
     &                          fac1*tl_tflux(i,j,it1,linp,itemp)+      &
     &                          fac2*tl_tflux(i,j,it2,linp,itemp)
          END DO
        END DO
#  else
        DO j=jstrr,jendr
          DO i=istrr,iendr
            tl_stflx(i,j,itemp)=fac1*tl_tflux(i,j,it1,linp,itemp)+      &
     &                          fac2*tl_tflux(i,j,it2,linp,itemp)
          END DO
        END DO
#  endif
      END IF
 
#  ifdef SALINITY
      IF (lstflux(isalt,ng)) THEN
        DO j=jstrr,jendr
          DO i=istrr,iendr
            tl_stflx(i,j,isalt)=tl_stflx(i,j,isalt)+                    &
     &                          fac1*tl_tflux(i,j,it1,linp,isalt)+      &
     &                          fac2*tl_tflux(i,j,it2,linp,isalt)
          END DO
        END DO
      END IF
#  endif
 
      DO itrc=nat+1,nt(ng)
        IF (lstflux(itrc,ng)) THEN
          DO j=jstrr,jendr
            DO i=istrr,iendr
              tl_stflx(i,j,itrc)=fac1*tl_tflux(i,j,it1,linp,itrc)+      &
     &                           fac2*tl_tflux(i,j,it2,linp,itrc)
            END DO
          END DO
        END IF
      END DO
# endif
!
      RETURN
      END SUBROUTINE tl_frc_adjust_tile
#endif
      END MODULE tl_frc_adjust_mod