user_condim_sisyphe.f

Go to the documentation of this file.

!                   ******************************
                    SUBROUTINE user_condim_sisyphe
!                   ******************************
!
     & (u      , v       , qu    , qv   , h    , zf , z ,
     &  esomt  , thetawr ,  q    , hwr  , twr  ,
     &  x      , y       , npoin , at   , pmaree)
!
!***********************************************************************
! SISYPHE
!***********************************************************************
!
!brief    USER INITIALISES THE VARIABLES NOT READ FROM THE RESULTS
!+                FILE (REPLACES THE VALUES READ IN THE RESULTS FILE).
!+
!+         IMPOSED VALUES OF :
!+
!+         -  DEPTH-AVERAGED FLOW RATE (X,Y): QU, QV
!+
!+         -  WATER DEPTH:                    H
!+
!+         -  BOTTOM ELEVATION:               ZF
!+
!+         -  FREE SURFACE:                   Z
!+
!+         -  TOTAL BED VOLUTION:             ESOMT
!+
!+         -  FLOW RATE:                      Q
!+
!+         -  WAVE HEIGHT:                    HWR
!+
!+         -  WAVE PERIOD:                    TWR
!+
!+         -  WAVE DIRECTION (WRT OY AXIS):   THETAWR.
!
!warning  CONDIM_SISYPHE IS CALLED AT EACH TIME STEP IN ORDER TO
!+            IMPOSE A VARIABLE FORCING (TIDAL CURRENT, FOR EXAMPLE)
!warning  IT IS NOT SUFFICIENT TO PRESCRIBE THE FLOW RATE.
!+            THE MAIN VARIABLES ARE NOW THE 2D FLOW VELOCITY FIELD
!+            AND THE FLOW DEPTH
!
!history  E. PELTIER; C. LENORMANT; J.-M. HERVOUET
!+        11/09/95
!+        V5P3
!+
!
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!| AT             |-->| TIME
!| ESOMT          |<->| TOTAL BED EVOLUTION
!| H              |<->| WATER DEPTH
!| HWR            |<->| WAVE HEIGHT
!| NPOIN          |-->| NUMBER OF 2D POINTS
!| PMAREE         |-->| TIDAL PERIOD
!| Q              |<->| FLOW RATE
!| THETAWR        |<->| WAVE DIRECTION (WRT OY AXIS)
!| TWR            |<->| WAVE PERIOD
!| X,Y            |-->| COORDINATES
!| Z              |<->| FREE SURFACE
!| ZF             |<->| BED ELEVATION
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      USE bief
      USE declarations_sisyphe, ONLY: hw,tw,thetaw
!
      USE declarations_special
      IMPLICIT NONE
!
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
      INTEGER, INTENT(IN)::NPOIN
!
      DOUBLE PRECISION, INTENT(IN):: X(npoin),Y(npoin)
      DOUBLE PRECISION, INTENT(IN):: AT , PMAREE
! SEDIMENT
      DOUBLE PRECISION, INTENT(INOUT) ::  ZF(npoin)
      DOUBLE PRECISION, INTENT (INOUT)::  ESOMT(npoin)
! HYDRODYNAMICS
      DOUBLE PRECISION, INTENT(INOUT):: Z(npoin) , H(npoin)
      DOUBLE PRECISION, INTENT(INOUT):: U(npoin) , V(npoin)
      DOUBLE PRECISION, INTENT (INOUT)::QU(npoin), QV(npoin), Q(npoin)
! WAVES
      DOUBLE PRECISION, INTENT (INOUT):: HWR(npoin) , TWR(npoin)
      DOUBLE PRECISION, INTENT (INOUT):: THETAWR(npoin)
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
!-----------------------------------------------------------------------
!
!     ------------------------
!     THE USER SHOULD BE AWARE
!     ++++++++++++++++++++++++
!
!     SUBROUTINE CONDIM_SISYPHE IS CALLED AT EACH TIME STEP
!     IN ORDER TO IMPOSE A VARIABLE FORCING
!     (TIDAL CURRENT, FOR EXAMPLE)
!
!     IT IS NOT SUFFICIENT TO PRESCRIBE THE FLOW RATE
!     THE MAIN VARIABLES ARE NOW THE 2D FLOW VELOCITY FIELD
!     AND THE FLOW DEPTH
!
!-----------------------------------------------------------------------
!
!     WAVES, EXAMPLE WITH NO WAVES:
!
      IF(.false.) THEN
!     AMPLITUDE = 0
      CALL os('X=0     ',x=hw)
!     PERIOD = 1 S
      CALL os('X=C     ',x=tw,c=1.d0)
!     ANGLE = 0
      CALL os('X=0     ',x=thetaw)
!
!     AFTER SETTING HWR, TWR AND THETAWR, PLEASE ADD:
!
      hw%TYPR    ='Q'
      tw%TYPR    ='Q'
      thetaw%TYPR='Q'
      ENDIF
!
!     TO ENABLE THE CONTROL OF WAVE DATA
!
!-----------------------------------------------------------------------
!
      RETURN
      END SUBROUTINE