bvf_mix.F

Go to the documentation of this file.

#include "cppdefs.h"
      MODULE bvf_mix_mod
#if defined NONLINEAR && defined BVF_MIXING
!
!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 computes tracer vertical mixing as a function of the   !
!  Brunt-Vaisala frequency.  The vertical mixing of momentum  is set   !
!  to its background value.  If static unstable regime, the vertical   !
!  mixing is set to "bvf_nu0c".                                        !
!                                                                      !
!======================================================================!
!
      implicit none
!
      PRIVATE
      PUBLIC  :: bvf_mix
!
      CONTAINS
!
!***********************************************************************
      SUBROUTINE bvf_mix (ng, tile)
!***********************************************************************
!
      USE mod_param
      USE mod_mixing
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, tile
!
!  Local variable declarations.
!
# include "tile.h"
!
      CALL bvf_mix_tile (ng, tile,                                      &
     &                   lbi, ubi, lbj, ubj,                            &
     &                   imins, imaxs, jmins, jmaxs,                    &
     &                   mixing(ng) % bvf,                              &
     &                   mixing(ng) % AKt,                              &
     &                   mixing(ng) % AKv)
      RETURN
      END SUBROUTINE bvf_mix
!
!***********************************************************************
      SUBROUTINE bvf_mix_tile (ng, tile,                                &
     &                         LBi, UBi, LBj, UBj,                      &
     &                         IminS, ImaxS, JminS, JmaxS,              &
     &                         bvf, Akt, Akv)
!***********************************************************************
!
      USE mod_param
      USE mod_scalars
!
      USE exchange_3d_mod, ONLY : exchange_w3d_tile
# ifdef DISTRIBUTE
      USE mp_exchange_mod, ONLY : mp_exchange3d, mp_exchange4d
# endif
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, tile
      integer, intent(in) :: LBi, UBi, LBj, UBj
      integer, intent(in) :: IminS, ImaxS, JminS, JmaxS
!
# ifdef ASSUMED_SHAPE
      real(r8), intent(in) :: bvf(LBi:,LBj:,0:)
      real(r8), intent(out) :: Akt(LBi:,LBj:,0:,:)
      real(r8), intent(out) :: Akv(LBi:,LBj:,0:)
# else
      real(r8), intent(in) :: bvf(LBi:UBi,LBj:UBj,0:N(ng))
      real(r8), intent(out) :: Akt(LBi:UBi,LBj:UBj,0:N(ng),NAT)
      real(r8), intent(out) :: Akv(LBi:UBi,LBj:UBj,0:N(ng))
# endif
!
!  Local variable declarations.
!
      integer :: i, itrc, j, k
 
      real(r8) :: cff
 
# include "set_bounds.h"
!
!-----------------------------------------------------------------------
!  Set tracer diffusivity as function of the Brunt-vaisala frequency.
!  Set vertical viscosity to its background value.
!-----------------------------------------------------------------------
!
      DO k=1,n(ng)-1
        DO j=jstr,jend
          DO i=istr,iend
            akv(i,j,k)=akv_bak(ng)
            IF (bvf(i,j,k).lt.0.0_r8) THEN
              akv(i,j,k)=bvf_nu0c
              akt(i,j,k,itemp)=bvf_nu0c
# ifdef SALINITY
              akt(i,j,k,isalt)=bvf_nu0c
# endif
            ELSE IF (bvf(i,j,k).eq.0.0_r8) THEN
              akv(i,j,k)=akv_bak(ng)
              akt(i,j,k,itemp)=akt_bak(itemp,ng)
# ifdef SALINITY
              akt(i,j,k,isalt)=akt_bak(isalt,ng)
# endif
            ELSE
              cff=bvf_nu0/sqrt(bvf(i,j,k))
              akt(i,j,k,itemp)=min(bvf_numax,max(bvf_numin,cff))
              akv(i,j,k)=akt(i,j,k,itemp)
# ifdef SALINITY
              akt(i,j,k,isalt)=akt(i,j,k,itemp)
# endif
            END IF
          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, 0, n(ng),           &
     &                          akv)
        DO itrc=1,nat
          CALL exchange_w3d_tile (ng, tile,                             &
     &                            lbi, ubi, lbj, ubj, 0, n(ng),         &
     &                            akt(:,:,:,itrc))
        END DO
      END IF
 
# ifdef DISTRIBUTE
      CALL mp_exchange3d (ng, tile, inlm, 1,                            &
     &                    lbi, ubi, lbj, ubj, 0, n(ng),                 &
     &                    nghostpoints,                                 &
     &                    ewperiodic(ng), nsperiodic(ng),               &
     &                    akv)
      CALL mp_exchange4d (ng, tile, inlm, 1,                            &
     &                    lbi, ubi, lbj, ubj, 0, n(ng), 1, nat,         &
     &                    nghostpoints,                                 &
     &                    ewperiodic(ng), nsperiodic(ng),               &
     &                    akt)
# endif
 
      RETURN
      END SUBROUTINE bvf_mix_tile
#endif
      END MODULE bvf_mix_mod