ana_m3obc.h

Go to the documentation of this file.

!!
      SUBROUTINE ana_m3obc (ng, tile, model)
!
!! git $Id$
!!======================================================================
!! Copyright (c) 2002-2025 The ROMS Group                              !
!!   Licensed under a MIT/X style license                              !
!!   See License_ROMS.md                                               !
!=======================================================================
!                                                                      !
!  This routine sets 3D momentum open boundary conditions using        !
!  analytical expressions.                                             !
!                                                                      !
!=======================================================================
!
      USE mod_param
      USE mod_boundary
      USE mod_ncparam
!
! Imported variable declarations.
!
      integer, intent(in) :: ng, tile, model
!
! Local variable declarations.
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__
!
#include "tile.h"
!
      CALL ana_m3obc_tile (ng, tile, model,                             &
     &                     lbi, ubi, lbj, ubj,                          &
     &                     imins, imaxs, jmins, jmaxs)
!
! Set analytical header file name used.
!
#ifdef DISTRIBUTE
      IF (lanafile) THEN
#else
      IF (lanafile.and.(tile.eq.0)) THEN
#endif
        ananame(14)=myfile
      END IF
!
      RETURN
      END SUBROUTINE ana_m3obc
!
!***********************************************************************
      SUBROUTINE ana_m3obc_tile (ng, tile, model,                       &
     &                           LBi, UBi, LBj, UBj,                    &
     &                           IminS, ImaxS, JminS, JmaxS)
!***********************************************************************
!
      USE mod_param
      USE mod_boundary
      USE mod_grid
      USE mod_ncparam
      USE mod_ocean
      USE mod_scalars
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, tile, model
      integer, intent(in) :: LBi, UBi, LBj, UBj
      integer, intent(in) :: IminS, ImaxS, JminS, JmaxS
!
!  Local variable declarations.
!
      integer :: i, j, k
!
      real(r8) :: fac, val
 
#include "set_bounds.h"
!
!-----------------------------------------------------------------------
!  3D momentum open boundary conditions.
!-----------------------------------------------------------------------
!
#if defined SED_TEST1
      IF (lbc(iwest,isuvel,ng)%acquire.and.                             &
     &    lbc(iwest,isvvel,ng)%acquire.and.                             &
     &    domain(ng)%Western_Edge(tile)) THEN
        fac=5.0e-06_r8
        DO k=1,n(ng)
          DO j=jstrt,jendt
            val=0.5_r8*(ocean(ng)%zeta(0 ,j,knew)+                      &
     &                  grid(ng)%h(0 ,j)+                               &
     &                  ocean(ng)%zeta(1 ,j,knew)+                      &
     &                  grid(ng)%h(1 ,j))
            boundary(ng)%u_west(j,k)=-log((val+0.5*
     %                                     (grid(ng)%z_r(istr-1,j,k)+   &
     &                                      grid(ng)%z_r(istr  ,j,k)))/ &
     &                                    fac)/                         &
     &                               (log(val/fac)-1.0_r8+fac/val)
          END DO
          DO j=jstrp,jendt
            boundary(ng)%v_west(j,k)=0.0_r8
          END DO
        END DO
      END IF
 
      IF (lbc(ieast,isuvel,ng)%acquire.and.                             &
     &    lbc(ieast,isvvel,ng)%acquire.and.                             &
     &    domain(ng)%Eastern_Edge(tile)) THEN
        fac=5.0e-06_r8
        DO k=1,n(ng)
          DO j=jstrt,jendt
            val=0.5_r8*(ocean(ng)%zeta(iend  ,j,knew)+                  &
     &                  grid(ng)%h(iend  ,j)+                           &
     &                  ocean(ng)%zeta(iend+1,j,knew)+                  &
     %                  GRID(ng)%h(iend+1,j))
            boundary(ng)%u_east(j,k)=-log((val+0.5*
     &                                     (grid(ng)%z_r(iend  ,j,k)+   &
     &                                      grid(ng)%z_r(iend+1,j,k)))/ &
     &                                    fac)/                         &
     &                               (log(val/fac)-1.0_r8+fac/val)
          END DO
          DO j=jstrp,jendt
            boundary(ng)%v_east(j,k)=0.0_r8
          END DO
        END DO
      END IF
#else
      IF (lbc(ieast,isuvel,ng)%acquire.and.                             &
     &    lbc(ieast,isvvel,ng)%acquire.and.                             &
     &    domain(ng)%Eastern_Edge(tile)) THEN
        DO k=1,n(ng)
          DO j=jstrt,jendt
            boundary(ng)%u_east(j,k)=0.0_r8
          END DO
          DO j=jstrp,jendt
            boundary(ng)%v_east(j,k)=0.0_r8
          END DO
        END DO
      END IF
 
      IF (lbc(iwest,isuvel,ng)%acquire.and.                             &
     &    lbc(iwest,isvvel,ng)%acquire.and.                             &
     &    domain(ng)%Western_Edge(tile)) THEN
        DO k=1,n(ng)
          DO j=jstrt,jendt
            boundary(ng)%u_west(j,k)=0.0_r8
          END DO
          DO j=jstrp,jendt
            boundary(ng)%v_west(j,k)=0.0_r8
          END DO
        END DO
      END IF
 
      IF (lbc(isouth,isuvel,ng)%acquire.and.                            &
     &    lbc(isouth,isvvel,ng)%acquire.and.                            &
     &    domain(ng)%Southern_Edge(tile)) THEN
        DO k=1,n(ng)
          DO i=istrp,iendt
            boundary(ng)%u_south(i,k)=0.0_r8
          END DO
          DO i=istrt,iendt
            boundary(ng)%v_south(i,k)=0.0_r8
          END DO
        END DO
      END IF
 
      IF (lbc(inorth,isuvel,ng)%acquire.and.                            &
     &    lbc(inorth,isvvel,ng)%acquire.and.                            &
     &    domain(ng)%Northern_Edge(tile)) THEN
        DO k=1,n(ng)
          DO i=istrp,iendt
            boundary(ng)%u_north(i,k)=0.0_r8
          END DO
          DO i=istrt,iendt
            boundary(ng)%v_north(i,k)=0.0_r8
          END DO
        END DO
      END IF
#endif
!
      RETURN
      END SUBROUTINE ana_m3obc_tile