obs_depth.F

Go to the documentation of this file.

#include "cppdefs.h"
#if (defined FOUR_DVAR    || defined VERIFICATION) && \
     defined observations && \
     defined distribute   && defined solve3d
      SUBROUTINE obs_depth (ng, tile, model)
!
!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 proccess the observation vertical position, Zobs. If   !
!  the input position is in meters (Zobs < 0) instead of  fractional   !
!  level (Zobs > 0; 1 <= Zobs <= N),  zero out its Zobs value in all   !
!  nodes in group but itself to faciliate exchange between all tiles   !
!  with "mp_collect", after model extraction.                          !
!                                                                      !
!-----------------------------------------------------------------------
!
      USE mod_param
      USE mod_fourdvar
      USE mod_ncparam
      USE mod_scalars
!
      implicit none
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, tile, model
!
!  Local variable declarations.
!
      logical :: r_bound, u_bound, v_bound
 
      integer :: Mstr, Mend, iobs, itrc
 
      real(r8) :: IniVal = 0.0_r8
 
# include "set_bounds.h"
!
!-----------------------------------------------------------------------
!  If distributed-memory and Zobs < 0, zero-out Zobs values in all
!  nodes but itself to facilitate exchages between tiles latter.
!-----------------------------------------------------------------------
!
!  Set starting index of obervation vectors for reading.  In weak
!  constraint, the entire observation data is loaded. Otherwise,
!  only the observation for the current time window are loaded
!  and started from vector index one.
!
# ifdef WEAK_CONSTRAINT
      mstr=nstrobs(ng)
      mend=nendobs(ng)
# else
      mstr=1
      mend=nobs(ng)
# endif
!
!  Set observations depth (Zobs) to zero if not bounded in the current
!  parallel tile to facilitate global reduction in "mp_collect".
!
      DO iobs=mstr,mend
        r_bound=((rxmin(ng) .le.xobs(iobs)).and.                        &
     &           (xobs(iobs).lt.rxmax(ng))).and.                        &
     &          ((rymin(ng) .le.yobs(iobs)).and.                        &
     &           (yobs(iobs).lt.rymax(ng)))
        u_bound=((uxmin(ng) .le.xobs(iobs)).and.                        &
     &           (xobs(iobs).lt.uxmax(ng))).and.                        &
     &          ((uymin(ng) .le.yobs(iobs)).and.                        &
     &           (yobs(iobs).lt.uymax(ng)))
        v_bound=((vxmin(ng) .le.xobs(iobs)).and.                        &
     &           (xobs(iobs).lt.vxmax(ng))).and.                        &
     &          ((vymin(ng) .le.yobs(iobs)).and.                        &
     &           (yobs(iobs).lt.vymax(ng)))
        IF (.not.(r_bound.or.u_bound.or.v_bound)) THEN
          zobs(iobs)=inival                              ! not bouded
        END IF
      END DO
!
      RETURN
      END SUBROUTINE obs_depth
#else
      SUBROUTINE obs_depth
      RETURN
      END SUBROUTINE obs_depth
#endif