maskab.f

Go to the documentation of this file.

!                   *****************
                    SUBROUTINE maskab
!                   *****************
!
     &(hn , q , qu , qv , npoin)
!
!***********************************************************************
! SISYPHE   V6P1                                   21/07/2011
!***********************************************************************
!
!brief    ELIMINATES NEGATIVE WATER DEPTHS.
!
!history  E. PELTIER; C. LENORMANT; J.-M. HERVOUET
!+        11/09/95
!+        V5P1
!+
!
!history  N.DURAND (HRW), S.E.BOURBAN (HRW)
!+        13/07/2010
!+        V6P0
!+   Translation of French comments within the FORTRAN sources into
!+   English comments
!
!history  N.DURAND (HRW), S.E.BOURBAN (HRW)
!+        21/08/2010
!+        V6P0
!+   Creation of DOXYGEN tags for automated documentation and
!+   cross-referencing of the FORTRAN sources
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!| HN             |<->| WATER DEPTH
!| NPOIN          |-->| NUMBER OF POINTS
!| Q              |-->| LIQUID DISCHARGE
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      IMPLICIT NONE
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      INTEGER, INTENT(IN):: NPOIN
!
      DOUBLE PRECISION, INTENT(IN)    :: HN(npoin)
      DOUBLE PRECISION, INTENT(INOUT) :: Q(npoin),QU(npoin),QV(npoin)
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      INTEGER I
!
!-----------------------------------------------------------------------
!
!
! CAPS WATER DEPTHS
!
      DO i=1,npoin
!
!  TREATS NEGATIVE VALUES IN THE DOMAIN
!
        IF(hn(i).LE.0.d0) THEN
          q(i)  = 0.d0
          qu(i) = 0.d0
          qv(i) = 0.d0
        ENDIF
      ENDDO

      CALL user_maskab (hn , q , qu , qv , npoin)
!
!-----------------------------------------------------------------------
!
      RETURN
      END SUBROUTINE maskab