declarations_artemis.f

Go to the documentation of this file.

!                   ***************************
                    MODULE declarations_artemis
!                   ***************************
!
!
!***********************************************************************
! ARTEMIS   V8P2
!***********************************************************************
!
!brief    DECLARATION OF PRINICIPAL ARTEMIS VARIABLES
!
!history  J-M HERVOUET (LNH)
!+
!+
!+   LINKED TO BIEF 5.0
!
!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  C.PEYRARD(EDF)
!+        2011
!+        V6P1
!+        VARIABLES FOR RAPIDLY VARYING TOPOGRAPHY ADDED
!
!history  C.PEYRARD(EDF)
!+        2012
!+        V6P2
!+        VARIABLES FOR INCIDENT POTENTIAL ADDED
!
!history  C.PEYRARD(EDF)
!+        2013
!+        V6P3
!+        VARIABLES FOR CURRENT ADDED
!
!history  C.PEYRARD(EDF)
!+        2014
!+        V7P0
!+        VARIABLES FOR AUTOMATIC TETAP CALCULATION ADDED
!+        VARIABLES FOR AUTOMATIC PHASE CALCULATION ADDED
!
!history  N.DURAND (HRW)
!+        November 2016
!+        V7P2
!+   New variables introduced for use in LECLIM call : ALFAPS and HBS
!+   These and TETAPS store parameters read from the cli file (RP also
!+   read in but does not require a temporary storage variable for it)
!
!history  N.DURAND (HRW)
!+        November 2016
!+        V7P2
!+   Addition of new keywords in the steering file re: animation of the
!+   free surface. ANIMFS and ARTAMP declared
!
!history  N.DURAND (HRW)
!+        August 2017
!+        V7P3
!+   1. Consolidation with CHAINTWC, meaning that it is now a choice of integers
!+   and no longer a logical
!+   2. NDTWC (now NDIR) and NFTWC (now NF) are no longer read in the
!+   steering file but directly extracted from the spectrum file
!+   3. Declaration of new structure type: SPECTRUM
!+   4. PI (and related variables) now defined here and in ARTEMIS_CONSTANTS
!+   5. Addition of new keywords in the steering file for nesting option 2:
!+   X_SFREF, Y_SFREF, ART_FILES(WACRES)%NAME, and related variables
!+   6. Introduction of BDALE, block holding spatially varying DALEs for
!+   incident boundary nodes and for nesting option 2
!+   7. Addition of IPTFR_REF, the node number for the reference spectrum
!
!history  N.DURAND (HRW)
!+        December 2018
!+        V8P0
!+   Addition of new keywords in the steering file for nesting option 2:
!+   ART_FILES(WACLQD)%NAME
!
!history  N.DURAND (HRW)
!+        January 2019
!+        V8P0
!+   TYPE SPECTRUM MIGRATED TO BIEF_DEF
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      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
!
!-----------------------------------------------------------------------
!
!brief REAL PART OF WAVE POTENTIAL
! partie reelle du potentiel
      TYPE(bief_obj), TARGET :: phir
!brief IMAGINARY PART OF WAVE POTENTIAL
! partie imaginaire du potentiel
      TYPE(bief_obj), TARGET :: phii
!brief WATER DEPTH AT REST
! hauteur d'eau au repos
      TYPE(bief_obj), TARGET :: h
!brief (MEAN) WAVE NUMBER
! nombre d'onde
      TYPE(bief_obj), TARGET :: k
!brief (MEAN) PHASE CELERITY
! vitesse de phase
      TYPE(bief_obj), TARGET :: c
!brief (MEAN) GROUP CELERITY
! vitesse de groupe
      TYPE(bief_obj), TARGET :: cg
!brief SIGNIFICANT WAVE HEIGHT (REGULAR MODE)
! hauteur de la houle
      TYPE(bief_obj), TARGET :: hho
!brief WAVE PHASE (REGULAR MODE)
! phase de la houle
      TYPE(bief_obj), TARGET :: phas
!brief SURFACE WAVE VELOCITY COMPONENT
! vitesse en surface (a t=0)
      TYPE(bief_obj), TARGET :: u0
!brief SURFACE WAVE VELOCITY COMPONENT
! vitesse en surface (a t=0)
      TYPE(bief_obj), TARGET :: v0
!brief MEAN COSINE OF WAVE DIRECTION
! moyennes des cosinus de la direction de houle
      TYPE(bief_obj), TARGET :: mcos
!brief MEAN SINE OF WAVE DIRECTION
! moyennes des sinus de la direction de houle
      TYPE(bief_obj), TARGET :: msin
!brief WAVE INCIDENCE (OR DIRECTION)
! incidence de la houle
      TYPE(bief_obj), TARGET :: inci
!brief FREE SURFACE ELEVATION
! cote de la surface libre
      TYPE(bief_obj), TARGET :: s
!brief BOTTOM ELEVATION
! cote du fond
      TYPE(bief_obj), TARGET :: zf
!brief FRICTION FACTOR
! coefficient de frottement (variable en espace)
      TYPE(bief_obj), TARGET :: fw
!brief WAVE HEIGHT (RANDOM WAVE)
! hauteur de la houle aleatoire
      TYPE(bief_obj), TARGET :: hale
!brief WAVE PERIODS ARRAY (RANDOM MODE)
! tableau des periodes de discretisation du spectre pour un calcul en houle aleatoire multidirectionnelle
      TYPE(bief_obj), TARGET :: pale
!brief REFLEXION COEFFICIENT
! coefficient de reflexion des parois
      TYPE(bief_obj), TARGET :: rp
!brief ANGLE OF WAVE ATTACK (FROM NORMAL AXIS)
! angle d'attaque de la houle sur les limites - pas seulement les parois (compte par rapport a a la normale , inclut dans [0;90])
      TYPE(bief_obj), TARGET :: tetap
!brief DEPHASING CAUSED BY THE WALLS
! dephasage induit par la paroi entre l'onde reflechie et l'onde incidente (si alfap est positif, l'onde reflechie est en retard)
      TYPE(bief_obj), TARGET :: alfap
!brief INCIDENT WAVE HEIGHT AT THE BOUNDARY
! hauteur de la houle aux frontieres ouvertes
      TYPE(bief_obj), TARGET :: hb
!brief INCIDENT WAVE DIRECTION AT THE BOUNDARY (FROM X AXIS)
! angle d'attaque de la houle aux frontieres ouvertes (compte par rapport a l'axe des x dans le sens direct)
      TYPE(bief_obj), TARGET :: tetab
!brief REAL PART OF INCIDENT WAVE AT THE BOUNDARY
! partie reelle du potentiel impose au bord (dirichlet)
      TYPE(bief_obj), TARGET :: phirb
!brief IMAGINARY PART OF INCIDENT WAVE AT THE BOUNDARY
! partie imaginaire du potentiel impose au bord (dirichlet)
      TYPE(bief_obj), TARGET :: phiib

!brief REAL PART OF INCIDENT POTENTIAL AT THE BOUNDARY
! partie reelle du potentiel incident au bord
      TYPE(bief_obj), TARGET :: prb
!brief IMMAGINARY PART OF INCIDENT POTENTIAL AT THE BOUNDARY
! partie imaginaire du potentiel incident au bord
      TYPE(bief_obj), TARGET :: pib
!brief REAL PART OF GRADIENT X COMPONENT OF INCIDENT POTENTIAL AT THE BOUNDARY
! partie reele du gradient en X du potentiel incident au bord
      TYPE(bief_obj), TARGET :: ddxprb
!brief REAL PART OF GRADIENT Y COMPONENT OF INCIDENT POTENTIAL AT THE BOUNDARY
! partie reele du gradient en Y du potentiel incident au bord
      TYPE(bief_obj), TARGET :: ddyprb
!brief IMMAGINARY PART OF GRADIENT X COMPONENT OF INCIDENT POTENTIAL AT THE BOUNDARY
! partie imaginaire du gradient en X du potentiel incident au bord
      TYPE(bief_obj), TARGET :: ddxpib
!brief IMMAGINARY PART OF GRADIENT Y COMPONENT OF INCIDENT POTENTIAL AT THE BOUNDARY
! partie imaginaire du gradient en Y du potentiel incident au bord
      TYPE(bief_obj), TARGET :: ddypib
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: aphi1b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: bphi1b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: cphi1b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: dphi1b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: cgrx1b
      TYPE(bief_obj), TARGET :: cgry1b
      TYPE(bief_obj), TARGET :: dgrx1b
      TYPE(bief_obj), TARGET :: dgry1b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: aphi2b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: bphi2b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: cphi2b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: dphi2b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: aphi3b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: bphi3b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: cphi3b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: dphi3b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: aphi4b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: bphi4b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: cphi4b
!brief COEFFICIENT FOR BOUNDARY CONDITIONS
! coefficient pour les conditions aux limites
      TYPE(bief_obj), TARGET :: dphi4b
!brief STORAGE OF ANGLE OF WAVE ATTACK (FROM NORMAL AXIS) FOR LECLIM
! angle d'attaque de la houle sur les limites - pas seulement les parois (compte par rapport a a la normale , inclut dans [0;90])
      TYPE(bief_obj), TARGET :: tetaps
!brief STORAGE OF DEPHASING CAUSED BY THE WALLS FOR LECLIM
! dephasage induit par la paroi entre l'onde reflechie et l'onde incidente (si alfap est positif, l'onde reflechie est en retard)
      TYPE(bief_obj), TARGET :: alfaps
!brief STORAGE OF INCIDENT WAVE HEIGHT AT THE BOUNDARY FOR LECLIM
! hauteur de la houle aux frontieres ouvertes
      TYPE(bief_obj), TARGET :: hbs
!brief ANGLE OF WAVE ATTACK - IN LOOP STORAGE (FROM NORMAL AXIS)
! angle d'attaque de la houle sur les limites - pas seulement les parois (compte par rapport a a la normale , inclut dans [0;90])
      TYPE(bief_obj), TARGET :: tetapm
!
!brief WORKING ARRAY
! tableau de travail
      TYPE(bief_obj), TARGET :: w1
!brief INTEGER WORKING ARRAY
!
      TYPE(bief_obj), TARGET :: it1
!brief INTEGER WORKING ARRAY
!
      TYPE(bief_obj), TARGET :: it2
!brief INTEGER WORKING ARRAY
!
      TYPE(bief_obj), TARGET :: it3
!brief VOID STRUCTURE
!
      TYPE(bief_obj), TARGET :: sbid
!brief RIGHT MEMBER OF SYSTEM TO BE SOLVED
!
      TYPE(bief_obj), TARGET :: cv1
!brief RIGHT MEMBER OF SYSTEM TO BE SOLVED
!
      TYPE(bief_obj), TARGET :: cv2
!brief WAVE DISSIPATION QUANTITY
! tableau pour la dissipation
      TYPE(bief_obj), TARGET :: mu
!brief WAVE DISSIPATION QUANTITY
! tableau pour la dissipation
      TYPE(bief_obj), TARGET :: mu2
!brief WAVE DISSIPATION QUANTITY
! tableau pour la dissipation
      TYPE(bief_obj), TARGET :: qb
!brief WAVE DISSIPATION QUANTITY
! tableau pour la dissipation
      TYPE(bief_obj), TARGET :: hmu
!brief WAVE DISSIPATION QUANTITY
! tableau pour la dissipation
      TYPE(bief_obj), TARGET :: hmuanc
!brief RADIATION STRESSES QUANTITY
! tableau pour les contraintes de radiation
      TYPE(bief_obj), TARGET :: sxx
!brief RADIATION STRESSES QUANTITY
! tableau pour les contraintes de radiation
      TYPE(bief_obj), TARGET :: sxy
!brief RADIATION STRESSES QUANTITY
! tableau pour les contraintes de radiation
      TYPE(bief_obj), TARGET :: syy
!brief RADIATION STRESSES QUANTITY
! tableau pour les contraintes de radiation
      TYPE(bief_obj), TARGET :: fx
!brief RADIATION STRESSES QUANTITY
! tableau pour les contraintes de radiation
      TYPE(bief_obj), TARGET :: fy
!brief MEAN WAVE PERIOD
! periode moyenne issue du moment d'ordre 1
      TYPE(bief_obj), TARGET :: t01
!brief MEAN WAVE PERIOD
! periode moyenne issue du moment d'ordre 2
      TYPE(bief_obj), TARGET :: t02
!brief MEAN WAVE PERIOD
! periode moyenne issue du moment d'ordre 1
      TYPE(bief_obj), TARGET :: tm
!brief WAVE DIRECTIONS AT THE BOUNDARY (RANDOM MODE)
!
      TYPE(bief_obj), TARGET :: dale
!brief WAVE DIRECTIONS AT THE BOUNDARY (RANDOM MODE)
! these vary spatially along the boundary
      TYPE(bief_obj), TARGET :: bdale
!brief PERIODS ASSOCIATED TO WAVE DIRECTIONS AT THE BOUNDARY (RANDOM MODE)
!
      TYPE(bief_obj), TARGET :: pdale
!brief BOUNDARY CONDITION TYPE
! type de conditions aux limites sur u
      TYPE(bief_obj), TARGET :: liubor
!brief BOUNDARY CONDITION TYPE
! type de conditions aux limites sur v
      TYPE(bief_obj), TARGET :: livbor
!brief BOUNDARY CONDITION TYPE
! type de conditions aux limites sur h
      TYPE(bief_obj), TARGET :: lihbor
!brief
!

! 'COLOUR' OF BOUNDARY NODES (TAKEN IN BOUNDARY CONDITIONS FILE)
      TYPE(bief_obj), TARGET :: boundary_colour
!brief
! 'BIDON INTEGER'
      TYPE(bief_obj), TARGET :: itb1
!brief
! 'BIDON REEL
      TYPE(bief_obj), TARGET :: tb1
!brief


      TYPE(bief_obj), TARGET :: numliq
!brief
!
      TYPE(bief_obj), TARGET :: lidir
!brief
!
      TYPE(bief_obj), TARGET :: maskel
!brief MASKS FOR BOUNDARY NODES, CORRESPONDS TO INCIDENT WAVES (KINC)
! masque pour les points de bord
      TYPE(bief_obj), TARGET :: mask1
!brief MASKS FOR BOUNDARY NODES, CORRESPONDS TO FREE EXIT (KSORT)
! masque pour les points de bord
      TYPE(bief_obj), TARGET :: mask2
!brief MASKS FOR BOUNDARY NODES, CORRESPONDS TO SOLID BOUNDARY (KLOG)
! masque pour les points de bord
      TYPE(bief_obj), TARGET :: mask3
!brief MASKS FOR BOUNDARY NODES, CORRESPONDS TO IMPOSED WAVES (KENT)
! masque pour les points de bord
      TYPE(bief_obj), TARGET :: mask4
!brief MASKS FOR BOUNDARY NODES, CORRESPONDS TO INCIDENT POTENTIAL (KPOT)
! masque pour les points de bord
      TYPE(bief_obj), TARGET :: mask5


!brief FLOW
! CURRENT VELOCITY IN X IDRECTION
      TYPE(bief_obj), TARGET :: uc
!brief FLOW
! CURRENT VELOCITY IN Y IDRECTION
      TYPE(bief_obj), TARGET :: vc
!brief RELATIVE ANGULAR FREQUENCY
! RELATIVE PULSATION
      TYPE(bief_obj), TARGET :: wr
!brief table for wave-current interaction
! WAVE VECTOR COMPONENT X
      TYPE(bief_obj), TARGET :: kancx
!brief table for wave-current interaction
! WAVE VECTOR COMPONENT Y
      TYPE(bief_obj), TARGET :: kancy
!brief table for mean omega on the domain (from T01)
! MEAN OMEGA = 2 PI / T01
      TYPE(bief_obj), TARGET :: omegam
!brief table for bottom velocity in random waves
! BOTTOM VELOCITY (RANDOM SEAS)
      TYPE(bief_obj), TARGET :: ueb
!
!-----------------------------------------------------------------------
!
!       2) MATRICES
!
!-----------------------------------------------------------------------
!
!brief MATRICE FOR SYSTEM SOLVING
!
      TYPE(bief_obj), TARGET :: am1
!brief MATRICE FOR SYSTEM SOLVING
!
      TYPE(bief_obj), TARGET :: am2
!brief MATRICE FOR SYSTEM SOLVING
!
      TYPE(bief_obj), TARGET :: am3
!brief MATRICE FOR SYSTEM SOLVING
!
      TYPE(bief_obj), TARGET :: bm1
!brief MATRICE FOR SYSTEM SOLVING
!
      TYPE(bief_obj), TARGET :: bm2
!brief MATRICE FOR SYSTEM SOLVING
!
      TYPE(bief_obj), TARGET :: mbor
!
!-----------------------------------------------------------------------
!
!       3) BLOCKS
!
!-----------------------------------------------------------------------
!
!
!brief BLOCK OF POTENTIAL VECTORS
!
      TYPE(bief_obj), TARGET :: phib
!brief BLOCK OF WORKING ARRAYS
!
      TYPE(bief_obj), TARGET :: tb
!brief BLOCK OF WORKING ARRAYS
!
      TYPE(bief_obj), TARGET :: tbbd
!brief BLOCK OF PRIVATE VECTORS
! tableaux reserves a l'utilisateur
      TYPE(bief_obj), TARGET :: prive
!brief BLOCK OF MATRICES
!
      TYPE(bief_obj), TARGET :: mat
!brief BLOCK OF UNKNOWN VECTORS
!
      TYPE(bief_obj), TARGET :: unk
!brief BLOCK OF RIGHT HAND SIDE VECTORS IN SOLVING SYSTEM
!
      TYPE(bief_obj), TARGET :: rhs
!brief BLOCK OF VARIABLES FOR OUTPUT
!
      TYPE(bief_obj), TARGET :: varsor
!brief Number of variables in varsor
      INTEGER :: nvar_art
!brief BLOCK OF VARIABLES FOR ANIMATION OUTPUT
!
      TYPE(bief_obj), TARGET :: varnim
!
!-----------------------------------------------------------------------
!
!       4) INTEGERS
!
!-----------------------------------------------------------------------
!
!brief
! maximum de variables de sortie
      INTEGER, PARAMETER :: maxvar = 100
!brief
! maximum de frontieres liquides
      INTEGER, PARAMETER :: maxfro = 3000
!brief OPEN BOUNDARY WITH INCIDENT POTENTIAL
!
      INTEGER, PARAMETER :: kpot  =  7
!brief DEBUGGER
!
      INTEGER, TARGET :: debug
!brief ORIGIN COORDINATE
! coordonnee de l'origine
      INTEGER i_orig
!brief ORIGIN COORDINATE
! coordonnee de l'origine
      INTEGER j_orig
!brief GRAPHIC PRINTOUT PERIOD
! periode de sortie graphique
      INTEGER leoprd
!brief LISTING PRINTOUT PERIOD
! periode de sortie listing
      INTEGER lisprd
!brief MAXIMUM NUMBER OF ITERATIONS FOR SOLVER
! maximum d'iterations pour le solveur
      INTEGER nitmax
!brief GEOMETRY FILE STANDARD
! standard du fichier de geometrie
!     INTEGER STDGEO
!brief RESULTS FILE STANDARD
! standard du fichier des resultats
!     INTEGER STDRES
!brief SOLVER OPTION
! option du solveur
      INTEGER isolve(2)
!brief BOTTOM TOPOGRAPHY SMOOTHINGS
! nombre de lissages du fond
      INTEGER lisfon
!brief DISCRETISATION IN SPACE
! discretisation en espace
!     INTEGER DISESP
!brief NUMBER OF DISCRETISED PERIODS
! nombre de periodes de discretisation du spectre de houle
      INTEGER npale
!brief NUMBER OF DISCRETISED DIRECTIONS
! nombre de directions de discretisation du spectre de houle
      INTEGER ndale
!brief MATRIX STORAGE
! stockage des matrices
      INTEGER optass
!brief BREAKING LAW
! formulation du deferlement
      INTEGER ibreak
!brief MAXIMUM OF SUB-ITERATIONS
! maximum de sous-iterations
      INTEGER nitdis
!brief VECTOR LENGTH
! longueur du vecteur
      INTEGER lvmac
!brief LAW OF BOTTOM FRICTION
! loi de frottement sur le fond
!     INTEGER KFROT
!brief BOTTOM FRICTION LAW
! formulation du frottement de fond
      INTEGER formfr
!brief HYDRAULIC REGIME TYPE
! type du regime hydraulique
      INTEGER regido
!brief MATRIX-VECTOR PRODUCT
! produit matrice-vecteur
      INTEGER produc
!
!brief NUMBER OF PRIVATE ARRAYS, NUMBER OF PRIVATE ARRAYS WITH GIVEN NAME
! nombre de tableaux prives et tableaux prives avec noms
      INTEGER npriv,n_names_priv
!brief
!
      INTEGER ptinig
!brief
!
      INTEGER ptinil
!brief
! type d'element
      INTEGER ielm
!brief
!
      INTEGER ielm0
!brief
! type d'element de bord
      INTEGER ielmb
!brief
!
      INTEGER ielmb0
!brief ORIGINAL DATE OF TIME
! date de l'origine des temps
      INTEGER mardat(3)
!brief ORIGINAL HOUR OF TIME
! heure de l'origine des temps
      INTEGER martim(3)
!brief
!
      INTEGER nfrliq
!brief
! prise en compte des effets de pente/courbure
      INTEGER ipentco
!brief
      INTEGER lper
!brief
      INTEGER ldir
!brief MAX NUMBER OF ITERATION ON TETAP CALCULATION
! nombre max d'iteration pour calcul auto du TETAP
      INTEGER nittp
!brief NESTING WITHIN TOMAWAC OUTER MODEL
! si different de 0, ARTEMIS est integre dans un modele TOMAWAC global
      INTEGER chaintwc
!brief
! nombre de spectres
      INTEGER nspec
!brief
! nombre de directions definissant le(s) spectre(s)
      INTEGER ndir
!brief
! nombre de frequences definissant le(s) spectre(s)
      INTEGER nf
!brief
! numero de reference TOMAWAC pour le spectre en freq
      INTEGER n_sfref
!brief
! noeud frontiere de reference pour le spectre en freq
      INTEGER iptfr_ref
!
!-----------------------------------------------------------------------
!
!       5) LOGICAL VALUES
!
!-----------------------------------------------------------------------
!
!brief LISTING PRINTOUT
! si oui, sortie listing
      LOGICAL listin
!brief
!
      LOGICAL infogr
!brief PERIOD SCANNING
! si oui, balayage en periodes
      LOGICAL balaye
!brief MONODIRECTIONAL RANDOM WAVE
! si oui, houle aleatoire monodirectionnelle
      LOGICAL alemon
!brief MULTIDIRECTIONAL RANDOM WAVE
! si oui, houle aleatoire multidirectionnelle
      LOGICAL alemul
!brief
!
      LOGICAL msk
!brief
!
      LOGICAL spheri
!brief BREAKING
! si oui, deferlement
      LOGICAL deferl
!brief FRICTION
! si oui, frottement
      LOGICAL frotte
!brief FRICTION FACTOR IMPOSED
! si oui, facteur de frottement impose
      LOGICAL entfw
!brief HYDRAULIC REGIME IMPOSED
! si oui, regime hydraulique impose
      LOGICAL entreg
!brief SKIN ROUGHNESS ONLY
! si oui, rugosite de peau seule
      LOGICAL entrug
!brief WAVE HEIGHTS SMOOTHING
! si oui, lissage des hauteurs de houle
      LOGICAL lishou
!brief
!
      LOGICAL sorleo(maxvar)
!brief
!
      LOGICAL sorimp(maxvar)
!brief
! a logical array holding variable output for phase and amplitude file
      LOGICAL sornim(maxvar)
!brief VALIDATION
! si oui, validation
      LOGICAL valid
!brief COURANT
! Yes = current taken into account (defined in condih.f)
      LOGICAL courant
!!brief AUTOMATIC ANGLES
! si oui,calcul automatique des angles de sortie TETAP
      LOGICAL langauto
!!brief AUTOMATIC PHASES ON INCIDENT WAVE BOUNDARY
! si oui, calcul automatique des phases sur la frontière de type onde incidente (KINC)
      LOGICAL lphaseauto
!brief ANIMATION
! si oui, generates the phase and amplitude file
      LOGICAL animfs
!
!-----------------------------------------------------------------------
!
!       6) REALS
!
!-----------------------------------------------------------------------
!
!brief GRAVITY ACCELERATION
! acceleration de la pesanteur
      DOUBLE PRECISION grav
!brief MINIMUM VALUE FOR H
! valeur minimum de h
!     DOUBLE PRECISION HMIN
!brief WAVE PERIOD
! periode de la houle en cours de calcul
      DOUBLE PRECISION per
!brief ANGULAR FREQUENCY
! pulsation de la houle
      DOUBLE PRECISION omega
!brief DIRECTION OF WAVE PROPAGATION
! direction principale de propagation de la houle
      DOUBLE PRECISION tetah
!brief INITIAL WATER LEVEL
! cote initiale
      DOUBLE PRECISION cotini
!brief INITIAL DEPTH
! hauteur initiale
      DOUBLE PRECISION hautin
!brief BEGINNING PERIOD FOR PERIOD SCANNING
! periode de debut pour le balayage en periode
      DOUBLE PRECISION perdeb
!brief ENDING PERIOD FOR PERIOD SCANNING
! periode de fin pour le balayage en periode
      DOUBLE PRECISION perfin
!brief STEP FOR PERIOD SCANNING
! pas pour le balayage en periode
      DOUBLE PRECISION perpas
!brief PEAK PERIOD
! periode de pic
      DOUBLE PRECISION perpic
!brief GAMMA
! gamma
      DOUBLE PRECISION gamma
!brief MINIMUM ANGLE OF PROPAGATION
! valeur minimum de l'angle de propagation
      DOUBLE PRECISION tetmin
!brief MAXIMUM ANGLE OF PROPAGATION
! valeur maximum de l'angle de propagation
      DOUBLE PRECISION tetmax
!brief S EXPONENT
! exposant s dans la formule du spectre
      DOUBLE PRECISION expos
!brief
!
!     DOUBLE PRECISION RELAX
!brief FRICTION COEFFICIENT
! coefficient de frottement
      DOUBLE PRECISION ffon
!brief SUB-ITERATIONS ACCURACY
! precision sur les sous-iterations
      DOUBLE PRECISION epsdis
!brief DISSIPATION RELAXATION
! relaxation sur la dissipation
      DOUBLE PRECISION reldis
!brief ALPHA
! alpha
      DOUBLE PRECISION alfabj
!brief GAMMAS
! gammas
      DOUBLE PRECISION gammas
!brief
!
      DOUBLE PRECISION kdally
!brief
!
      DOUBLE PRECISION gdally
!brief FLUID KINEMATIC VISCOSITY
! viscosite cinematique du fluide
      DOUBLE PRECISION visco
!brief DIAMETER90
! diametre90
      DOUBLE PRECISION diam90
!brief DIAMETER50
! diametre50
      DOUBLE PRECISION diam50
!brief SEDIMENT SPECIFIC WEIGHT
! masse volumique du sediment
      DOUBLE PRECISION mvsed
!brief FLUID SPECIFIC MASS
! masse volumique du fluide
      DOUBLE PRECISION mveau
!brief FRICTION FACTOR
! coefficient de frottement constant impose
      DOUBLE PRECISION fwcoef
!brief RIPPLES COEFFICIENT
! coefficient de rides
      DOUBLE PRECISION ricoef
!brief MINIMUM SPECTRAL PERIOD
! periode minimum du spectre
      DOUBLE PRECISION pmin
!brief MAXIMUM SPECTRAL PERIOD
! periode maximum du spectre
      DOUBLE PRECISION pmax
!brief REFERENCE WATER DEPTH FOR AUTOMATIC PHASE
! Profondeur d'eau de référence pour le calcul automatique des phases
      DOUBLE PRECISION depref
!brief REFERENCE WAVE NUMBER FOR AUTOMATIC PHASE
! Nombre d'onde de référence pour le calcul automatique des phases
      DOUBLE PRECISION kphref
!brief X COORDINATE OF REFERENCE POINT FOR PHASE DEFINITION
! coordonnee en x du point de reference pour les phases
      DOUBLE PRECISION x_phref
!brief Y COORDINATE OF REFERENCE POINT FOR PHASE DEFINITION
! coordonnee en y du point de reference pour les phases
      DOUBLE PRECISION y_phref
!brief SUB-ITERATIONS ACCURACY FOR CURRENT(WAVE VECTOR DIRECTION)
! precision sur les sous-iterations pour le courant (direction vecteur d'onde)
      DOUBLE PRECISION epsdir
!brief SUB-ITERATIONS ACCURACY FOR TETAP
! precision sur les sous-iterations sur le TETAP
      DOUBLE PRECISION epstp
!brief RELAXATION COEFFICIENT FOR TETAP
! coefficient de relaxation pour calcul automatic de TETAP
      DOUBLE PRECISION reltp
!brief TIME AT WHICH TOMAWAC SPECTRUM IS TAKEN
!
      DOUBLE PRECISION tpstwc
!brief Significant wave height corresponding to global
! energy contained in TOMAWAC spectrum
      DOUBLE PRECISION hscal
!brief ABSCISSAE FOR THE REFERENCE F SPECTRUM
! x du point de reference pour le spectre en freq
      DOUBLE PRECISION x_sfref
!brief ORDINATES FOR THE REFERENCE F SPECTRUM
! y du point de reference pour le spectre en freq
      DOUBLE PRECISION y_sfref
!
      DOUBLE PRECISION fp,gam,delta
      DOUBLE PRECISION expo
!
!brief ARTEMIS CONSTANTS (INITIALISED INTO ARTEMIS_CONSTANTS)
!
      DOUBLE PRECISION :: pi,deupi,pisur2,usdpi,raddeg,degrad
!
!-----------------------------------------------------------------------
!
!       7) STRINGS
!
!-----------------------------------------------------------------------
!
!brief TITLE
! titre de l'etude
      CHARACTER(LEN=72) titcas
!brief
!
      CHARACTER(LEN=72) vardes
!brief VARIABLES TO BE PRINTED
! variables a imprimer
      CHARACTER(LEN=72) varimp
!brief INITIAL CONDITIONS
! conditions initiales
      CHARACTER(LEN=72) cdtini
!brief GEOMETRY FILE BINARY
! binaire du fichier de geometrie
!     CHARACTER(LEN=3) BINGEO
!brief RESULTS FILE BINARY
! binaire du fichier des resultats
!     CHARACTER(LEN=3) BINRES
!brief
!
      CHARACTER(LEN=20) equa
!brief
!
      CHARACTER(LEN=32) varcla(10)
!brief
!
      CHARACTER(LEN=32) texte(maxvar)
!brief
!
      CHARACTER(LEN=32) textpr(maxvar)
!brief
! name of variables in phase and amplitude file
      CHARACTER(LEN=32) textanim(maxvar)
!
!     NAMES OF PRIVATE ARRAYS (GIVEN BY USER)
!
      CHARACTER(LEN=32) names_prive(4)
!
!-----------------------------------------------------------------------
!
!       8) SLVCFG STRUCTURES
!
!-----------------------------------------------------------------------
!
!brief SLVCFG STRUCTURE
!
      TYPE(slvcfg) :: slvart
!
!-----------------------------------------------------------------------
!
!       9) MESH STRUCTURE
!
!-----------------------------------------------------------------------
!
!brief MESH STRUCTURE
!
      TYPE(bief_mesh),TARGET :: mesh
!
!-----------------------------------------------------------------------
!
!      10) ALIASES
!
!-----------------------------------------------------------------------
!
!       DECLARATION OF POINTERS FOR ALIASES.
!       TARGETS ARE DEFINED IN POINT_ARTEMIS
!
!       ALIASES FOR WORKING VECTORS IN TB AND TBBD
!
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t1
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t2
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t3
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t4
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t5
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t6
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t7
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t8
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t9
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t10
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t11
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t12
!brief WORKING VECTOR IN TBBD
!
      TYPE(bief_obj),POINTER :: t13
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t14
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t15
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: t16
!brief WORKING VECTOR IN TB
!
      TYPE(bief_obj),POINTER :: tbd1
!brief WORKING VECTOR IN TBBD
!
      TYPE(bief_obj),POINTER :: tbd2
!brief WORKING VECTOR IN TBBD
!
      TYPE(bief_obj),POINTER :: tbd3
!brief WORKING VECTOR IN TBBD
!
      TYPE(bief_obj),POINTER :: tbd4
!
!       USEFUL COMPONENTS IN STRUCTURE MESH
!
!brief
! table de connectivite
      TYPE(bief_obj), POINTER :: ikle
!brief
! coordonnees des points du maillage
      DOUBLE PRECISION, DIMENSION(:), POINTER :: x
!brief
! coordonnees des points du maillage
      DOUBLE PRECISION, DIMENSION(:), POINTER :: y
!brief
! nombre d'elements du maillage
      INTEGER, POINTER        :: nelem
!brief
!
      INTEGER, POINTER        :: nelmax
!brief
! nombre de points frontiere
      INTEGER, POINTER        :: nptfr
!brief
!
      INTEGER, POINTER        :: nptfrx
!brief
!
      INTEGER, POINTER        :: dim1
!brief
!
      INTEGER, POINTER        :: typelm
!brief
! nombre de points du maillage
      INTEGER, POINTER        :: npoin
!brief
!
      INTEGER, POINTER        :: npmax
!brief
!
      INTEGER, POINTER        :: mxptvs
!brief
!
      INTEGER, POINTER        :: mxelvs
!brief
!
      INTEGER, POINTER        :: lv
!
!-----------------------------------------------------------------------
!
!      11) ART_FILES AND ASSOCIATED
!
!-----------------------------------------------------------------------
!
!brief
!
      INTEGER, PARAMETER :: maxlu_art = 46
!brief NAME OF THE GEOMETRY FILE
! nom du fichier de geometrie
      INTEGER, TARGET :: artgeo
!brief NAME OF THE STEERING FILE
! nom du fichier des parametres
      INTEGER :: artcas
!brief NAME OF THE BOUNDARY CONDITIONS FILE
! nom du fichier des conditions aux limites
      INTEGER, TARGET :: artcli
!brief NAME OF THE BOTTOM TOPOGRAPHY FILE
! nom du fichier des fonds
      INTEGER :: artfon
!brief NAME OF THE RESULTS FILE
! nom du fichier des resultats
      INTEGER, TARGET :: artres
!brief NAME OF THE BINARY RESULTS FILE
! nom du fichier des resultats binaire
      INTEGER :: artrbi
!brief NAME OF THE FORMATTED RESULTS FILE
! nom du fichier des resultats formate
      INTEGER :: artrfo
!brief NAME OF THE AMPLITUDE AND PHASE FILE
! nom du fichier contenant phases et amplitudes
      INTEGER :: artamp
!brief NAME OF THE REFERENCE FILE
! nom du fichier de reference
      INTEGER :: artref
!brief NAME OF THE BINARY DATA FILE 1
! nom du fichier de donnees binaire 1
      INTEGER :: artbi1
!brief NAME OF THE BINARY DATA FILE 2
! nom du fichier de donnees binaire 2
      INTEGER :: artbi2
!brief NAME OF THE FORMATTED DATA FILE 1
! nom du fichier de donnees formate 1
      INTEGER :: artfo1
!brief NAME OF THE FORMATTED DATA FILE 2
! nom du fichier de donnees formate 2
      INTEGER :: artfo2
!brief NAME OF THE TOMAWAC OUTER SPECTRAL FILE
! nom du fichier de spectre global
      INTEGER :: wacspe
!brief NAME OF THE TOMAWAC OUTER RESULT FILE
! nom du fichier de resultats global
      INTEGER :: wacres
!brief NAME OF THE TOMAWAC LIQUID BOUNDARY FILE
! nom du fichier de frontieres liquides global
      INTEGER :: waclqd
!brief
!
      TYPE(bief_file), TARGET :: art_files(maxlu_art)
!
      SAVE
!
      END MODULE declarations_artemis