masktf.f

Go to the documentation of this file.

!                   *****************
                    SUBROUTINE masktf
!                   *****************
!
     &(maskel,hn,hmin,ikle,nelem,npoin)
!
!***********************************************************************
! BIEF   V6P1                                   21/08/2010
!***********************************************************************
!
!brief    MASKS DRY ELEMENTS (MASKS TIDAL FLATS).
!code
!+    SIMPLE ALGORITHM: AN ELEMENT IS DRY IF ONE OF ITS DEPTHS IS
!+                      LESS THAN HMIN
!+
!+    USED BY SISYPHE (IN THIS CASE THE DEPTH IS GIVEN BY TELEMAC, SO
!+    A SOPHISTICATED ALGORITHM TO PRESERVE THE DYNAMICS OF FLOODING
!+    IS NOT NEEDED)
!
!history  J-M HERVOUET (LNHE)
!+        20/10/08
!+        V5P9
!+
!
!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
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!| HMIN           |-->| MINIMUM VALUE OF DEPTH
!| HN             |-->| WATER DEPTH AT TIME N
!| IKLE           |-->| CONNECTIVITY TABLE.
!| MASKEL         |<--| MASKING OF ELEMENTS
!|                |   | =1. : NORMAL   =0. : MASKED ELEMENT
!| NELEM          |-->| NUMBER OF ELEMENTS
!| NPOIN          |-->| NUMBER OF POINTS
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      IMPLICIT NONE
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      INTEGER, INTENT(IN)             :: NELEM,NPOIN
      INTEGER, INTENT(IN)             :: IKLE(nelem,3)
      DOUBLE PRECISION, INTENT(IN)    :: HN(npoin)
      DOUBLE PRECISION, INTENT(IN)    :: HMIN
      DOUBLE PRECISION, INTENT(INOUT) :: MASKEL(nelem)
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      INTEGER IELEM,I1,I2,I3
!
!-----------------------------------------------------------------------
!
      DO ielem = 1,nelem
        i1 = ikle(ielem,1)
        i2 = ikle(ielem,2)
        i3 = ikle(ielem,3)
        IF(hn(i1).LE.hmin.OR.hn(i2).LE.hmin.OR.hn(i3).LE.hmin) THEN
          maskel(ielem) = 0.d0
        ENDIF
      ENDDO
!
!-----------------------------------------------------------------------
!
      RETURN
      END