mod_bbl.F

Go to the documentation of this file.

#include "cppdefs.h"
      MODULE mod_bbl
#ifdef BBL_MODEL
!
!git $Id$
!================================================== Hernan G. Arango ===
!  Copyright (c) 2002-2025 The ROMS Group                              !
!    Licensed under a MIT/X style license                              !
!    See License_ROMS.md                                               !
!=======================================================================
!                                                                      !
!  Ubot         Wind-induced, bed wave orbital U-velocity (m/s) at     !
!                 RHO-points.                                          !
!  Ur           Bottom U-momentum above bed (m/s) at RHO-points.       !
!  Vbot         Wind-induced, bed wave orbital V-velocity (m/s) at     !
!                 RHO-points.                                          !
!  Vr           Bottom V-momentum above bed (m/s) at RHO-points.       !
!  bustrc       Kinematic bottom stress (m2/s2) due currents in the    !
!                 XI-direction at RHO-points.                          !
!  bustrw       Kinematic bottom stress (m2/s2) due to wind-induced    !
!                 waves the XI-direction at horizontal RHO-points.     !
!  bustrcwmax   Kinematic bottom stress (m2/s2) due to maximum wind    !
!                 and currents in the XI-direction at RHO-points.      !
!  bvstrc       Kinematic bottom stress (m2/s2) due currents in the    !
!                 ETA-direction at RHO-points.                         !
!  bvstrw       Kinematic bottom stress (m2/s2) due to wind-induced    !
!                 waves the ETA-direction at horizontal RHO-points.    !
!  bvstrcwmax   Kinematic bottom stress (m2/s2) due to maximum wind    !
!                 and currents in the ETA-direction RHO-points.        !
!                                                                      !
!=======================================================================
!
        USE mod_kinds
!
        implicit none
!
        PUBLIC :: allocate_bbl
        PUBLIC :: deallocate_bbl
        PUBLIC :: initialize_bbl
!
!-----------------------------------------------------------------------
!  Define T_BBL structure.
!-----------------------------------------------------------------------
!
        TYPE t_bbl
 
          integer,  pointer :: iconv(:,:)
 
          real(r8), pointer :: ubot(:,:)
          real(r8), pointer :: ur(:,:)
          real(r8), pointer :: vbot(:,:)
          real(r8), pointer :: vr(:,:)
          real(r8), pointer :: bustrc(:,:)
          real(r8), pointer :: bvstrc(:,:)
          real(r8), pointer :: bustrw(:,:)
          real(r8), pointer :: bvstrw(:,:)
          real(r8), pointer :: bustrcwmax(:,:)
          real(r8), pointer :: bvstrcwmax(:,:)
 
        END TYPE t_bbl
!
        TYPE (t_bbl), allocatable :: bbl(:)
!
      CONTAINS
!
      SUBROUTINE allocate_bbl (ng, LBi, UBi, LBj, UBj)
!
!=======================================================================
!                                                                      !
!  This routine allocates all variables in the module for all nested   !
!  grids.                                                              !
!                                                                      !
!=======================================================================
!
      USE mod_param
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, lbi, ubi, lbj, ubj
!
!  Local variable declarations.
!
      real(r8) :: size2d
!
!-----------------------------------------------------------------------
!  Allocate module variables.
!-----------------------------------------------------------------------
!
      IF (ng.eq.1) allocate ( bbl(ngrids) )
!
!  Set horizontal array size.
!
      size2d=real((ubi-lbi+1)*(ubj-lbj+1),r8)
!
!  Bottom boundary layer arrays.
!
      allocate ( bbl(ng) % Iconv(lbi:ubi,lbj:ubj) )
      dmem(ng)=dmem(ng)+size2d
 
      allocate ( bbl(ng) % Ubot(lbi:ubi,lbj:ubj) )
      dmem(ng)=dmem(ng)+size2d
 
      allocate ( bbl(ng) % Ur(lbi:ubi,lbj:ubj) )
      dmem(ng)=dmem(ng)+size2d
 
      allocate ( bbl(ng) % Vbot(lbi:ubi,lbj:ubj) )
      dmem(ng)=dmem(ng)+size2d
 
      allocate ( bbl(ng) % Vr(lbi:ubi,lbj:ubj) )
      dmem(ng)=dmem(ng)+size2d
 
      allocate ( bbl(ng) % bustrc(lbi:ubi,lbj:ubj) )
      dmem(ng)=dmem(ng)+size2d
 
      allocate ( bbl(ng) % bvstrc(lbi:ubi,lbj:ubj) )
      dmem(ng)=dmem(ng)+size2d
 
      allocate ( bbl(ng) % bustrw(lbi:ubi,lbj:ubj) )
      dmem(ng)=dmem(ng)+size2d
 
      allocate ( bbl(ng) % bvstrw(lbi:ubi,lbj:ubj) )
      dmem(ng)=dmem(ng)+size2d
 
      allocate ( bbl(ng) % bustrcwmax(lbi:ubi,lbj:ubj) )
      dmem(ng)=dmem(ng)+size2d
 
      allocate ( bbl(ng) % bvstrcwmax(lbi:ubi,lbj:ubj) )
      dmem(ng)=dmem(ng)+size2d
 
      RETURN
      END SUBROUTINE allocate_bbl
!
      SUBROUTINE deallocate_bbl (ng)
!
!=======================================================================
!                                                                      !
!  This routine deallocates all variables in the module for all nested !
!  grids.                                                              !
!                                                                      !
!=======================================================================
!
      USE mod_param,   ONLY : ngrids
# ifdef SUBOBJECT_DEALLOCATION
      USE destroy_mod, ONLY : destroy
# endif
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng
!
!  Local variable declarations.
!
      character (len=*), parameter :: myfile =                          &
     &  __FILE__//", deallocate_bbl"
 
# ifdef SUBOBJECT_DEALLOCATION
!
!-----------------------------------------------------------------------
!  Deallocate each variable in the derived-type T_BBL structure
!  separately.
!-----------------------------------------------------------------------
!
      IF (.not.destroy(ng, bbl(ng)%Iconv, myfile,                       &
     &                 __line__, 'BBL(ng)%Iconv')) RETURN
 
      IF (.not.destroy(ng, bbl(ng)%Ubot, myfile,                        &
     &                 __line__, 'BBL(ng)%Ubot')) RETURN
 
      IF (.not.destroy(ng, bbl(ng)%Ur, myfile,                          &
     &                 __line__, 'BBL(ng)%Ur')) RETURN
 
      IF (.not.destroy(ng, bbl(ng)%Vbot, myfile,                        &
     &                 __line__, 'BBL(ng)%Vbot')) RETURN
 
      IF (.not.destroy(ng, bbl(ng)%Vr, myfile,                          &
     &                 __line__, 'BBL(ng)%Vr')) RETURN
 
      IF (.not.destroy(ng, bbl(ng)%bustrc, myfile,                      &
     &                 __line__, 'BBL(ng)%bustrc')) RETURN
 
      IF (.not.destroy(ng, bbl(ng)%bvstrc, myfile,                      &
     &                 __line__, 'BBL(ng)%bvstrc')) RETURN
 
      IF (.not.destroy(ng, bbl(ng)%bustrw, myfile,                      &
     &                 __line__, 'BBL(ng)%bustrw')) RETURN
 
      IF (.not.destroy(ng, bbl(ng)%bvstrw, myfile,                      &
     &                 __line__, 'BBL(ng)%bvstrw')) RETURN
 
      IF (.not.destroy(ng, bbl(ng)%bustrcwmax, myfile,                  &
     &                 __line__, 'BBL(ng)%bustrcwmax')) RETURN
 
      IF (.not.destroy(ng, bbl(ng)%bvstrcwmax, myfile,                  &
     &                 __line__, 'BBL(ng)%bvstrcwmax')) RETURN
# endif
!
!-----------------------------------------------------------------------
!  Deallocate derived-type BBL structure.
!-----------------------------------------------------------------------
!
      IF (ng.eq.ngrids) THEN
        IF (allocated(bbl)) deallocate ( bbl )
      END IF
!
      RETURN
      END SUBROUTINE deallocate_bbl
!
      SUBROUTINE initialize_bbl (ng, tile)
!
!=======================================================================
!                                                                      !
!  This routine initialize all variables in the module using first     !
!  touch distribution policy. In shared-memory configuration, this     !
!  operation actually performs propagation of the  "shared arrays"     !
!  across the cluster, unless another policy is specified to           !
!  override the default.                                               !
!                                                                      !
!=======================================================================
!
      USE mod_param
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, tile
!
!  Local variable declarations.
!
      integer :: imin, imax, jmin, jmax
      integer :: i, j
 
      real(r8), parameter :: inival = 0.0_r8
 
# include "set_bounds.h"
!
!  Set array initialization range.
 
# ifdef DISTRIBUTE
      imin=bounds(ng)%LBi(tile)
      imax=bounds(ng)%UBi(tile)
      jmin=bounds(ng)%LBj(tile)
      jmax=bounds(ng)%UBj(tile)
# else
      IF (domain(ng)%Western_Edge(tile)) THEN
        imin=bounds(ng)%LBi(tile)
      ELSE
        imin=istr
      END IF
      IF (domain(ng)%Eastern_Edge(tile)) THEN
        imax=bounds(ng)%UBi(tile)
      ELSE
        imax=iend
      END IF
      IF (domain(ng)%Southern_Edge(tile)) THEN
        jmin=bounds(ng)%LBj(tile)
      ELSE
        jmin=jstr
      END IF
      IF (domain(ng)%Northern_Edge(tile)) THEN
        jmax=bounds(ng)%UBj(tile)
      ELSE
        jmax=jend
      END IF
# endif
!
!-----------------------------------------------------------------------
!  Initialize module variables.
!-----------------------------------------------------------------------
!
      DO j=jmin,jmax
        DO i=imin,imax
          bbl(ng) % Iconv(i,j) = 0
 
          bbl(ng) % Ubot(i,j) = inival
          bbl(ng) % Ur(i,j) = inival
 
          bbl(ng) % Vbot(i,j) = inival
          bbl(ng) % Vr(i,j) = inival
 
          bbl(ng) % bustrc(i,j) = inival
          bbl(ng) % bvstrc(i,j) = inival
 
          bbl(ng) % bustrw(i,j) = inival
          bbl(ng) % bvstrw(i,j) = inival
 
          bbl(ng) % bustrcwmax(i,j) = inival
          bbl(ng) % bvstrcwmax(i,j) = inival
        END DO
      END DO
!
      RETURN
      END SUBROUTINE initialize_bbl
#endif
      END MODULE mod_bbl