clip.f

Go to the documentation of this file.

!                   ***************
                    SUBROUTINE clip
!                   ***************
!
     &(f,xmin,clpmin,xmax,clpmax,npoin)
!
!***********************************************************************
! BIEF   V6P1                                   21/08/2010
!***********************************************************************
!
!brief    CAPS THE VALUES IN ARRAY F.
!+
!+            MINIMUM OF F: XMIN (IF CLPMIN=.TRUE.).
!+
!+            MAXIMUM OF F: XMAX (IF CLPMAX=.TRUE.).
!
!note     IMPORTANT : IF NPOIN IS NEGATIVE, WILL TREAT -NPOIN VALUES.
!+
!+                 IF NPOIN IS POSITIVE, WILL TAKE THE SIZE OF F.
!
!history  J-M HERVOUET (LNH)    ; F  LEPEINTRE (LNH)
!+        12/01/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
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!| CLPMAX         |-->| LOGICAL, IF YES, CLIPPING OF MAXIMUM VALUE
!| CLPMIN         |-->| LOGICAL, IF YES, CLIPPING OF MINIMUM VALUE
!| F              |<->| ATTAY OF VALUES TO BE CHECKED
!| NPOIN          |-->| NUMBER OF POINTS IN THE DOMAIN
!| XMAX           |-->| MAXIMUM THRESHOLD VALUE
!| XMIN           |-->| MINIMUM THRESHOLD VALUE
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      USE bief, ex_clip => clip
!
      USE declarations_special
      IMPLICIT NONE
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      TYPE(bief_obj)  , INTENT(INOUT) :: F
      DOUBLE PRECISION, INTENT(IN)    :: XMIN,XMAX
      LOGICAL         , INTENT(IN)    :: CLPMIN,CLPMAX
      INTEGER         , INTENT(IN)    :: NPOIN
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      INTEGER NP
!
!-----------------------------------------------------------------------
!
      IF(f%TYPE.EQ.2) THEN
!       F IS A VECTOR STRUCTURE
        IF(npoin.LT.0) THEN
          np = - npoin
        ELSE
          np = f%DIM1
        ENDIF
        IF(clpmin) CALL ov('X=+(Y,C)', x=f%R, y=f%R, c=xmin, dim1=np)
        IF(clpmax) CALL ov('X=-(Y,C)', x=f%R, y=f%R, c=xmax, dim1=np)
      ELSE
        WRITE(lu,*) f%NAME,' IS NOT A VECTOR'
        CALL plante(1)
        stop
      ENDIF
!
!-----------------------------------------------------------------------
!
      RETURN
      END