tracvf.f

Go to the documentation of this file.

!                   *****************
                    SUBROUTINE tracvf
!                   *****************
!
     &(f,fscexp,fxmat,fxmatpar,
     & volu2d,unsv2d,ddt,fxbor,fbor,smh,yasmh,
     & t1,t2,t4,t5,t7,t8,
     & mesh,limtra,kdir,kddl,optsou,iopt2,flbortra,msk,dt,rain,pluie,
     & train,massou,mass_balance)
!
!***********************************************************************
! BIEF   V7P1
!***********************************************************************
!
!brief    COMPUTES THE TRACER FOR FINITE VOLUME SCHEME.
!+                TO COMPLETE.
!
!history  C-T PHAM (LNHE)
!+        06/02/09
!+        V6P0
!+
!
!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
!
!history  J-M HERVOUET (LNHE)
!+        24/02/2012
!+        V6P2
!+   Rain and evaporation added (after initiative by O. Boutron, from
!+   Tour du Valat, and O. Bertrand, Artelia group)
!
!history  J-M HERVOUET (LNHE)
!+        08/06/2015
!+        V7P1
!+   Now mass balance done on request.
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!| DDT            |-->| SUB TIME-STEP
!| DT             |-->| TIME-STEP
!| F              |<--| VALUES OF F AT TIME N+1.
!| FBOR           |-->| VALUES OF F AT THE PRESCRIBED BOUNDARIES
!| FLBORTRA       |<->| FLUX OF TRACER AT THE BOUNDARIES
!| FSCEXP         |-->| EXPLICIT SOURCE TERM FOR F
!| FXBOR          |-->| FLUXES ON BOUNDARIES
!| FXMAT          |-->| FLUXES (NON ASSEMBLED IN PARALLEL)
!| FXMATPAR       |-->| FLUXES (ASSEMBLED IN PARALLEL)
!| H              |-->| WATER DEPTH AT TIME N+1
!| HN             |-->| WATER DEPTH AT TIME N
!| IOPT2          |-->| 0 : UCONV OBEYS CONTINUITY EQUATION
!|                |   | 1 : UCONV DOES NOT OBEY CONTINUITY EQUATION
!| KDDL           |-->| CONVENTION FOR DEGREE OF FREEDOM
!| KDIR           |-->| CONVENTION FOR DIRICHLET POINT
!| LIMTRA         |-->| TECHNICAL BOUNDARY CONDITIONS FOR TRACERS
!| MASS_BALANCE   |-->| IF YES, ALL TERMS FOR MASS BALANCE
!|                |   | WILL BE COMPUTED
!| MASSOU         |-->| MASS ADDED BY SOURCE TERM
!| MESH           |-->| MESH STRUCTURE
!| MSK            |-->| IF YES, MASKING OF DRY ELEMENTS
!| OPTSOU         |-->| TYPE OF SOURCES
!|                |   | 1: NORMAL
!|                |   | 2: DIRAC
!| PLUIE          |-->| RAIN OR EVAPORATION IN M/S, IN BIEF_OBJ STRUCTURE
!| RAIN           |-->| IF YES: RAIN OR EVAPORATION
!| SMH            |-->| SOURCE TERM IN CONTINUITY EQUATION
!| T1             |<->| BIEF_OBJ STRUCTURE USED AS WORK ARRAY
!| T2             |<->| BIEF_OBJ STRUCTURE USED AS WORK ARRAY
!| T4             |<->| BIEF_OBJ STRUCTURE USED AS WORK ARRAY
!| T5             |<->| BIEF_OBJ STRUCTURE USED AS WORK ARRAY
!| T6             |<->| BIEF_OBJ STRUCTURE USED AS WORK ARRAY
!| T7             |<->| BIEF_OBJ STRUCTURE USED AS WORK ARRAY
!| T8             |<->| BIEF_OBJ STRUCTURE USED AS WORK ARRAY
!| TRAIN          |-->| VALUE OF TRACER IN RAIN
!| UNSV2D         |-->| INVERSE OF INTEGRALS OF TEST FUNCTIONS
!| YASMH          |-->| IF YES, SMH MUST BE TAKEN INTO ACCOUNT
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      USE bief, ex_tracvf => tracvf
!
      USE declarations_special
      IMPLICIT NONE
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      INTEGER, INTENT(IN)             :: KDIR,KDDL,OPTSOU,LIMTRA(*)
      INTEGER, INTENT(IN)             :: IOPT2
      DOUBLE PRECISION, INTENT(IN)    :: DDT,DT,TRAIN
      DOUBLE PRECISION, INTENT(INOUT) :: MASSOU
      TYPE(bief_obj), INTENT(INOUT)   :: F,T1,T2,T4,T5,T7,T8,FLBORTRA
      TYPE(bief_obj), INTENT(IN)      :: SMH,FBOR,FSCEXP
      TYPE(bief_obj), INTENT(IN)      :: FXBOR,UNSV2D,VOLU2D,PLUIE
      DOUBLE PRECISION, INTENT(IN)    :: FXMAT(*),FXMATPAR(*)
      TYPE(bief_mesh), INTENT(INOUT)  :: MESH
      LOGICAL, INTENT(IN)             :: YASMH,MSK,RAIN,MASS_BALANCE
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
!
!-----------------------------------------------------------------------
!
      IF(iopt2.EQ.0) THEN
!
!-----------------------------------------------------------------------
!
!     CASE WHERE THE ADVECTION FIELD SATISFIES THE CONTINUITY EQUATION
!     (THE DEPTH COULD BE COMPUTED BY INTERPOLATION IN TIME)
!
!     T4 WILL TAKE THE SUCCESSIVE VALUES OF F (INITIALISED IN CVTRVF)
!
      CALL tvf(f%R,t4%R,t5%R,fxmat,fxmatpar,volu2d%R,unsv2d%R,ddt,
     &         fxbor%R,t7%R,t8,fbor%R,smh%R,yasmh,fscexp%R,
     &         mesh%NSEG,mesh%NPOIN,mesh%NPTFR,
     &         mesh%GLOSEG%I,mesh%GLOSEG%DIM1,
     &         mesh%NBOR%I,limtra,kdir,kddl,
     &         optsou,t5%R,iopt2,flbortra%R,ddt/dt,mesh,rain,pluie%R,
     &         train,massou,mass_balance)
!
!-----------------------------------------------------------------------
!
!     CASE WHERE THE ADVECTION FIELD DOES NOT SATISFY THE CONTINUITY EQUATION
!
      ELSEIF(iopt2.EQ.1) THEN
!
!     T1 WILL TAKE THE SUCCESSIVE VALUES OF HN COMPUTED WITH CONTINUITY
!     T2 WILL TAKE THE SUCCESSIVE VALUES OF H COMPUTED WITH CONTINUITY
!     T4 WILL TAKE THE SUCCESSIVE VALUES OF F
!     T5 WILL TAKE THE SUCCESSIVE VALUES OF TRUE DEPTH
!
!     H2 DEPTH BY CONTINUITY EQUATION
!
      CALL hvf(t2%R,t1%R,fxmat,unsv2d%R,ddt,t7%R,smh%R,
     &         yasmh,mesh%NSEG,mesh%NPOIN,mesh%NPTFR,
     &         mesh%GLOSEG%I,mesh%GLOSEG%DIM1,mesh%NBOR%I,optsou,
     &         t8,mesh,msk,rain,pluie%R)
!
      CALL tvf(f%R,t4%R,t2%R,fxmat,fxmatpar,volu2d%R,unsv2d%R,ddt,
     &         fxbor%R,t7%R,t8,fbor%R,smh%R,yasmh,fscexp%R,
     &         mesh%NSEG,mesh%NPOIN,mesh%NPTFR,
     &         mesh%GLOSEG%I,mesh%GLOSEG%DIM1,
     &         mesh%NBOR%I,limtra,kdir,kddl,
     &         optsou,t5%R,iopt2,flbortra%R,ddt/dt,mesh,rain,pluie%R,
     &         train,massou,mass_balance)
!
!-----------------------------------------------------------------------
!
      ELSE
        WRITE(lu,*) 'TRACVF: UNKNOWN OPTION'
        CALL plante(1)
        stop
      ENDIF
!
!-----------------------------------------------------------------------
!
      RETURN
      END