declarations_tomawac.f

Go to the documentation of this file.

!                   ***************************
                    MODULE declarations_tomawac
!                   ***************************
!
!***********************************************************************
! TOMAWAC   V7P0                                  25/06/2012
!***********************************************************************
!
!brief    DECLARES BIEF STRUCTURES IN TOMAWAC.
!
!history  OPTIMER
!+        14/06/00
!+        V5P2
!+   M. BENOIT / J.M HERVOUET, LEADS FOR EDF
!
!history  OPTIMER
!+        25/08/00
!+        V6P0
!+   D. VIOLEAU, LEAD FOR EDF
!
!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  G.MATTAROLO (EDF)
!+        16/05/2011
!+        V6P1
!+   Declaration of new variables defined by
!+       E. GAGNAIRE-RENOU for solving new source terms models.
!
!history  G.MATTAROLO (EDF)
!+        25/06/2012
!+        V6P2
!+   Declaration of new variables for representing diffraction
!
!history  J-M HERVOUET (EDF R&D, LNHE)
!+        24/12/2013
!+        V7P0
!+   Logical variable RAZTIM added (initial time set to zero).
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      USE bief_def
!
!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
!
!     DECLARES BIEF STRUCTURES
!
!     4D VARIABLES TO BE ADVECTED
!
      type(bief_obj), TARGET :: sf
!
!     ADVECTION COEFFICIENT B
!
      type(bief_obj), TARGET :: sb
!
!     FREQUENCIES
!
      type(bief_obj), TARGET :: sfr
!
!     FREQUENCY STEPS
!
      type(bief_obj), TARGET :: sdfr
!
!     SPECTRAL DENSITY
!
      type(bief_obj), TARGET :: sspec
!
!     DIRECTIONAL FUNCTION
!
      type(bief_obj), TARGET :: sfra
!
!     NON-LINEAR INTERACTIONS
!
      type(bief_obj), TARGET :: scoef
!
!     tableau des pieds des caracteristiques
!
      type(bief_obj), TARGET :: sshp1
!
!     tableau des pieds des caracteristiques
!
      type(bief_obj), TARGET :: sshz
!
      type(bief_obj), TARGET ::sct,scf,sshf,sxk,scg ,
     & szf,sdepth,suc,svc,suc1,svc1,suc2,svc2,sdzhdt,sdzx ,
     & sdzy,sdf_lim,suv,svv,suv1,svv1,suv2,svv2,szm1,szm2,
     & scosf,stgf,sdux,sduy,sdvx,sdvy,steta,scoste,ssinte,
     & sfbor,am1,stsder,ststot,st0,st1,st2,st3,st4,bst1,varsor,
     & sboundary_colour
!
      type(bief_obj), TARGET :: stra01, stold , stnew, stra31,
     & stra32, stra34, stra35, stra36, stra37, stra38, stra39
!
!     Variance
      TYPE(bief_obj), TARGET :: svaria
      DOUBLE PRECISION, DIMENSION(:) ,POINTER :: varian
!
!     Mean Wave number
      TYPE(bief_obj), TARGET :: sxkmoy
      DOUBLE PRECISION, DIMENSION(:) ,POINTER :: xkmoy
!
!     Mean frequency
      TYPE(bief_obj), TARGET :: sfmoy
      DOUBLE PRECISION, DIMENSION(:) ,POINTER :: fmoy
!
!     Wave stress
      TYPE(bief_obj), TARGET :: stauwa
      DOUBLE PRECISION, DIMENSION(:) ,POINTER :: tauwav
!
!     FRICTION VELOCITY
      TYPE(bief_obj), TARGET :: susold, susnew
      DOUBLE PRECISION, DIMENSION(:), POINTER ::  usold, usnew
!
!     SURFACE ROUGHNESS
      TYPE(bief_obj), TARGET :: sz0old
      DOUBLE PRECISION, DIMENSION(:), POINTER :: z0old
!
!     WIND DIRECTION
      TYPE(bief_obj), TARGET :: stwold
      DOUBLE PRECISION, DIMENSION(:), POINTER :: twold
!
!     DRIVING FORCE
      TYPE(bief_obj), TARGET :: forcex, forcey
      DOUBLE PRECISION, DIMENSION(:), POINTER :: fx, fy
!
!     RADIATION STRESS
      TYPE(bief_obj), TARGET :: contxx, contxy, contyy
      DOUBLE PRECISION, DIMENSION(:), POINTER :: sxx, sxy, syy
!
!     Peak Frequency by read method of order 5
      TYPE(bief_obj), TARGET :: pfrea5
      DOUBLE PRECISION, DIMENSION(:), POINTER :: frea5
!
!     Peak Frequency by read method of order 8
      TYPE(bief_obj), TARGET :: pfrea8
      DOUBLE PRECISION, DIMENSION(:), POINTER :: frea8
!
!     DRAG COEFFICIENT
      TYPE(bief_obj), TARGET :: scdra2
      DOUBLE PRECISION, DIMENSION(:) ,POINTER :: cdra2
!
!     MAXIMUM ORBITAL VELOCITY NEAR THE BOTTOM
      TYPE(bief_obj), TARGET :: svifon
      DOUBLE PRECISION, DIMENSION(:), POINTER :: vifond
!
!     POWER PER UNIT LENGTH
      TYPE(bief_obj), TARGET :: spower
      DOUBLE PRECISION, DIMENSION(:), POINTER :: power
!
!     MEAN PERIOD Tmoy
      TYPE(bief_obj), TARGET :: sptmoy
      DOUBLE PRECISION, DIMENSION(:), POINTER :: ptmoy
!
!     MEAN PERIOD Tm01
      TYPE(bief_obj), TARGET :: sptm01
      DOUBLE PRECISION, DIMENSION(:), POINTER :: ptm01
!
!     MEAN PERIOD Tm02
      TYPE(bief_obj), TARGET :: sptm02
      DOUBLE PRECISION, DIMENSION(:), POINTER :: ptm02
!
!     Discrete peak period
      TYPE(bief_obj), TARGET :: spptpd
      DOUBLE PRECISION, DIMENSION(:), POINTER :: pptpd
!
!     Discrete peak period
      TYPE(bief_obj), TARGET :: pprea5
      DOUBLE PRECISION, DIMENSION(:), POINTER :: prea5
!
!     Discrete peak period
      TYPE(bief_obj), TARGET :: pprea8
      DOUBLE PRECISION, DIMENSION(:), POINTER :: prea8

      TYPE(bief_obj), TARGET :: sprive, sibor , slifbr,
     & sliq,   selt,   seta,   sfre,   siagnl, sitr11, sitr12, sitr13,
     & sitr01, sitr31, sitr32, sitr33, sbetbr, sisub,
     & samorp

!     DU vieux
      type(bief_obj), TARGET :: sxrelc, syrelc, sxrelv, syrelv
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: xrelc, xrelv, yrelc,
     & yrelv
!     FIN DU vieux

!     BLOCK OF BIEF_OBJ STRUCTURES
!
      TYPE(bief_obj) :: tb
!
!     EXTENSION OF IKLE2 (WITH LARGER NUMBER OF ELEMENTS)
!
      TYPE(bief_obj) :: ikle_ext
!
!     BIEF_OBJ STRUCTURES FOR ARRAYS OF DIMENSION NPOIN3
!
      TYPE(bief_obj), POINTER :: t3_01,t3_02,t3_03,t3_04,t3_05,t3_06
      TYPE(bief_obj), POINTER :: t3_07,t3_08,t3_09,t3_10
!
!     MESH STRUCTURES FOR 2D AND 3D
!
      TYPE(bief_mesh), TARGET :: mesh,mesh3d
!
!     DIFFRACTION
!
      TYPE(bief_obj), TARGET :: sa, sa_rmse, sccg, sdelta, sddx, sddy
      TYPE(bief_obj), TARGET :: sdiv, snb_close, sneigb
      TYPE(bief_obj), TARGET :: srk, srx, srxx, sry, sryy, sxkonpt

!-----------------------------------------------------------------------
!     KEYWORDS AND PARAMETERS
!-----------------------------------------------------------------------
!
!     NUMBER OF DISCRETISED DIRECTIONS
!
      INTEGER ndire
!
!     NUMBER OF DISCRETISED FREQUENCIES
!
      INTEGER nf
!
!     PERIOD FOR LISTING PRINTOUTS
!
      INTEGER lisprd
!
!     PERIOD FOR GRAPHIC PRINTOUTS
!
      INTEGER graprd
!
!     NUMBER OF TIME STEP
!
      INTEGER, TARGET :: nit
!
!     TIDE REFRESHING PERIOD
!
      INTEGER lam
!
!     RANK OF THE WATER LEVEL DATA IN THE TELEMAC FILE
!
      INTEGER idhma
!
!     NUMBER OF FIRST ITERATION FOR GRAPHICS PRINTOUTS
!
      INTEGER gradeb
!
!     NUMBER OF BOTTOM SMOOTHINGS
!
      INTEGER lisfon
!
!     WIND GENERATION
!
      INTEGER svent
!
!     WHITECAPPING DISSIPATION
!
      INTEGER smout
!
!     BOTTOM FRICTION DISSIPATION
!
      INTEGER sfrot
!
!     NON-LINEAR TRANSFERS BETWEEN FREQUENCIES
!
      INTEGER strif
!
!     DEPTH-INDUCED BREAKING DISSIPATION
!
      INTEGER sbrek
!
!     DEPTH-INDUCED BREAKING 1 (BJ) QB COMPUTATION METHOD
!
      INTEGER iqbbj
!
!     DEPTH-INDUCED BREAKING 1 (BJ) HM COMPUTATION METHOD
!
      INTEGER ihmbj
!
!     DEPTH-INDUCED BREAKING 1 (BJ) CHARACTERISTIC FREQUENCY
!
      INTEGER ifrbj
!
!     DEPTH-INDUCED BREAKING 2 (TG) CHARACTERISTIC FREQUENCY
!
      INTEGER ifrtg
!
!     DEPTH-INDUCED BREAKING 2 (TG) WEIGHTING FUNCTION
!
      INTEGER iwhtg
!
!     DEPTH-INDUCED BREAKING 3 (RO) WAVE HEIGHT DISTRIBUTION
!
      INTEGER idisro
!
!     DEPTH-INDUCED BREAKING 3 (RO) EXPONENT WEIGHTING FUNCTION
!
      INTEGER iexpro
!
!     DEPTH-INDUCED BREAKING 3 (RO) CHARACTERISTIC FREQUENCY
!
      INTEGER ifrro
!
!     DEPTH-INDUCED BREAKING 4 (IH) CHARACTERISTIC FREQUENCY
!
      INTEGER ifrih
!
!     NUMBER OF BREAKING TIME STEPS
!
      INTEGER ndtbrk
!
!     WAVE GROWTH LIMITER
!
      INTEGER limit
!
!     CURRENTS FILE FORMAT
!
      INTEGER indic
!
!     WINDS FILE FORMAT
!
      INTEGER indiv
!
!     TIDAL WATER LEVEL FILE FORMAT
!
      INTEGER indim
!
!     TYPE OF INITIAL DIRECTIONAL SPECTRUM
!
      INTEGER inispe
!
!     TYPE OF BOUNDARY DIRECTIONAL SPECTRUM
!
      INTEGER limspe
!
!     TRIAD INTERACTIONS
!
      INTEGER stria
!
!     NUMBER OF ITERATIONS FOR THE SOURCE TERMS
!
      INTEGER nsits
!
!     TIME INCREMENT NUMBER IN TELEMAC FILE
!
      INTEGER nptt
!
!     VECTOR LENGTH
!
      INTEGER lvmac
!
!     NUMBER OF PRIVATE ARRAYS, NUMBER OF PRIVATE ARRAYS WITH GIVEN NAME
!
      INTEGER npriv,n_names_priv
!
!     NUMBER OF DIFFERENTIATING ARRAYS, AND THOSE WITH A GIVEN NAME
!
      INTEGER nadvar,n_names_advar
!
!     INITIAL ANGULAR DISTRIBUTION FUNCTION
!
      INTEGER frabi
!
!     BOUNDARY ANGULAR DISTRIBUTION FUNCTION
!
      INTEGER frabl
!
!     GODA CONSTANT FOR THE ANGULAR DISTRIBUTION FUNCTION
!
      DOUBLE PRECISION smax
!
!     NUMBER OF POINTS FOR WHICH WE WANT TO WRITE THEIR SPECTRUM
!
      INTEGER npleo
!
!     NUMBER OF POINTS FOR WHICH WE WILL IMPOSE A SPECTRUM
!
      INTEGER npspe
!
!     DEBUGGER
!
      INTEGER debug
!
!     COORDINATES OF THE ORIGIN IN (X, Y)
!
      INTEGER i_orig,j_orig
!
!     LINEAR WAVE GROWTH
!
      INTEGER lvent
!
!     SETTING FOR INTEGRATION ON OMEGA1
!
      INTEGER iq_om1
!
!     SETTING FOR INTEGRATION ON THETA1
!
      INTEGER nq_te1
!
!     SETTING FOR INTEGRATION ON OMEGA2
!
      INTEGER nq_om2
!
!     DIFFRACTION
!
      INTEGER diffra
!
!     STARTING TIME STEP FOR DIFFRACTION
!
      INTEGER nptdif
!
!     DIAGNOSTIC TAIL OPTION
!
      INTEGER diaghf
!
!     OPTION FOR SECOND DERIVATIVES
!
      INTEGER optder
!
!     DISSIPATION BY STRONG CURRENT
!
      INTEGER sdscu
!
!     MODELISATION CBAJ
!
      INTEGER cbaj
!
!     TIME STEP
!
      DOUBLE PRECISION, TARGET :: dt
!
!     MINIMAL FREQUENCY
!
      DOUBLE PRECISION f1
!
!     FREQUENTIAL RATIO
!
      DOUBLE PRECISION raisf
!
!     DATE OF COMPUTATION BEGINNING
!
      DOUBLE PRECISION ddc
!
!     BOTTOM FRICTION COEFFICIENT
!
      DOUBLE PRECISION cfrot1
!
!     WHITE CAPPING DISSIPATION COEFFICIENT
!
      DOUBLE PRECISION cmout1
!
!     WHITE CAPPING WEIGHTING COEFFICIENT
!
      DOUBLE PRECISION cmout2
!
!     AIR DENSITY
!
      DOUBLE PRECISION roair
!
!     WATER DENSITY
!
      DOUBLE PRECISION roeau
!
!     WIND GENERATION COEFFICIENT
!
      DOUBLE PRECISION betam
!
!     VON KARMAN CONSTANT
!
      DOUBLE PRECISION xkappa
!
!     CHARNOCK CONSTANT
!
      DOUBLE PRECISION alpha
!
!     SHIFT GROWING CURVE DUE TO WIND
!
      DOUBLE PRECISION decal
!
!     ELEVATION FOR WIND MEASUREMENTS
!
      DOUBLE PRECISION zvent
!
!     WIND DRAG COEFFICIENT
!
      DOUBLE PRECISION cdrag
!
!     DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT ALPHA
!
      DOUBLE PRECISION alfabj
!
!     DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT GAMMA1
!
      DOUBLE PRECISION gambj1
!
!     DEPTH-INDUCED BREAKING 1 (BJ) COEFFICIENT GAMMA2
!
      DOUBLE PRECISION gambj2
!
!     DEPTH-INDUCED BREAKING 2 (TG) COEFFICIENT B
!
      DOUBLE PRECISION boretg
!
!     DEPTH-INDUCED BREAKING 2 (TG) COEFFICIENT GAMMA
!
      DOUBLE PRECISION gamatg
!
!     DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT ALPHA
!
      DOUBLE PRECISION alfaro
!
!     DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA
!
      DOUBLE PRECISION gamaro
!
!     DEPTH-INDUCED BREAKING 3 (RO) COEFFICIENT GAMMA2
!
      DOUBLE PRECISION gam2ro
!
!     DEPTH-INDUCED BREAKING 4 (IH) COEFFICIENT BETA0
!
      DOUBLE PRECISION betaih
!
!     DEPTH-INDUCED BREAKING 4 (IH) COEFFICIENT M2STAR
!
      DOUBLE PRECISION em2sih
!
!     MAXIMUM VALUE OF THE RATIO HM0 OVER D
!
      DOUBLE PRECISION coefhs
!
!     COEFFICIENT OF THE TIME SUB-INCREMENTS FOR BREAKING
!
      DOUBLE PRECISION xdtbrk
!
!     STANDARD CONFIGURATION PARAMETER
!
      DOUBLE PRECISION xlamd
!
!     IMPLICITATION COEFFICIENT FOR SOURCE TERMS
!
      DOUBLE PRECISION cimpli
!
!     INITIAL STILL WATER LEVEL
!
      DOUBLE PRECISION zrepos
!
!     TRIADS 1 (LTA) COEFFICIENT ALPHA
!
      DOUBLE PRECISION alflta
!
!     TRIADS 1 (LTA) COEFFICIENT RFMLTA
!
      DOUBLE PRECISION rfmlta
!
!     TRIADS 2 (SPB) NUMBER OF CONFIGURATIONS
!
      INTEGER nbd
!
!     TRIADS 2 (SPB) COEFFICIENT K
!
      DOUBLE PRECISION kspb
!
!     TRIADS 2 (SPB) LOWER DIRECTIONAL BOUNDARY
!
      DOUBLE PRECISION bdispb
!
!     TRIADS 2 (SPB) UPPER DIRECTIONAL BOUNDARY
!
      DOUBLE PRECISION bdsspb
      ! TRIAD QT2
      INTEGER, ALLOCATABLE :: qindi(:)
      LOGICAL :: deja_qt2 = .false.
!
!     SIGNIFICANT WAVE HEIGHT
!
      DOUBLE PRECISION hm0
!
!     PEAK FREQUENCY
!
      DOUBLE PRECISION fpic
!
!     PEAK FACTOR
!
      DOUBLE PRECISION gamma
!
!     VALUE OF SIGMA-A FOR SPECTRUM
!
      DOUBLE PRECISION sigmaa
!
!     VALUE OF SIGMA-B FOR SPECTRUM
!
      DOUBLE PRECISION sigmab
!
!     PHILLIPS CONSTANT
!
      DOUBLE PRECISION alphil
!
!     MEAN FETCH VALUE
!
      DOUBLE PRECISION fetch
!
!     MAXIMUM PEAK FREQUENCY
!
      DOUBLE PRECISION fremax
!
!     MAIN DIRECTION 1
!
      DOUBLE PRECISION teta1
!
!     DIRECTIONAL SPREAD 1
!
      DOUBLE PRECISION spred1
!
!     MAIN DIRECTION 2
!
      DOUBLE PRECISION teta2
!
!     DIRECTIONAL SPREAD 2
!
      DOUBLE PRECISION spred2
!
!     WEIGHTING FACTOR FOR ADF (DIRECTIONAL SPREADING FUNCTION)
!
      DOUBLE PRECISION xlamda
!
!     SPECTRUM TAIL FACTOR
!
      DOUBLE PRECISION tailf
!
!     SPECTRUM ENERGY THRESHOLD
!
      DOUBLE PRECISION e2fmin
!
!     BOUNDARY SIGNIFICANT WAVE HEIGHT
!
      DOUBLE PRECISION hm0l
!
!     BOUNDARY PEAK FREQUENCY
!
      DOUBLE PRECISION fpicl
!
!     BOUNDARY SPECTRUM VALUE OF SIGMA-A
!
      DOUBLE PRECISION sigmal
!
!     BOUNDARY SPECTRUM VALUE OF SIGMA-B
!
      DOUBLE PRECISION sigmbl
!
!     BOUNDARY PHILLIPS CONSTANT
!
      DOUBLE PRECISION aphill
!
!     BOUNDARY MEAN FETCH VALUE
!
      DOUBLE PRECISION fetchl
!
!     BOUNDARY MAXIMUM PEAK FREQUENCY
!
      DOUBLE PRECISION fpmaxl
!
!     BOUNDARY MAIN DIRECTION 1
!
      DOUBLE PRECISION teta1l
!
!     BOUNDARY DIRECTIONAL SPREAD 1
!
      DOUBLE PRECISION spre1l
!
!     BOUNDARY MAIN DIRECTION 2
!
      DOUBLE PRECISION teta2l
!
!     BOUNDARY DIRECTIONAL SPREAD 2
!
      DOUBLE PRECISION spre2l
!
!     BOUNDARY WEIGHTING FACTOR FOR ADF
!
      DOUBLE PRECISION xlamdl
!
!     BOUNDARY PEAK FACTOR
!
      DOUBLE PRECISION gammal
!
!     WIND VELOCITY ALONG X AND Y
!
      DOUBLE PRECISION vx_cte,vy_cte
!
!     MINIMUM WATER DEPTH
!
      DOUBLE PRECISION promin
!
!     COORDINATES OF SPECTRUM PRINTOUT POINTS
!
      DOUBLE PRECISION, ALLOCATABLE :: xleo(:),yleo(:)
!
!     ID OF SPECTRUM PRINTOUT NODE
!
      INTEGER, ALLOCATABLE :: noleo(:)
!
!     COORDINATES OF THE SPECTRUM THAT WILL BE IMPOSED
!
      DOUBLE PRECISION, ALLOCATABLE :: xspe(:),yspe(:)
!
!     YAN GENERATION COEFFICIENT D
!
      DOUBLE PRECISION coefwd
!
!     YAN GENERATION COEFFICIENT E
!
      DOUBLE PRECISION coefwe
!
!     YAN GENERATION COEFFICIENT F
!
      DOUBLE PRECISION coefwf
!
!     YAN GENERATION COEFFICIENT H
!
      DOUBLE PRECISION coefwh
!
!     WESTHUYSEN DISSIPATION COEFFICIENT
!
      DOUBLE PRECISION cmout3
!
!     SATURATION THRESHOLD FOR THE DISSIPATION
!
      DOUBLE PRECISION cmout4
!
!     WESTHUYSEN WHITE CAPPING DISSIPATION
!
      DOUBLE PRECISION cmout5
!
!     WESTHUYSEN WEIGHTING COEFFICIENT
!
      DOUBLE PRECISION cmout6
!
!     QNL4 - THRESHOLD0 FOR CONFIGURATIONS ELIMINATION
!
      DOUBLE PRECISION seuil
!
!     QNL4 - THRESHOLD1 FOR CONFIGURATIONS ELIMINATION
!
      DOUBLE PRECISION seuil1
!
!     QNL4 - THRESHOLD2 FOR CONFIGURATIONS ELIMINATION
!
      DOUBLE PRECISION seuil2
!
!     SPECTRUM VARIANCE THRESHOLD FOR DIFFRACTION
!
      DOUBLE PRECISION f2difm
!
!     DISSIPATION COEFFICIENT FOR STRONG CURRENT
!
      DOUBLE PRECISION cdscur
!
!     TIME OF BEGGINNING CALCULATION
!
      DOUBLE PRECISION at0
!
!     CONSIDERATION OF SOURCE TERMS
!
      LOGICAL tsou
!
!     SPHERICAL COORDINATES
!
      LOGICAL sphe
!
!     GLOBAL OUTPUT AT THE END
!
      LOGICAL glob
!
!     NEXT COMPUTATION
!
      LOGICAL suit
!
!     INFINITE DEPTH
!
      LOGICAL proinf
!
!     CONSIDERATION OF A CURRENT
!
      LOGICAL couran
!
!     CONSIDERATION OF A WIND
!
      LOGICAL vent
!
!     CONSIDERATION OF A STATIONARY CURRENT
!
      LOGICAL cousta
!
!     CONSIDERATION OF A STATIONARY WIND
!
      LOGICAL vensta
!
!     CONSIDERATION OF TIDE
!
      LOGICAL maree
!
!     TRIGONOMETRICAL CONVENTION
!
      LOGICAL trigo
!
!     RECOVERY OF TELEMAC DATA ITEM
!
      LOGICAL dontel
!
!     CONSIDERATION OF PROPAGATION
!
      LOGICAL prop
!
!     VALIDATION
!
      LOGICAL valid
!
!     LIMIT SPECTRUM MODIFIED BY USER
!
      LOGICAL speuli
!
!     DIFFRACTION FILTER
!
      LOGICAL fltdif
!
!     INITIAL TIME SET TO ZERO
!
      LOGICAL raztim
!
!     VEGETATION TAKEN INTO ACCOUNT
!
      LOGICAL vegetation
!
!     POROUS MEDIA TAKEN INTO ACCOUNT
!
      LOGICAL porous
!
!     SOURCE TERMS CALCULATED ON IMPOSED BOUNDARIES
!
      LOGICAL source_on_bnd
!
!     TITLE
!
      CHARACTER (LEN=80) :: titcas
!
!     VARIABLES FOR 2D GRAPHIC PRINTOUTS
!
      CHARACTER(LEN=72) :: sort2d
!
      INTEGER, PARAMETER :: maxvar = 35
!
!     EQUATION SOLVED
!
      CHARACTER(LEN=20) equa
!
!     NAMES OF PRIVATE ARRAYS (GIVEN BY USER)
!
      CHARACTER(LEN=32) names_prive(4)
!
!     NAMES OF DIFFERENTING ARRAYS (GIVEN BY USER)
!
      CHARACTER(LEN=32) names_advar(maxvar)
!
!     TYPE OF ELEMENT IN 2D, 3D
!
      INTEGER ielm2,ielm3
!
!     NPOIN2*NDIRE
!
      INTEGER npoin3
!
!GM V6P1 - NEW SOURCE TERMS
! declaration for QNL4 - MDIA method
      INTEGER, PARAMETER :: mdia = 4
! declaration for QNL4 - MDIA method
      INTEGER         , ALLOCATABLE ::  ianmdi(:,:,:)
! declaration for QNL4 - MDIA method
      DOUBLE PRECISION,ALLOCATABLE :: coemdi(:,:),xmumdi(:),xlamdi(:)
! declaration for QNL4 - GQM method
      INTEGER  nconf , nconfm , nf1 , nf2 , nt1
! declaration for QNL4 - GQM method
      DOUBLE PRECISION elim
! declaration for QNL4 - GQM method
      INTEGER, ALLOCATABLE :: k_if1(:) , k_1p(:,:) , k_1m(:,:),
     &                        k_if2(:,:,:), k_if3(:,:,:),
     &                        k_1p2p(:,:,:), k_1p2m(:,:,:),
     &                        k_1p3p(:,:,:), k_1p3m(:,:,:),
     &                        k_1m2p(:,:,:), k_1m2m(:,:,:),
     &                        k_1m3p(:,:,:), k_1m3m(:,:,:),
     &                        idconf(:,:)
! declaration for QNL4 - GQM method
      DOUBLE PRECISION, ALLOCATABLE :: tb_v24(:,:,:), tb_v34(:,:,:),
     &                                 tb_tpm(:,:,:), tb_tmp(:,:,:),
     &                                 tb_fac(:,:,:),
     &                                 tb_v14(:)
! declaration for QNL4 - GQM method
      INTEGER, PARAMETER :: lbuf = 500
! declaration for QNL4 - GQM method
      INTEGER, PARAMETER :: dimbuf = 2*lbuf+200
! declaration for QNL4 - GQM method
      INTEGER f_poin(dimbuf) , t_poin(dimbuf)
! declaration for QNL4 - GQM method
      DOUBLE PRECISION f_coef(dimbuf), f_proj(dimbuf), tb_sca(dimbuf)
!GM Fin
!
!V6P2 Diffraction
! description
      INTEGER, PARAMETER :: maxnsp = 30
      INTEGER :: nrk_c
!V6P2 End diffraction
!
      LOGICAL sorleo(maxvar) , sorimp(maxvar)
      CHARACTER(LEN=32) varcla(10)
! nom des variables
      CHARACTER(LEN=32) texte(maxvar)
!
      INTEGER :: alire(maxvar)
!      DATA ALIRE /
!     BE ABSOLUTLY SURE THAT ALIRE IS SIZE MAXVAR
      parameter( alire = (/
     &    0,1,1,1,0,0,0,0,0,0,1,1,0,0,0,0,0,1,1,0,0,0,0,0,0,0,0,
     &    0,0,0,0,0,0,0,0 /) )
!
!-----------------------------------------------------------------------
!   DECLARES POINTERS FOR ALIASES
!   THE TARGETS ARE DEFINED IN POINT
!-----------------------------------------------------------------------
!
!     MESH COORDINATES PER POINT
!
      DOUBLE PRECISION, DIMENSION(:), POINTER :: x,y
!
!     MESH COORDINATES IN ELEMENTS
!
      DOUBLE PRECISION, DIMENSION(:), POINTER :: xel,yel
! inverse du determinant des elements 2d
      DOUBLE PRECISION, DIMENSION(:), POINTER :: surdet
! correspondance numerotation locale-globale
      INTEGER, DIMENSION(:) , POINTER :: ikle2
! numeros 2d des elements ayant une face commune avec l'element.
! si ifabor<=0 on a une face liquide,solide,ou periodique
      INTEGER, DIMENSION(:) , POINTER :: ifabor
! numeros globaux des points frontieres
      INTEGER, DIMENSION(:) , POINTER :: nbor
! nombre d'elements du maillage 2d
      INTEGER, POINTER:: nelem2
! nombre de points 'frontiere'
      INTEGER, POINTER:: nptfr
! nombre de points du maillage 2d
      INTEGER, POINTER :: npoin2
! spectre directionnel de variance
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: f
! champ convecteur selon teta
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: ct
! champ convecteur selon freq. relat.
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: cf
! coordonnees barycentriques suivant z des noeuds dans leurs etages "eta" associes
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: shz
! coordonnees barycentriques suivant f des noeuds dans leurs frequences "fre" associees
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: shf
! jacobien passage de n(kx,ky) a f(fr,teta)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: b
! nombres d'onde
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: xk
! vitesses de groupe
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: cg
! cote du fond
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: zf
! profondeur
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: depth
! composantes ouest-est du courant (a t)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: uc
! composantes sud-nord du courant (a t)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: vc
! composantes ouest-est du courant (a t1)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: uc1
! composantes sud-nord du courant (a t1)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: vc1
! composantes ouest-est du courant (a t2)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: uc2
! composantes sud-nord du courant (a t2)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: vc2
! variation temporelle de la profondeur
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: dzhdt
! gradient de profondeur par rapport a x
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: dzx
! gradient de profondeur par rapport a y
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: dzy
! tableau utilise pour le limiteur de croissance
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: df_lim
! composantes ouest-est du vent (a t)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: uv
! composantes sud-nord du vent (a t)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: vv
! composantes ouest-est du vent (a t1)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: uv1
! composantes sud-nord du vent (a t1)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: vv1
! composantes ouest-est du vent (a t2)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: uv2
! composantes sud-nord du vent (a t2)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: vv2
! hauteur de la maree par rapport a zrepos a t1
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: zm1
! hauteur de la maree par rapport a zrepos a t2
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: zm2
! frequences de discretisation
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: freq
! pas de frequence
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: dfreq
! VARIANCE DENSITY FREQUENCY SPECTRUM
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: spec
! DIRECTIONAL SPREADING FUNCTION VALUES
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: fra
! coefficients de calcul pour dia
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: coefnl
! cosinus des latitudes des points 2d
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: cosf
! tangentes des latitudes des points 2d
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: tgf
! gradient de courant u  par rapport a x
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: dux
! gradient de courant u  par rapport a y
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: duy
! gradient de courant v  par rapport a x
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: dvx
! gradient de courant v  par rapport a y
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: dvy
! directions de discretisation
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: teta
! cosinus des directions
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: costet
! sinus des directions
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: sintet
! densite spectrale au bord
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: fbor
! contribution terme source - partie derivee
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: tsder
! contribution terme source - partie totale
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: tstot
! tableau de travail structures
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: t0
! tableau de travail structures
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: t1
! tableau de travail structures
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: t2
! tableau de travail structures
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: t3
! tableau de travail structures
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: t4
! BREAKING WAVE RATIO (CALCULATED IN QBREAK AND USED IN FDISS3D AND FDISSK)
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: betabr
! tableau de travail
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: told
! tableau de travail
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: tnew
! AMORTISSEMENT DE MILIEU POREUX
      DOUBLE PRECISION, DIMENSION(:) , POINTER ::  amorp
!
      DOUBLE PRECISION, DIMENSION(:) ,POINTER :: tra31, tra32,
     & tra34, tra35, tra36 , tra37 , tra38 , tra39
! tableau de travail
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: tra01
! tableau utilisateur
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: prive
! differentiable arrays
      DOUBLE PRECISION, DIMENSION(:) , POINTER :: advar
!
      INTEGER, DIMENSION(:), POINTER :: ibor
! type des conditions a la limite sur f(libre / impose)
      INTEGER, DIMENSION(:), POINTER :: lifbor
! COLOUR OF BOUNDARY POINT (DEFAULT: ITS RANK)
      INTEGER, DIMENSION(:), POINTER :: boundary_colour
! numeros des elements 2d choisis pour chaque noeud
      INTEGER, DIMENSION(:), POINTER :: elt
! numeros des directions/etages choisis pour chaque noeud
      INTEGER, DIMENSION(:), POINTER :: eta
! numeros des Sous-domaines ou sont les pieds des caracteristiques
      INTEGER, DIMENSION(:), POINTER :: isub
! numeros des frequences choisies pour chaque noeud
      INTEGER, DIMENSION(:), POINTER :: fre
! tableau des indices angulaires pour dia
      INTEGER, DIMENSION(:), POINTER :: iangnl
!
      INTEGER, DIMENSION(:), POINTER :: itr11 , itr12 , itr13
! tableau de travail
      INTEGER, DIMENSION(:), POINTER :: itr01
!
      INTEGER, DIMENSION(:), POINTER :: itr31,itr32,itr33
!
!     Diffraction
!
      INTEGER, DIMENSION(:), POINTER ::   nb_close, neigb
      DOUBLE PRECISION, DIMENSION(:), POINTER :: ampli, a_rmse, ccg,
     &               delta, div, ddx, ddy, rk, rx, rxx, ry, ryy, xkonpt
!
!     GEOMETRY FILE
!
      INTEGER, TARGET :: wacgeo
!
!     STEERING FILE
!
      INTEGER :: waccas
!
!     BOUNDARY CONDITIONS FILE
!
      INTEGER, TARGET :: waccli
!
!     BOTTOM TOPOGRAPHY FILE
!
      INTEGER :: wacfon
!
!     2D RESULTS FILE
!
      INTEGER, TARGET :: wacres
!
!     1D SPECTRA RESULTS FILE
!
      INTEGER :: wacspe
!
!     PUNCTUAL RESULTS FILE
!
      INTEGER :: wacleo
!
!     PREVIOUS COMPUTATION FILE
!
      INTEGER :: wacpre
!
!     GLOBAL RESULT FILE
!
      INTEGER :: wacrbi
!
!     BINARY CURRENTS FILE
!
      INTEGER :: waccob
!
!     FORMATTED CURRENTS FILE
!
      INTEGER :: waccof
!
!     BINARY FILE 1
!
      INTEGER :: wacbi1
!
!     FORMATTED FILE 1
!
      INTEGER :: wacfo1
!
!     BINARY WINDS FILE
!
      INTEGER :: wacveb
!
!     FORMATTED WINDS FILE
!
      INTEGER :: wacvef
!
!     VALIDATION FILE
!
      INTEGER :: wacref
!
!     BINARY TIDAL WATER LEVEL FILE
!
      INTEGER :: wacmab
!
!     FORMATTED TIDAL WATER LEVEL FILE
!
      INTEGER :: wacmaf
!
!     TEXT FILE WHICH DEFINES X AND Y COORDINATES FOR OUTPUTED SPECTRA
!
      INTEGER :: leowxy
!
!     TEXT FILE WHICH DEFINES X AND Y COORDINATES FOR IMPOSED SPECTRA
!
      INTEGER :: leoixy
!
!     BINARY FILE WITH THE IMPOSED SPECTRA
!
      INTEGER :: impspe
!
!     MAXIMUM OF LOGICAL UNITS NUMBERS
!
      INTEGER, PARAMETER :: maxlu_wac = 44
!
!     BIEF_FILES STRUCTURES
!
      TYPE(bief_file), TARGET :: wac_files(maxlu_wac)
!     THOSE POINTER WILL DIRECTLY ADDRESS LOGICAL UNIT, NAME, AND FORMAT
      INTEGER, POINTER :: lugeo, lures, lupre, lubi1, lufo1,
     &    lufon, luleo, luspe, luwxy, luixy, luveb, luvef, luref, lurbi,
     &    lucob, lucof, lumab, lumaf
      CHARACTER(LEN=PATH_LEN), POINTER :: namfon, namres, namleo,
     &namspe, namwxy, namixy, namveb, namvef, namcob, namcof, nammaf,
     &nammab
      CHARACTER(LEN=8), POINTER :: fmtgeo, fmtres, fmtpre, fmtbi1,
     & fmtleo, fmtveb, fmtvef, fmtref, fmtrbi, fmtcob, fmtcof,
     & fmtmaf, fmtmab
!
!     TOMAWAC CONSTANTS (INITIALISED INTO TOMAWAC_CONSTANTS)
!
      DOUBLE PRECISION :: pi,deupi,gravit,pisur2,gradeg,degrad
      DOUBLE PRECISION :: sr,r2,usdpi
!
!     FOR READING NAMES OF VARIABLES IN SERAFIN DATA FILES
!     30 IS HERE A MAXIMUM OF VARIABLES PER FILE
!
      CHARACTER(LEN=32) :: texcob(30),texmab(30),texveb(30)
!
!     NAMES OF VARIABLES IN SERAFIN DATA FILES (VELOCITY ALONG X AND Y
!                                               WIND ALONG X AND Y
!                                               DEPTH)
!
      CHARACTER(LEN=32) :: nameu,namev,namewx,namewy,nameh
!
!     UNIT OF TIME IN SERAFIN DATA FILES
!
      DOUBLE PRECISION :: unitcob,unitmab,unitveb,unitspe
!
!     TIME SHIFT IN SERAFIN DATA FILES
!
      DOUBLE PRECISION :: phascob,phasmab,phasveb,phasspe
!
!     SAVED VARIABLE
!
      ! limwac
      DOUBLE PRECISION, ALLOCATABLE :: uv2d(:),vv2d(:),prof(:)
      DOUBLE PRECISION, ALLOCATABLE :: fb_cte(:,:)
      INTEGER :: npb
      ! rpi_invr
      DOUBLE PRECISION, ALLOCATABLE:: rk_i(:,:), rn(:,:)
      DOUBLE PRECISION, ALLOCATABLE:: rx_i(:,:), ry_i(:,:)
      DOUBLE PRECISION, ALLOCATABLE:: rxx_i(:,:), ryy_i(:,:)
      DOUBLE PRECISION, ALLOCATABLE:: rad1(:,:)
      LOGICAL :: deja_rpi = .false.
      ! frmset
      INTEGER,ALLOCATABLE:: ilm_poin(:,:), clm(:), kacc(:)
      INTEGER,ALLOCATABLE:: nb_c(:), sur_p(:,:)
      INTEGER,ALLOCATABLE:: stack(:), stack2(:)
      LOGICAL,ALLOCATABLE:: already_pom(:)
      DOUBLE PRECISION,ALLOCATABLE:: mindist(:)
      LOGICAL :: deja_frmset = .false.
      ! diffrac
      DOUBLE PRECISION, ALLOCATABLE :: sqrdelta(:)
      DOUBLE PRECISION, ALLOCATABLE :: sqrccg(:)
      DOUBLE PRECISION, ALLOCATABLE :: frdk(:,:),frda(:,:),scda(:,:)
      LOGICAL, ALLOCATABLE :: l_delta(:)
      LOGICAL :: deja_diffrac = .false.
      ! rpi_intr
      DOUBLE PRECISION, ALLOCATABLE :: wu_om_rpi(:)
      LOGICAL :: deja_rpi_intr = .false.
      DOUBLE PRECISION dtsi
      ! Time step informations
      DOUBLE PRECISION, TARGET :: at
      INTEGER, TARGET :: lt
!     NUMBER OF VARIABLES OF THE FORMATTED CURRENT FILE
      INTEGER nvcou
!     TIME T1 AND T2 IN THE CURRENT FILE
      DOUBLE PRECISION tc1,tc2
!     N.OF VARIABLES OF THE FORMATTED WATER LEVEL FILE
      INTEGER nvhma
!     TIME T1 AND T2 IN THE WATER LEVEL FILE
      DOUBLE PRECISION tm1,tm2
!     N.OF VARIABLES OF THE WIND FILE
      INTEGER nvwin
!     TIME T1 AND T2 IN THE WIND FILE
      DOUBLE PRECISION tv1,tv2
!     SAY IF WE TAKE BOUNDARY CONDITION BEFORE OR AFTER THE TIMESTEP
!     true limwac at the beginning of the loop in time
      LOGICAL avant
!     SAY IF WE USE ECRETE FUNCTION FOR THE SPECTRUM.
      LOGICAL ecret
      ! Coupling informations
      TYPE cpl_wac_data_obj
        ! Number of telemac time steps
        INTEGER :: nit_tel
        ! Coupling period with telemac
        INTEGER :: percou_wac
        ! Current velocity along x in telemac model
        TYPE(bief_obj), POINTER :: u_tel
        ! Current velocity along y in telemac model
        TYPE(bief_obj), POINTER :: v_tel
        ! Telemac model water depth
        TYPE(bief_obj), POINTER :: h_tel

        ! Mean direction of wave
        TYPE(bief_obj), POINTER :: dirmoy_tel
        ! Significant wave height
        TYPE(bief_obj), POINTER :: hm0_tel
        ! Peak Period order 5th
        TYPE(bief_obj), POINTER :: tpr5_tel

        ! Orbital velocity
        TYPE(bief_obj), POINTER :: orbvel_tel
        ! Driving force along x passed to telemac
        TYPE(bief_obj), POINTER :: fx_wac
        ! Driving force along y passed to telemac
        TYPE(bief_obj), POINTER :: fy_wac
        ! Wind velocity along x in tomawac model
        TYPE(bief_obj), POINTER :: uv_wac
        ! Wind velocity along y in tomawac model
        TYPE(bief_obj), POINTER :: vv_wac
        ! Telemac model time step
        DOUBLE PRECISION :: dt_tel
        ! Computation time of telemac model
        DOUBLE PRECISION :: at_tel
        LOGICAL :: coupl3d
!       WAVE INDUCED PRESSURE AND ITS DERIVATIVES
        TYPE(bief_obj),POINTER :: wipw, wipdxw, wipdyw
!       STOKES VELOCITY
        TYPE(bief_obj),POINTER :: ustw, vstw, wstw
!       ELEVATION
        TYPE(bief_obj),POINTER :: ztelw
        INTEGER :: nzw
!       SURFACES STRESS DUE TO DEPTH INDUCED WAVE BREAKING
        TYPE(bief_obj),POINTER :: fdxw, fdyw
!       DISSIPATION DUE TO BOTTOM FRICTION
        TYPE(bief_obj),POINTER :: fbxw, fbyw
!       MODIFIED FRICTION COEFFICIENT DUE TO WAVES + CURRENTS
        TYPE(bief_obj),POINTER :: cfwcw
!       MODIFIED TURBULENT WAVES VISCOSITY DUE TO BREAKING
        TYPE(bief_obj),POINTER :: fdkw
!       FORCES DUE TO WIND
        TYPE(bief_obj),POINTER :: fwx, fwy
      END TYPE

      TYPE(cpl_wac_data_obj) :: cpl_wac_data
      INTEGER, PARAMETER :: wac_full_run = -1
      INTEGER, PARAMETER :: wac_cpl_init = 0
      INTEGER, PARAMETER :: wac_cpl_run = 1
      INTEGER, PARAMETER :: wac_api_init = 2
      INTEGER, PARAMETER :: wac_api_run = 3

      SAVE
!
!     COUPLING VARIABLES
      TYPE(bief_obj), TARGET :: u_tel,v_tel,h_tel
      TYPE(bief_obj), TARGET :: dirmoy_tel,hm0_tel,tpr5_tel
      TYPE(bief_obj), TARGET :: cosdir_tel,sindir_tel
      TYPE(bief_obj), TARGET :: orbvel_tel
      TYPE(bief_obj), TARGET :: fx_wac,fy_wac
      TYPE(bief_obj), TARGET :: uv_wac,vv_wac

      ! NUMBER OF VARIABLES TO COMMUNICATE
      INTEGER :: nvartom2tel
      INTEGER :: nvartel2tom

      ! BLOCK FOR COMMUNICATION
      TYPE(bief_obj)   :: tel2tom, tom2tel

      ! COPIES OF TELEMAC VARIABLES
      LOGICAL :: courou_tel, vent_tel, copsis_tel



      END MODULE declarations_tomawac