declarations_sisyphe.f

Go to the documentation of this file.

!                   ***************************
                    MODULE declarations_sisyphe
!                   ***************************
!
!
!***********************************************************************
! SISYPHE   V7P2
!***********************************************************************
!
!brief    DECLARATION OF PRINCIPAL SISYPHE VARIABLES
!
!history  CV
!+        15/03/2009
!+
!+   ADDED VARIABLES MU, KS, KSP, KSR
!+
!+   VITCE AND VITCD ARE CONSTANT
!
!history  JMH
!+        13/08/2009
!+
!+   IT5 DELETED
!
!history  CV+RK+UW
!+        15/03/2011
!+
!+   ADDED VARIABLES MPM_ARRAY, MPM, MOFAC,ALPHA
!+
!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  MAK (HRW)
!+        01/01/2012
!+        V6P2
!+   CHANGE create parameter for ratio depth averaged and reference concentration.
!+   CSRATIO
!
!history  JWI (HRW)
!+        31/05/2012
!+        V6P2
!+ added lines to include wave orbital velocities
!+ TYPE(BIEF_OBJ), TARGET :: DEL_UW
!
!history  CV (EDF)
!+        30/07/2012
!+        V6P2
!+ added new variable ZFCL_MS
!
!history  Pablo Tassi PAT (EDF-LNHE)
!+        12/02/2013
!+        V6P3
!+ Preparing for the use of a higher NSICLM value
!+ (by Rebekka Kopmann)
!
!history  Pablo Tassi PAT (EDF-LNHE)
!+        12/02/2013
!+        V6P3
!+ Settling lag: determines choice between Rouse and Miles concentration profile
!+ (by Michiel Knaapen HRW)
!
!history  J-M HERVOUET (EDF-LAB, LNHE)
!+        11/09/2015
!+        V7P1
!+ Arrays of size MAXFRO now allocatable.
!
!history  R KOPMANN (BAW)
!+        10/05/2016
!+        V7P2
!+ CALFA,SALFA dependent of grain classes
!
!history  R. KOPMANN (BAW)
!+        13/07/2016
!+        V7P2
!+        Integrating liquid boundary file for QS
!
!history  R.KOPMANN (BAW)
!+        07/12/2017
!+        V7P2
!+   VSPRES results file for CVSM handled by CAS-file.
!
!history  B.GLANDER (BAW)
!+        05/11/2018
!+        V7P2
!+  NEW VARIABLE: ZRL  REFERENCE LEVEL FOR NESTOR
!
!history  R.KOPMANN (BAW)
!+        15/02/2019
!+        V7P2
!+  NEW VARIABLES: VOLNESTORCL,VOLNESTORCLA,VOLINI,VCUMUCL,RMASCL
!+  for mass balance per class including Nestor changes
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
!
!       NOTE: THIS MODULE IS ORGANISED IN 10 PARTS
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      USE bief_def
!
!       NOTE: THIS MODULE IS ORGANISED IN 10 PARTS
!
!       1) VECTORS (WILL BE DECLARED AS BIEF_OBJ STRUCTURES)
!       2) MATRICES (WILL BE DECLARED AS BIEF_OBJ STRUCTURES)
!       3) BLOCKS (WILL BE DECLARED AS BIEF_OBJ STRUCTURES)
!       4) INTEGERS
!       5) LOGICAL VALUES
!       6) REALS
!       7) STRINGS
!       8) SLVCFG STRUCTURES
!       9) MESH STRUCTURE
!      10) ALIASES
!
!-----------------------------------------------------------------------
!
!       1) VECTORS
!
!-----------------------------------------------------------------------
!
!     EVOLUTION
!
      TYPE(bief_obj), TARGET :: e
!
!     EVOLUTION SAVED FOR CONSTANT FLOW DISCHARGE
!
      TYPE(bief_obj), TARGET :: ecpl
!
!     FREE SURFACE ELEVATION
!
      TYPE(bief_obj), TARGET :: z
!
!     INCREMENT OF FREE SURFACE ELEVATION WHEN READING AN HYDRO FILE
!
      TYPE(bief_obj), TARGET :: del_z
!
!     EVOLUTION DUE TO BEDLOAD
!
      TYPE(bief_obj), TARGET :: zf_c
!
!     EVOLUTION DUE TO SUSPENSION
!
      TYPE(bief_obj), TARGET :: zf_s
!
!     CUMULATED BED EVOLUTION
!
      TYPE(bief_obj), TARGET :: esomt
!
!     MAXIMUM EVOLUTION
!
      TYPE(bief_obj), TARGET :: emax
!
!     COMPONENTS OF DEPTH-AVERAGED FLOW RATE
!
      TYPE(bief_obj), TARGET :: qu
!
!     COMPONENTS OF DEPTH-AVERAGED FLOW RATE
!
      TYPE(bief_obj), TARGET :: qv
!
!     INCREMENTS OF FLOW RATE COMPONENTS WHEN READING AN HYDRO FILE
!
      TYPE(bief_obj), TARGET :: del_qu
!
!     INCREMENTS OF FLOW RATE COMPONENTS WHEN READING AN HYDRO FILE
!
      TYPE(bief_obj), TARGET :: del_qv
! JWI 31/05/2012 - added lines to include wave orbital velocities
!
      TYPE(bief_obj), TARGET :: del_uw
! JWI END
!
!     FLOW RATE
!
      TYPE(bief_obj), TARGET :: q
!
!     SOLID DISCHARGE
!
      TYPE(bief_obj), TARGET :: qs
!
!     SOLID DISCHARGE ,ALONG X AND Y
!
      TYPE(bief_obj), TARGET :: qsx,qsy
!
!     SOLID DISCHARGE (BEDLOAD)
!
      TYPE(bief_obj), TARGET :: qs_c
!
!     SOLID DISCHARGE (BEDLOAD), ALONG X AND Y
!
      TYPE(bief_obj), TARGET :: qsxc,qsyc
!
!     SOLID DISCHARGE (SUSPENSION)
!
      TYPE(bief_obj), TARGET :: qs_s
!
!     SOLID DISCHARGE (SUSPENSION), ALONG X AND Y
!
      TYPE(bief_obj), TARGET :: qsxs,qsys
!
!     WATER DEPTH
!
      TYPE(bief_obj), TARGET :: hn
!
!     DEPTH AFTER CLIPPING
!
      TYPE(bief_obj), TARGET :: hclip
!
!     COMPONENTS OF DEPTH-AVERAGED VELOCITY
!
      TYPE(bief_obj), TARGET :: u2d,v2d
!
!     FLOW INTENSITY
!
      TYPE(bief_obj), TARGET :: unorm
!
!     WATER DEPTH SAVED FOR CONSTANT FLOW DISCHARGE
!
      TYPE(bief_obj), TARGET :: hcpl
!
!     IMPOSED BED EVOLUTION AT THE BOUNDARY
!
      TYPE(bief_obj), TARGET :: ebor
!
!     IMPOSED SOLID TRANSPORT AT THE BOUNDARY
!     QBOR : IN M3/S, FOR EVERY CLASS
!     Q2BOR: IN M2/S, TOTAL, READ IN THE BOUNDARY CONDITIONS FILE
!
      TYPE(bief_obj), TARGET :: qbor,q2bor
!
!     ZF VALUES ON BOUNDARIES
!
      TYPE(bief_obj), TARGET :: flbor
!
!     BOTTOM ELEVATION
!
      TYPE(bief_obj), TARGET :: zf
!
!     NON ERODABLE (RIGID) BOTTOM ELEVATION
!
      TYPE(bief_obj), TARGET :: zr
!
!     REFERENCE ELEVATION
!
      TYPE(bief_obj), TARGET :: zref
!
!     INTEGRAL OF BASES
!
      TYPE(bief_obj), TARGET :: volu2d
!
!     INTEGRAL OF BASES IN PARALLEL
!
      TYPE(bief_obj), TARGET :: v2dpar
!
!     INVERSE OF INTEGRAL OF BASES
!
      TYPE(bief_obj), TARGET :: unsv2d
!
!     BOTTOM FRICTION COEFFICIENT (CHEZY, NIKURADSE OR STRICKLER)
!
      TYPE(bief_obj), TARGET :: chestr
!
!     ANGLE BETWEEN QS AND Q
!
      TYPE(bief_obj), TARGET :: calfa_cl
!
!     ANGLE BETWEEN QS AND Q
!
      TYPE(bief_obj), TARGET :: salfa_cl
!
!     CURVE RADIUS FOR SECONDARY CURRENTS
!
      TYPE(bief_obj), TARGET :: radsec
!
!     VOID STRUCTURE
!
      TYPE(bief_obj), TARGET :: s
!
!     MASK ON POINTS
!
      TYPE(bief_obj), TARGET :: maskpt
!
!     MASK
!
      TYPE(bief_obj), TARGET :: masktr
!
!     MASK
!
      TYPE(bief_obj), TARGET :: maskb
!
!     MASK
!
      TYPE(bief_obj), TARGET :: maskel
!
!     MASK
!
      TYPE(bief_obj), TARGET :: msktmp
!
!     WORKING ARRAYS
!
      TYPE(bief_obj), TARGET :: w1
!
! WAVE DATA
! --------
!
!     WAVE DIRECTION (DEG WRT OX AXIS)    !!!!!SOME SAY OY AXIS!!!!!
!
      TYPE(bief_obj), TARGET :: thetaw
!
!     FRICTION COEFFICIENT (WAVES)
!
      TYPE(bief_obj), TARGET :: fw
!
!     ORBITAL VELOCITY
!
      TYPE(bief_obj), TARGET :: uw
!
!     SIGNIFICANT WAVE HEIGHT
!
      TYPE(bief_obj), TARGET :: hw
!
!     MEAN WAVE PERIOD
!
      TYPE(bief_obj), TARGET :: tw
!
!
!
      TYPE(bief_obj), TARGET :: indic,ifamas
!
!     INTEGER WORKING ARRAYS
!
      TYPE(bief_obj), TARGET :: it1,it2,it3,it4
!
!     TYPE OF BOUNDARY CONDITIONS ON BED EVOLUTION
!
      TYPE(bief_obj), TARGET :: liebor
!
!     TYPE OF BOUNDARY CONDITIONS ON SAND TRANSPORT RATE
!
      TYPE(bief_obj), TARGET :: liqbor
!
!     TYPE OF BOUNDARY CONDITIONS
!
      TYPE(bief_obj), TARGET :: limtec
!
!     IMPACT OF THE SLOPE EFFECT ON AMPLITUDE
!
      TYPE(bief_obj), TARGET :: coefpn
!
!     LIQUID BOUNDARY NUMBERING
!
      TYPE(bief_obj), TARGET :: numliq
!
!     SHEAR STRESS
!
      TYPE(bief_obj), TARGET :: tob
!
!     FRICTION COEFFICIENT
!
      TYPE(bief_obj), TARGET :: cf
!
!     WAVE INDUCED SHEAR STRESS
!
      TYPE(bief_obj), TARGET :: tobw
!
!     rapport entre la contrainte de frottement de peau et la contrainte totale
!
      TYPE(bief_obj), TARGET :: mu
!
!     rugosite totale
!
      TYPE(bief_obj), TARGET :: ks
!
!     rugosite de peau
!
      TYPE(bief_obj), TARGET :: ksp
!
!     rugosite de ride
!
      TYPE(bief_obj), TARGET :: ksr
!
!     BED LEVEL CHANGE FOR GRAIN-FEEDING
!
      TYPE(bief_obj), TARGET :: dzf_gf
!
!     MEAN DIAMETER OF ACTIVE-LAYER
!
      TYPE(bief_obj), TARGET :: acladm
!
!     MEAN DIAMETER OF UNDER-LAYER
!
      TYPE(bief_obj), TARGET :: unladm
!
!     NUMBER OF LAYERS FOR EACH POINT
!
      TYPE(bief_obj), TARGET :: nlayer
!
!     HIDING FACTOR FOR PARTICULAR SIZE CLASS
!
      TYPE(bief_obj), TARGET :: hiding
!
!
!
      TYPE(bief_obj), TARGET :: elay
!
!     ACTIVE STRATUM THICKNESS
!
      TYPE(bief_obj), TARGET :: estrat
!
!     DEPOSITION FLUX
!
      TYPE(bief_obj), TARGET :: fludp
!
!     DEPOSITION FLUX
!
      TYPE(bief_obj), TARGET :: fludpt
!
!     EROSION FLUX
!
      TYPE(bief_obj), TARGET :: fluer
!
!     EROSION FLUX
!
      TYPE(bief_obj), TARGET :: fluert
!
!     CONCENTRATION AT TIME N
!
      TYPE(bief_obj), TARGET :: cs

!     MAK CHANGE create parameter for ratio depth averaged and reference concentration.
!     TYPE(BIEF_OBJ), TARGET :: CST, CTILD, CSTAEQ
      TYPE(bief_obj), TARGET :: cst, ctild, cstaeq, csratio
!
!     IMPOSED SUSPENDED SAND CONCENTRATION AT THE BOUNDARY (DIM.NPTFR)
!
      TYPE(bief_obj), TARGET :: cbor
!
!     CONCENTRATION IN G/L
!
      TYPE(bief_obj), TARGET :: csgl
!
!     COMPONENTS OF VELOCITY VECTORS
!
      TYPE(bief_obj), TARGET ::  uconv,vconv
!
!     PROPAGATION HEIGHT
!
      TYPE(bief_obj), TARGET :: hprop
!
!
!
      TYPE(bief_obj), TARGET :: disp,disp_c
!
!     FLUX CONDITION NU DF/DN=AFBOR * F + BFBOR
!
      TYPE(bief_obj), TARGET :: afbor,bfbor
!
!     FLUX AT THE BOUNDARIES
!
      TYPE(bief_obj), TARGET :: flbor_sis
!
!     FLUX AT THE BOUNDARIES FOR TRACER
!
      TYPE(bief_obj), TARGET :: flbortra
!
!     BOUNDARY CONDITIONS FOR SEDIMENT                     : LICBOR
!     TYPES OF BOUNDARY CONDITIONS FOR H                   : LIHBOR
!     TYPES OF BOUNDARY CONDITIONS FOR PROPAGATION         : LIMPRO
!                    POINTS   :    .1:H  .2:U  .3:V
!                    SEGMENTS :    .4:H  .5:U  .6:V
!
!     TYPE OF BOUNDARY CONDITIONS ON SUSPENDED SAND CONCENTRATION
!
      TYPE(bief_obj), TARGET :: licbor
!
!     TYPE OF BOUNDARY CONDITIONS FOR H
!
      TYPE(bief_obj), TARGET :: lihbor
!
!     TYPE OF BOUNDARY CONDITIONS FOR PROPAGATION
!
      TYPE(bief_obj), TARGET :: limpro
!
!     TYPE OF BOUNDARY CONDITIONS FOR DIFFUSION
!
      TYPE(bief_obj), TARGET :: limdif
!
!     LAST COLUMN OF THE BOUNDARY CONDITION FILE
!
      TYPE(bief_obj), TARGET :: boundary_colour
!
!     BOUNDARY CONDITIONS FOR TRACER, U AND V (MODIFIED LITBOR, LIUBOR,LIVBOR)
!
      TYPE(bief_obj), TARGET :: clt,clu,clv
!
!     WORK ARRAYS FOR ELEMENTS
!
      TYPE(bief_obj), TARGET :: te1,te2,te3
!
!     COEFFICIENTS OF THE DISPERSION TENSOR (DIM. NPOIN)
!
      TYPE(bief_obj), TARGET :: kx,ky,kz
!
!     ARRAY SAYING WHETHER THE NON-ERODABLE BOTTOM HAS BEEN REACHED (VF)
!
      TYPE(bief_obj), TARGET :: breach
!
!     FOR MIXED SEDIMENTS
!
      TYPE(bief_obj), TARGET :: fluer_vase,toce_mixte,ms_sable,ms_vase
!
!     REFERENCE LEVEL FOR NESTOR
      TYPE(bief_obj),TARGET :: zrl
!
!
!-----------------------------------------------------------------------
!
!       2) MATRICES
!
!-----------------------------------------------------------------------
!
!     BOUNDARY MATRIX
!
      TYPE(bief_obj), TARGET :: mbor
!
!     MATRICES
!
      TYPE(bief_obj), TARGET :: am1_s,am2_s
!
!-----------------------------------------------------------------------
!
!       3) BLOCKS
!
!-----------------------------------------------------------------------
!
!     BLOCK OF MASKS
!
      TYPE(bief_obj), TARGET :: mask
!
!     BLOCKS OF WORKING ARRAYS
!
      TYPE(bief_obj), TARGET :: tb,tb2
!
!     BLOCK OF PRIVATE VECTORS
!
      TYPE(bief_obj), TARGET :: prive
!
!     BLOCK OF DIFFERENTIATED VECTORS
!
      TYPE(bief_obj), TARGET :: advar
!
!     BLOCK OF CLANDESTINE VARIABLES
!
      TYPE(bief_obj), TARGET :: varcl
!
!     BLOCK OF VARIABLES FOR INPUT
!
      TYPE(bief_obj), TARGET :: varhyd
!
!     BLOCK OF VARIABLES FOR OUTPUT
!
      TYPE(bief_obj), TARGET :: varsor

! UHM / PAT

!     VERTICAL SORTING PROFILE: FRACTION FOR EACH LAYER, CLASS, POINT

      DOUBLE PRECISION,DIMENSION(:,:,:),TARGET,ALLOCATABLE::pro_f

!     VERTICAL SORTING PROFILE: DEPTH FOR EACH LAYER, CLASS, POINT

      DOUBLE PRECISION,DIMENSION(:,:,:),TARGET,ALLOCATABLE::pro_d

! UHM / PAT

!
!     SEDIMENT FRACTION FOR EACH LAYER, CLASS, POINT
!
      DOUBLE PRECISION,DIMENSION(:,:,:),TARGET,ALLOCATABLE::avail
!
!     LAYER THICKNESSES AS DOUBLE PRECISION
!
      DOUBLE PRECISION,DIMENSION(:,:),TARGET,ALLOCATABLE :: es
!
!     LAYER THICKNESSES OF THE MUD AS DOUBLE PRECISION
!
      DOUBLE PRECISION,DIMENSION(:,:),TARGET,ALLOCATABLE :: es_vase
!
!     LAYER THICKNESSES OF THE SAND AS DOUBLE PRECISION
!
      DOUBLE PRECISION,DIMENSION(:,:),TARGET,ALLOCATABLE :: es_sable
!
!     SEDIMENT COMPOSITION
!
      TYPE(bief_obj), TARGET :: avai
!
!     LAYER THICKNESSES
!
      TYPE(bief_obj), TARGET :: laythi
!
      TYPE(bief_obj), TARGET :: layconc
!
      TYPE(bief_obj), TARGET :: qscl
!
      TYPE(bief_obj), TARGET :: qscl_c
!
      TYPE(bief_obj), TARGET :: qsclxc, qsclyc
!
      TYPE(bief_obj), TARGET :: qscl_s
!
      TYPE(bief_obj), TARGET :: qsclxs, qsclys
!
      TYPE(bief_obj), TARGET :: zfcl
!
      TYPE(bief_obj), TARGET :: zfcl_c
!
      TYPE(bief_obj), TARGET :: zfcl_s
!
      TYPE(bief_obj), TARGET :: zfcl_ms

!
      TYPE(bief_obj), TARGET :: mpm_aray
!
!     FLUX LIMITATION PER SEGMENT
!
      TYPE(bief_obj), TARGET :: flulim
!
!     FLUXES AT BOUNDARY FOR EVERY CLASS
!
      TYPE(bief_obj), TARGET :: flbcla
!
!     CV modifs V6P2 new variables for consolidation model
!
!     VOID INDEX OF BED LAYERS
!
      DOUBLE PRECISION,DIMENSION(:,:),TARGET,ALLOCATABLE::ivide
!
!     CONCENTRATION OF BED LAYER
!
      DOUBLE PRECISION,DIMENSION(:,:),TARGET,ALLOCATABLE::conc
!
!-----------------------------------------------------------------------
!
!       4) INTEGERS
!
!-----------------------------------------------------------------------
!
!      KEYWORDS AND PARAMETERS
!
!     Maximum Layer Number in a VERTICAL SORTING PROFILE FOR EACH POINT (UHM)
      INTEGER, ALLOCATABLE :: pro_max(:)
!
!      MAXIMUM NUMBER OF OUTPUT VARIABLES
!
      INTEGER, PARAMETER :: maxvar = 500
      INTEGER :: nvar_sis
!
!     MAXIMUM NUMBER OF (LIQUID BOUNDARIES, SOLID BOUNDARIES)
!
      INTEGER maxfro
!
!     NUMBER OF LIQUID BOUNDARIES
!
      INTEGER nfrliq
!
!     OPTION FOR THE DIFFUSION OF TRACER
!
      INTEGER opdtra
!
!     OPTION FOR THE DISPERSION
!
      INTEGER optdif
!
!     SUPG OPTION
!
      INTEGER optsup
!
!     NUMBER OF ITERATIONS WITH CONSTANT FLOW DISCHARGE
!
      INTEGER :: ncondis
!
!     LAW OF BOTTOM FRICTION
!
      INTEGER kfrot
!
!     BED-LOAD TRANSPORT FORMULA
!
      INTEGER icf
!
      INTEGER, TARGET :: npas
!
!     NUMBER OF TIDES OR FLOODS
!
      INTEGER nmaree
!
      INTEGER, TARGET ::  leopr
!
      INTEGER,TARGET ::  lispr
!
      INTEGER nvarcl
!
      INTEGER ielmt,ielmh_sis,ielmu_sis,ielmx
!
!     standard du fichier de geometrie
!
!     INTEGER STDGEO
!
!     INTEGER LOGDES ,LOGPRE
!
      INTEGER optban ,lvmac
!
!     HYDRODYNAMIC CODE
!
!     INTEGER HYDRO
!
!     MATRIX STORAGE
!
      INTEGER optass
!
!     NUMBER OF SUB-ITERATIONS
!
      INTEGER nsous
!
!
!
      INTEGER mardat(3),martim(3),produc
!
!     OPTION FOR THE TREATMENT OF NON ERODABLE BEDS
!
      INTEGER choix
!
      INTEGER ptinil,ptinig
!
!     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
!
!     NUMBER OF DIRECTIONS FOR DIFFERENTIATING in VECTOR MODES
!
      INTEGER ad_numofdir
!
!     COUPLING PERIOD
!
      INTEGER, TARGET :: percou
!
!     NUMERO DU PAS DE TEMPS
!
      INTEGER, TARGET :: lt
!
      INTEGER resol
!
!     FORMULA FOR DEVIATION
!
      INTEGER devia
!
!     FORMULA FOR SLOPE EFFECT
!
      INTEGER slopeff
!
! NON-EQUILIBRIUM BEDLOAD AND NON-UNIFORM BED MATERIA (BMD AND MGDL)
! --------
!
!     MAXIMUM NUMBER OF SIZE-CLASSES
!
      INTEGER, PARAMETER :: nsiclm = 10
!
!     NUMBER OF SIZE-CLASSES OF BED MATERIAL (LESS THAN 10)
!
      INTEGER, TARGET :: nsicla
!
!     MAXIMUM NUMBER OF LAYERS ON THE MESH
!
      INTEGER, PARAMETER :: nlaymax = 20
!
!     NUMBER OF BED LOAD MODEL LAYERS
!
      INTEGER nomblay
!
!     FORMULATION FOR THE HIDING FACTOR
!
      INTEGER hidfac
!
      INTEGER :: loadmeth
!
!     DEBUGGER
!
      INTEGER :: debug
!
!     REFERENCE CONCENTRATION FORMULA
!
      INTEGER :: icq
!
!     NUMBER OF CONTROL SECTIONS POINTS
!
      INTEGER ncp
!
!     ARRAY CONTAINING THE GLOBAL NUMBER OF THE POINTS IN THE CONTROL SECTIONS
!
      INTEGER, ALLOCATABLE :: ctrlsc(:)
!
!     COORDINATES OF THE ORIGIN
!
      INTEGER i_orig,j_orig
!
!     NUMBER OF LAYERS FOR CONSOLIDATION
!
      INTEGER ncouch_tass
!
!     SKIN FRICTION CORRECTION
!
      INTEGER icr
!
!     BED ROUGHNESS PREDICTOR OPTION
!
      INTEGER iks
!
!     CONSOLIDATION MODEL
!
      INTEGER itass
!
!     TREATMENT OF FLUXES AT THE BOUNDARIES
!
      INTEGER dirflu
!
!     NUMBER OF GIVEN SSOLID DISCHARGES GIVEN BY USER
!
      INTEGER nsoldis
!
!// UHM // For the Continous Vertical Sorting MODEL
!
!     Type of the Vertical Grain Sorting: Hirano Layers or Continous-VSM
!
      INTEGER vsmtype
!
!     Maximum Number of Profile SECTIONS
!
      INTEGER pro_max_max
!
!     Printout Period for Full Vertical Sorting Model: PRO_D & PRO_F
!
      INTEGER cvsmpperiod
!
!     CHOOSE POINTS or FULL MODEL AS PRINTOUT
!
      INTEGER cvsmoutput(100)    !Limited to 100 for no specific reason
!
!     CHOOSE A MODEL FOR ESTIMATION OF A DYNAMIC ACTIVE LAYER THICKNESS
!
      INTEGER alt_model
!
!     MAXIMUM NUMBER OF ITERATIONS FOR ADVECTION SCHEMES
!
      INTEGER maxadv
!
!     SCHEME OPTION FOR ADVECTION
!
      INTEGER optadv
!
!     NUMBER OF CORRECTIONS FOR DISTRIBUTIVE SCHEMES
!     NUMBER OF SUB-STEPS FOR DISTRIBUTIVE SCHEMES
!
      INTEGER nco_dist,nsp_dist
!
!-----------------------------------------------------------------------
!
!       5) LOGICAL VALUES
!
!-----------------------------------------------------------------------
!
!     USED IN FUNCTION CGL
!
      LOGICAL, ALLOCATABLE :: okcgl(:)
!
!     USED IN FUNCTION QGL!
!
      LOGICAL, ALLOCATABLE :: okqgl(:)
!
!     C-VSM WRITES OUT (OR NOT) IN THIS TIMESTEP
!
      LOGICAL :: cvsm_out !UHM

!     C-VSM_FULL WRITES OUT (OR NOT) EVER
!
      LOGICAL :: cvsm_out_full !UHM
!
!     GRAPHICAL OUTPUT
!
      LOGICAL :: sorleo(maxvar)
!
!     LISTING OUTPUT
!
      LOGICAL :: sorimp(maxvar)
!
!     MASKING
!
      LOGICAL :: msk
!
!     WRITES OUT (OR NOT)
!
      LOGICAL :: entet
!
!     RESOLUTION FOR SUSPENSION IS IMPLICIT (OR NOT)
!
      LOGICAL :: yasmi
!
!     SPHERICAL EQUATIONS (HARD-CODED)
!
      LOGICAL :: spheri
!
!     STEADY HYDRODYNAMICS
!
      LOGICAL :: perma
!
!     TIDAL FLATS
!
      LOGICAL :: bandec
!
!     WAVE EFFECT
!
      LOGICAL :: houle
!
!     FALL VELOCITY (PARTIALLY HARD-CODED)
!
      LOGICAL :: calwc
!
!     SHIELDS PARAMETER
!
      LOGICAL :: calac
!
!     BEDLOAD
!
      LOGICAL, TARGET :: charr
!
!     LOADING LAW USED OR NOT
!
      LOGICAL :: noequbed
!
!     FINITE VOLUMES
!
      LOGICAL :: vf
!
!     MASS-LUMPING
!
      LOGICAL :: lumpi
!
!     CONSTANT FLOW DISCHARGE
!
      LOGICAL :: lcondis
!
!     GRAIN-FEEDING
!
      LOGICAL :: lgrafed
!
!     CONSTANT ACTIVE LAYER THICKNESS
!
      LOGICAL :: const_alayer
!
!     SUSPENSION
!
      LOGICAL, TARGET :: susp
!
!     MASS BALANCE
!
      LOGICAL :: bilma
!
!     VALIDATION
!
      LOGICAL :: valid
!
!     IMPOSED CONCENTRATION IN INFLOW
!
      LOGICAL :: imp_inflow_c
!
!     SECONDARY CURRENTS
!
      LOGICAL :: seccurrent
!
!     SECONDARY CURRENTS RADII FILE
!
      LOGICAL :: havesecfile
!
!     MASS CONCENTRATIONS IN G/L
!
      LOGICAL :: unit
!
!     CORRECTION ON CONVECTION VELOCITY
!
      LOGICAL :: corr_conv
!
!     COMPUTATION CONTINUED
!
      LOGICAL :: debu
!
!     DIFFUSION OF SUSPENDED SEDIMENT CONCENTRATION
!
      LOGICAL :: dift
!
!     SEDIMENT SLIDE
!
      LOGICAL :: slide
!
!     COHESIVE SEDIMENTS (FOR EACH CLASS)
!
      LOGICAL :: sedco(nsiclm)
!
!     CONSOLIDATION TAKEN INTO ACCOUNT
!
      LOGICAL :: tass
!
!     MIXED SEDIMENTS
!
      LOGICAL :: mixte
!
!     COUPLING WITH NESTOR
!
      LOGICAL :: nestor
!
!     BED FRICTION PREDICTION
!
      LOGICAL :: kspred
!
!     Settling lag: determines choice between Rouse and Miles concentration profile
!     SET_LAG = TRUE : Miles
!             = FALSE: Rouse
!
      LOGICAL :: set_lag
!
!     STATIONARY MODE: calculate sediment transport without updating the bed.
!
      LOGICAL :: stat_mode
!
!     FLUXLINE
!
      LOGICAL :: doflux
!
!-----------------------------------------------------------------------
!
!       6) REALS
!
!-----------------------------------------------------------------------
!
      DOUBLE PRECISION rc
!
!     WATER DENSITY
!
      DOUBLE PRECISION xmve
!
!     SAND DENSITY
!
      DOUBLE PRECISION xmvs
!
!     COEFFICIENT FUNCTION OF THE POROSITY
!
      DOUBLE PRECISION, TARGET :: xkv
!
!     GRAVITY ACCELERATION
!
      DOUBLE PRECISION grav
!
      DOUBLE PRECISION sfon
!
!     FLOW VISCOSITY
!
      DOUBLE PRECISION vce
!
      DOUBLE PRECISION teta
!
!     MINIMAL VALUE OF THE WATER HEIGHT
!
      DOUBLE PRECISION hmin
!
      DOUBLE PRECISION beta
      DOUBLE PRECISION, TARGET :: delt
!
!     TIDAL PERIOD
!
      DOUBLE PRECISION pmaree
!
!     STARTING TIME OF THE HYDROGRAM
!
      DOUBLE PRECISION, TARGET ::  tprec
!
      DOUBLE PRECISION phi0
!
!     TIME STEP
!
      DOUBLE PRECISION, TARGET :: dt
!
!     CRITERION TO UPDATE THE FLOW (WITH CONSTANT FLOW DISCHARGE)
!
      DOUBLE PRECISION :: crit_cfd
!
      DOUBLE PRECISION :: fracsed_gf(nsiclm)
!
!     INITIAL SUSPENSION CONCENTRATIONS
!
      DOUBLE PRECISION :: cs0(nsiclm)
!
!     MASS EXCHANGED BY SOURCE TERM
!
      DOUBLE PRECISION massou
!
      DOUBLE PRECISION, TARGET :: csf_sable
!
!     SETTLING VELOCITIES
!
      DOUBLE PRECISION, TARGET :: xwc(nsiclm)
!
!     CRITICAL SHIELDS PARAMETER
!
      DOUBLE PRECISION, TARGET ::  ac(nsiclm)
!
!     TETA SUSPENSION
!
      DOUBLE PRECISION teta_susp
!
      DOUBLE PRECISION  xkx, xky
!
!     FRICTION ANGLE OF THE SEDIMENT
!
      DOUBLE PRECISION, TARGET :: phised
!
!     PARAMETER FOR DEVIATION
!
      DOUBLE PRECISION, TARGET :: beta2
!
!     HIDING FACTOR FOR PARTICULAR SIZE CLASS WHEN THE USER SUBROUTINE INIT_HIDING IS NOT USED
!
      DOUBLE PRECISION hidi(nsiclm)
!
!     D90
!
      DOUBLE PRECISION fd90(nsiclm)
!
!     SEDIMENT DIAMETERS
!
      DOUBLE PRECISION, TARGET ::  fdm(nsiclm)
!
!     INITIAL SEDIMENT COMPOSITION FOR PARTICULAR SIZE CLASS WHEN INIT_COMPO IS NOT USED
!
      DOUBLE PRECISION ava0(nsiclm)
!
!     WANTED ACTIVE LAYER THICKNESS; ELAYO=FIXED VALUE, ELAY=REAL VALUE FOR EACH POINT; WHEN ENOUGH SEDIMENT ELAY = ELAY0
!
      DOUBLE PRECISION elay0
!
!     TOTAL VOLUME OF SEDIMENT IN EACH CLASS
!
      DOUBLE PRECISION voltot(nsiclm)
!
!     INITIAL VOLUME OF SEDIMENT IN EACH CLASS
!
      DOUBLE PRECISION volini(nsiclm)
!
!     CUMULATED NESTOR VOLUME PER CLASS
!
      DOUBLE PRECISION volnestorcl(nsiclm)
!
!     NESTOR VOLUME PER CLASS AND TIME STEP
!
      DOUBLE PRECISION volnestorcla(nsiclm)
!
!     CUMULATED VOLUME OF FLUXES OVER BOUNDARIES PER CLASS
!
      DOUBLE PRECISION vcumucl(nsiclm)
!
!     CUMULATED VOLUME OF EVOLUTION PER CLASS
!
      DOUBLE PRECISION rmascl(nsiclm)
!
!     CRITICAL SHEAR VELOCITY FOR MUD DEPOSITION
!
      DOUBLE PRECISION :: vitcd
!
!     CRITICAL EROSION SHEAR VELOCITY OF THE MUD
!
      DOUBLE PRECISION :: vitce
!
!     SUSPENDED MASS BALANCE
!
      DOUBLE PRECISION :: mased0(nsiclm)
!
!     SUSPENDED MASS BALANCE
!
      DOUBLE PRECISION :: masini(nsiclm)
      DOUBLE PRECISION :: masten(nsiclm),mastou(nsiclm)
      DOUBLE PRECISION :: mastcp(nsiclm),masfin(nsiclm)
      DOUBLE PRECISION :: masdep(nsiclm),masdept(nsiclm)
!
!     FOR MASS BALANCE OF COHESIVE SEDIMENT AND MIXTE
!
      DOUBLE PRECISION :: masvt,masv0,masst,mass0
!
!     FOR NON-EQUILIBIRUM BEDLOAD
!
      DOUBLE PRECISION :: ls0
!
!     RATIO BETWEEN SKIN FRICTION AND MEAN DIAMETER
!
      DOUBLE PRECISION, TARGET :: kspratio
!
!     KARIM, HOLLY & YANG CONSTANT
!
      DOUBLE PRECISION :: karim_holly_yang
!
!     KARMAN CONSTANT
!
      DOUBLE PRECISION :: karman
!
!     PARTHENIADES CONSTANT
!
      DOUBLE PRECISION, TARGET :: partheniades
!
!     MAXIMUM CONCENTRATION
!
      DOUBLE PRECISION :: cmax
!
!     PI
!
      DOUBLE PRECISION :: pi
!
!     Meyer Peter Mueller-Coefficient
!
      DOUBLE PRECISION, TARGET :: mpm
!
!     Secondary Current Alpha Coefficient
!
      DOUBLE PRECISION, TARGET :: alpha
!
!     Morphological Factor
!
      DOUBLE PRECISION :: mofac
!
!     ZERO OF THE CODE
!
      DOUBLE PRECISION :: zero
!
!     B VALUE FOR THE BIJKER FORMULA
!
      DOUBLE PRECISION :: bijk
!
!     MUD CONCENTRATION AT BOUNDARIES FOR EACH CLASS
!
      DOUBLE PRECISION, ALLOCATABLE, TARGET :: cbor_classe(:)
!
!     MUD CONCENTRATION FOR EACH LAYER (Constant)
!
      DOUBLE PRECISION :: conc_vase(nlaymax)
!
!     MASS TRANSFER BETWEEN LAYERS
!
      DOUBLE PRECISION :: trans_mass(nlaymax)
!
!     CRITICAL EROSION SHEAR STRESS OF THE MUD PER LAYER
!
      DOUBLE PRECISION :: toce_vase(nlaymax)
!
!     CRITICAL EROSION SHEAR STRESS OF THE SAND
!
      DOUBLE PRECISION :: toce_sable
!
!     THIEBOT MODEL
!
      DOUBLE PRECISION :: conc_gel, coef_n,conc_max
!
!     PRESCRIBED SOLID DISCHARGES
!
      DOUBLE PRECISION, ALLOCATABLE :: soldis(:)
!
!     FOR MASS BALANCE OF COHESIVE SEDIMENT
!
      DOUBLE PRECISION :: masbed0,masbed
!
!     MINIMUM DEPTH FOR BEDLOAD
!
      DOUBLE PRECISION :: hmin_bedload
!
!     SAND FRACTION
!
      DOUBLE PRECISION, ALLOCATABLE :: sanfra(:)
!
!-----------------------------------------------------------------------
!
!       7) STRINGS
!
!-----------------------------------------------------------------------
!
!
      CHARACTER(LEN=72) titca,sortis,varim
!
      CHARACTER(LEN=3) bingeosis,binpresis,binhydsis
!
      CHARACTER(LEN=3) binressis,binrefsis
!
!     FOR CLANDESTINE VARIABLES
!
      CHARACTER(LEN=32) varcla(nsiclm),texte(maxvar),textpr(maxvar)
!
!     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)
!
!     EQUATION SOLVED
!
      CHARACTER(LEN=20) equa
!
!     MNEMO OF VARIABLES FOR GRAPHIC PRINTOUTS (B FOR BOTTOM, ETC.)
!
      CHARACTER(LEN=8) mnemo(maxvar)
!
      CHARACTER(LEN=PATH_LEN) couplingsis
!
!-----------------------------------------------------------------------
!
!       8) SLVCFG STRUCTURES
!
!-----------------------------------------------------------------------
!
      TYPE(slvcfg) :: slvsed
!
      TYPE(slvcfg) :: slvtra
!
!-----------------------------------------------------------------------
!
!       9) MESH STRUCTURE
!
!-----------------------------------------------------------------------
!
!     MESH STRUCTURE
!
      TYPE(bief_mesh),TARGET :: mesh
!
!-----------------------------------------------------------------------
!
!      10) ALIASES
!
!-----------------------------------------------------------------------
!
!     DECLARATION OF POINTERS FOR ALIASES
!     TARGETS ARE DEFINED IN POINT_TELEMAC2D
!
!     ALIASES FOR WORK VECTORS IN TB
!
      TYPE(bief_obj),POINTER :: t1,t2,t3,t4,t5,t6,t7,t8,t9,t10,t11,t12
      TYPE(bief_obj),POINTER :: t13,t14
!
!
!     USEFUL COMPONENTS IN STRUCTURE MESH
!
!
!     CONNECTIVITY TABLE
!
      TYPE(bief_obj),   POINTER :: ikle
!
!     2D COORDINATES OF THE MESH
!
      DOUBLE PRECISION, DIMENSION(:), POINTER :: x,y
!
!     NUMBER OF ELEMENTS IN THE MESH
!
      INTEGER, POINTER:: nelem
!
!     MAXIMUM NUMBER OF ELEMENTS IN THE MESH
!
      INTEGER, POINTER:: nelmax
!
!     NUMBER OF BOUNDARY POINTS, MAXIMUM NUMBER
!
      INTEGER, POINTER:: nptfr,nptfrx
!
      INTEGER, POINTER:: typelm
!
!     NUMBER OF 2D POINTS IN THE MESH
!
      INTEGER, POINTER:: npoin
!
      INTEGER, POINTER:: npmax
!
      INTEGER, POINTER:: mxptvs
!
      INTEGER, POINTER:: mxelvs
!
      INTEGER, POINTER:: lv
!
!-----------------------------------------------------------------------
!
!      11) SISYPHE FILES + INTEGER DECLARATION FOR MED APPROACH
!
!-----------------------------------------------------------------------
!
!     MAXIMUM RANK OF LOGICAL UNITS AS DECLARED IN SUBMIT STRINGS IN THE DICTIONARY
!
      INTEGER, PARAMETER :: maxlu_sis = 46
!
!     FOR STORING INFORMATION ON FILES
!
      TYPE(bief_file), TARGET :: sis_files(maxlu_sis)
!
!     VARIOUS FILES RANKS, WHICH ARE ALSO LOGICAL UNITS IF NO COUPLING
!
      INTEGER, TARGET :: sisres,sisref,sispre
      INTEGER, TARGET :: sishyd,siscou,sisgeo,siscli,siscas
      INTEGER sisfon,sissec,sisseo,sisliq,sisflx
      INTEGER sinact, sinpol, sinref, sinrst    ! nestor
      INTEGER vspres

!-----------------------------------------------------------------------
!
!      12) SECTIONS
!
!-----------------------------------------------------------------------
!
      type(chain_type), ALLOCATABLE :: chain(:)
!
!     SAVED VARIABLE
!
      ! fluxpr_sisyphe
      DOUBLE PRECISION, ALLOCATABLE :: work(:),workb(:)
      LOGICAL :: init_fluxpr=.true.
      ! read_fic_conc
      INTEGER, PARAMETER :: maxval_rfc=50
      INTEGER nvalue_rfc,nlig_rfc,il1_rfc,il2_rfc
      DOUBLE PRECISION tl1_rfc,tl2_rfc,lastat_rfc
      DOUBLE PRECISION, DIMENSION(:,:), ALLOCATABLE :: infic_rfc
      DOUBLE PRECISION, DIMENSION(:)  , ALLOCATABLE :: time_rfc
      CHARACTER(LEN=8) choix_rfc(maxval_rfc),lastwhat_rfc
      LOGICAL :: deja_rfc = .false.
      !LEO new variable for node_Depth of sisyphe
      DOUBLE PRECISION, ALLOCATABLE, TARGET :: tds_sis_node_depth(:)
      DOUBLE PRECISION, ALLOCATABLE,
     &         TARGET :: tds_node_sediment_fraction(:,:)
      DOUBLE PRECISION, ALLOCATABLE, TARGET :: tds_hn(:)
      ! sisyphe
      DOUBLE PRECISION :: vcumu! FOR THE BALANCE
      DOUBLE PRECISION :: mass_gf! FOR GRAIN-FEEDING
      LOGICAL :: pass,pass_susp ! IDENTIFIES 1ST TIMESTEP
      INTEGER :: nidt, ncalcu, numen, nit, valnit !
      DOUBLE PRECISION :: at0 ! TIME
      ! flusec_sisyphe
      LOGICAL :: deja_flusec = .false.
      INTEGER, ALLOCATABLE :: nseg(:),liste(:,:,:)
      DOUBLE PRECISION, ALLOCATABLE :: volnegs(:),volposs(:)
      DOUBLE PRECISION, ALLOCATABLE :: volnegc(:),volposc(:)
      DOUBLE PRECISION, ALLOCATABLE :: flx(:),volneg(:),volpos(:)
      DOUBLE PRECISION, ALLOCATABLE :: flxs(:),flxc(:)
      LOGICAL :: old_method_flusec=.false.
      ! flusec_sis
      TYPE fluxline
        INTEGER, ALLOCATABLE :: sectionids(:)
        INTEGER, ALLOCATABLE :: direction(:)
        INTEGER              :: nofsections
      END TYPE fluxline
!
      LOGICAL :: deja_flusec2 = .false.
      TYPE(fluxline), ALLOCATABLE :: fluxlinedata_flusec2(:)
      DOUBLE PRECISION, ALLOCATABLE :: flux_flusec2(:,:)
      DOUBLE PRECISION, ALLOCATABLE :: volflux_flusec2(:,:)
      INTEGER :: numberoflines_flusec2
      DOUBLE PRECISION time_flusec2
!
      SAVE
!

      END MODULE declarations_sisyphe