bief_def.f

Go to the documentation of this file.

!                   ***************
                    MODULE bief_def
!                   ***************
!
!
!***********************************************************************
! BIEF
!***********************************************************************
!
!brief    DEFINITION OF THE BIEF STRUCTURES
!+
!
!history  J-M HERVOUET (EDF LAB, LNHE)
!+        09/05/2014
!+        V7P0
!+   Integer I8 buffers added in the mesh structure.
!history  R.NHEILI (Univerte de Perpignan, DALI)
!+        24/02/2016
!+        V7P3
!+      ADD E (ROUNDING ERROR) IN THE VECTOR STRUCTURE
!+      ADD BUF_SEND_ERR AND BUF_RECV_ERR
!
!history  J-M HERVOUET (EDF LAB, LNHE)
!+        22/03/2016
!+        V7P2
!+   Adding component STOXEBE for the storage option of off-diagonal
!+   terms of EBE matrices.
!
!history  N.DURAND (HRW)
!+        January 2019
!+        V8P0
!+   TYPE SPECTRUM (used in ARTEMIS) migrated to BIEF_DEF
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      USE declarations_special
!
      IMPLICIT NONE
!
!=======================================================================
!
!     COMMON VALUES FOR PARALLEL MODE
!
!     NPTIR: NUMBER OF INTERFACE POINTS OF THE SUB-DOMAIN
!     IPID: PROCESSOR NUMBER
!     NCSIZE: NUMBER OF PROCESSORS
      INTEGER,TARGET::nptir
      INTEGER ipid,ncsize,nhalo
!
!     MAXIMUM GEOMETRICAL MULTIPLICITY OF A NODE
      INTEGER, PARAMETER :: nbmaxnshare =  10
!     FOR A DOMAIN, MAXIMUM NUMBER OF DOMAIN NEIGHBOURS/2
!     BE CAREFUL: VARIABLE USED IN PARTEL.F TOO
      INTEGER, PARAMETER :: nbmaxdshare = 80
!
!=======================================================================
!
!  STRUCTURE OF POINTER TO A BIEF_OBJ, TO HAVE ARRAYS OF POINTERS
!  IN THE BIEF_OBJ STRUCTURE FOR BLOCKS
!
!  BIEF RELEASE 6.0
!
!=======================================================================
!
!       THIS IS NECESSARY IN FORTRAN 90 TO HAVE ARRAYS OF POINTERS
!       LIKE THE COMPONENT ADR BELOW, WHICH ENABLES TO BUILD BLOCKS
!       WHICH ARE ARRAYS OF POINTERS TO BIEF_OBJ STRUCTURES
!
        TYPE pointer_to_bief_obj
          TYPE(bief_obj), POINTER :: p => null()
        END TYPE pointer_to_bief_obj
!
!=======================================================================
!
!  STRUCTURE OF VECTOR, MATRIX OR BLOCK IN A SINGLE OBJECT : BIEF_OBJ
!
!=======================================================================
!
        TYPE bief_obj
!
!-----------------------------------------------------------------------
!
!       HEADER COMMON TO ALL OBJECTS
!
!         KEY : ALWAYS 123456 TO CHECK MEMORY OVERWRITING
          INTEGER key
!
!         TYPE: 2: VECTOR,  3: MATRIX,  4: BLOCK
          INTEGER type
!
!         Contains the name of its father (i.e the bloc that created it)
!         If father is XXXXXX the bief_obj was created on its own
          CHARACTER(LEN=6) father
!
!         NAME: FORTRAN NAME OF OBJECT IN 6 CHARACTERS
          CHARACTER(LEN=6) name
!
!-----------------------------------------------------------------------
!
!       FOR VECTORS
!
!
!         NAT: NATURE (1:DOUBLE PRECISION  2:INTEGER)
          INTEGER nat
!
!         ELM: TYPE OF ELEMENT
          INTEGER elm
!
!         DIM1: FIRST DIMENSION OF VECTOR
          INTEGER dim1
!
!         MAXDIM1: MAXIMUM SIZE PER DIMENSION
          INTEGER maxdim1
!
!         DIM2: SECOND DIMENSION OF VECTOR
          INTEGER dim2
!
!         MAXDIM2: MAXIMUM SECOND DIMENSION OF VECTOR
          INTEGER maxdim2
!
!         DIMDISC: TYPE OF ELEMENT IF VECTOR IS DISCONTINUOUS AT
!                  THE BORDER BETWEEN ELEMENTS, OR 0 IF NOT
          INTEGER dimdisc
!
!         STATUS:
!         0: ANY ARRAY
!         1: VECTOR DEFINED ON A MESH, NO CHANGE OF DISCRETISATION
!         2: VECTOR DEFINED ON A MESH, CHANGE OF DISCRETISATION ALLOWED
          INTEGER status
!
!         TYPR: TYPE OF VECTOR OF REALS
!         '0' : NIL   '1' : EQUAL TO 1  'Q' : NO SPECIFIC PROPERTY
          CHARACTER(LEN=1) typr
!
!         TYPI: TYPE OF VECTOR OF INTEGERS
!         '0' : NIL   '1' : EQUAL TO 1  'Q' : NO SPECIFIC PROPERTY
          CHARACTER(LEN=1) typi
!
!         POINTER TO DOUBLE PRECISION 1-DIMENSION ARRAY
!         DATA ARE STORED HERE FOR A DOUBLE PRECISION VECTOR
          DOUBLE PRECISION, POINTER,DIMENSION(:)::r => null()

!         POINTER TO DOUBLE PRECISION 1-DIMENSION ARRAY
!         DATA ARE STORED HERE FOR A DOUBLE PRECISION VECTOR
          DOUBLE PRECISION, POINTER,DIMENSION(:)::e => null()
!
!         POINTER TO INTEGER 1-DIMENSION ARRAY
!         DATA ARE STORED HERE FOR AN INTEGER VECTOR
          INTEGER, POINTER,DIMENSION(:)::i => null()
!
!-----------------------------------------------------------------------
!
!       FOR MATRICES
!
!         STO: TYPE OF STORAGE  1: CLASSICAL EBE   3: EDGE-BASED STORAGE
          INTEGER sto
!
!         STOX: ORDER OF STORAGE OF OFF-DIAGONAL TERMS
!         FOR EBE: 1=(NELMAX,NDP)  2=(NDP,NELMAX)
          INTEGER stox
!
!         ELMLIN: TYPE OF ELEMENT OF ROW
          INTEGER elmlin
!
!         ELMCOL: TYPE OF ELEMENT OF COLUMN
          INTEGER elmcol
!
!         TYPDIA: TYPE OF DIAGONAL
!         '0' : NIL   'I' : IDENTITY  'Q' : NO SPECIFIC PROPERTY
          CHARACTER(LEN=1) typdia
!
!         TYPEXT: TYPE OF EXTRA-DIAGONAL TERMS
!         '0' : NIL   'S' : SYMMETRY  'Q' : NO SPECIFIC PROPERTY
          CHARACTER(LEN=1) typext
!
!         POINTER TO A BIEF_OBJ FOR DIAGONAL
          TYPE(bief_obj), POINTER :: d => null()
!
!         POINTER TO A BIEF_OBJ FOR EXTRA-DIAGONAL TERMS
          TYPE(bief_obj), POINTER :: x => null()
!
!         PRO: TYPE OF MATRIX-VECTOR PRODUCT
          INTEGER pro
!
!-----------------------------------------------------------------------
!
!       FOR BLOCKS
!
!         BLOCKS ARE IN FACT ARRAYS OF POINTERS TO BIEF_OBJ STRUCTURES
!         ADR(I)%P WILL BE THE I-TH BIEF_OBJ OBJECT
!
!         N: NUMBER OF OBJECTS IN THE BLOCK
          INTEGER n
!         MAXBLOCK: MAXIMUM NUMBER OF OBJECTS IN THE BLOCK
          INTEGER maxblock
!         ADR: ARRAY OF POINTERS TO OBJECTS (WILL BE OF SIZE MAXBLOCK)
          TYPE(pointer_to_bief_obj), POINTER :: adr(:) => null()
!
!-----------------------------------------------------------------------
!
        END TYPE bief_obj
!
!
!=======================================================================
!
!  STRUCTURE OF MESH : BIEF_MESH
!
!=======================================================================
!
        TYPE bief_mesh
!
!         1) A HEADER
!
!         NAME: NAME OF MESH IN 6 CHARACTERS
          CHARACTER(LEN=6) name
!
!         2) A SERIES OF INTEGER VALUES (DECLARED AS POINTERS TO ENABLE
!                                        ALIASES)
!
!         NELEM: NUMBER OF ELEMENTS IN MESH
          INTEGER, POINTER :: nelem
!
!         NELMAX: MAXIMUM NUMBER OF ELEMENTS ENVISAGED
          INTEGER, POINTER :: nelmax
!
!         NPTFR: NUMBER OF 1D BOUNDARY NODES, EVEN IN 3D
          INTEGER, POINTER :: nptfr
!
!         NPTFRX: NUMBER OF 1D BOUNDARY NODES, EVEN IN 3D
          INTEGER, POINTER :: nptfrx
!
!         NELEB: NUMBER OF BOUNDARY ELEMENTS (SEGMENTS IN 2D)
!         IN 3D WITH PRISMS:
!         NUMBER OF LATERAL BOUNDARY ELEMENTS FOR SIGMA MESH
          INTEGER, POINTER :: neleb
!
!         NELEBX: MAXIMUM NELEB
          INTEGER, POINTER :: nelebx
!
!         NSEG: NUMBER OF SEGMENTS IN THE MESH
          INTEGER, POINTER :: nseg
!
!         NSEGBOR: NUMBER OF BORDER SEGMENTS IN THE MESH
          INTEGER, POINTER :: nsegbor
!
!         DIM1: DIMENSION OF DOMAIN (2 OR 3)
          INTEGER, POINTER :: dim1
!
!         TYPELM: TYPE OF ELEMENT (10 FOR TRIANGLES, 40 FOR PRISMS)
          INTEGER, POINTER :: typelm
!
!         TYPELM: TYPE OF ELEMENT (10 FOR TRIANGLES, 40 FOR PRISMS)
          INTEGER, POINTER :: typelmbnd
!
!         NPOIN: NUMBER OF VERTICES (OR LINEAR NODES) IN THE MESH
          INTEGER, POINTER :: npoin
!
!         NPMAX: MAXIMUM NUMBER OF VERTICES IN THE MESH
          INTEGER, POINTER :: npmax
!
!         MXPTVS: MAXIMUM NUMBER OF POINTS ADJACENT TO 1 POINT
          INTEGER, POINTER :: mxptvs
!
!         MXELVS: MAXIMUM NUMBER OF ELEMENTS ADJACENT TO 1 POINT
          INTEGER, POINTER :: mxelvs
!
!         LV: MAXIMUM VECTOR LENGTH ALLOWED ON VECTOR COMPUTERS,
!             DUE TO ELEMENT NUMBERING
          INTEGER, POINTER :: lv
!
!         NDS: NUMBERS OF NODES, ELEMENTS, SEGMENTS, OF DIFFERENT
!              TYPES OF DISCRETISATION
          INTEGER, POINTER :: nds(:,:) => null()

!         X,Y ORIGIN
          INTEGER, POINTER :: x_orig, y_orig
!
!
!         3) A SERIES OF BIEF_OBJ TO STORE INTEGER ARRAYS
!
!         IKLE: CONNECTIVITY TABLE IKLE(NELMAX,NDP) AND KLEI(NDP,NELMAX)
          TYPE(bief_obj), POINTER :: ikle => null(), klei => null()
!
!         IFABOR: TABLE GIVING ELEMENTS BEHIND FACES OF A TRIANGLE
          TYPE(bief_obj), POINTER :: ifabor => null()
!
!         NELBOR: ELEMENTS OF THE BOUNDARY
          TYPE(bief_obj), POINTER :: nelbor => null()
!
!         NULONE: LOCAL NUMBER OF BOUNDARY POINTS FOR BOUNDARY ELEMENTS
          TYPE(bief_obj), POINTER :: nulone => null()
!
!         KP1BOR: POINTS FOLLOWING AND PRECEDING A BOUNDARY POINT
          TYPE(bief_obj), POINTER :: kp1bor => null()
!
!         NBOR: GLOBAL NUMBER OF BOUNDARY POINTS
          TYPE(bief_obj), POINTER :: nbor => null()
!
!         IKLBOR: CONNECTIVITY TABLE FOR BOUNDARY POINTS
          TYPE(bief_obj), POINTER :: iklbor => null()
!
!         IFANUM: FOR STORAGE 2, NUMBER OF SEGMENT IN ADJACENT ELEMENT
!         OF A TRIANGLE
          TYPE(bief_obj), POINTER :: ifanum => null()
!
!         IKLEM1: ADRESSES OF NEIGHBOURS OF POINTS FOR FRONTAL
!         MATRIX-VECTOR PRODUCT
          TYPE(bief_obj), POINTER :: iklem1 => null()
!
!         LIMVOI: FOR FRONTAL MATRIX-VECTOR PRODUCT, ADDRESSES OF POINTS
!         WITH A GIVEN NUMBER OF NEIGHBOURS
          TYPE(bief_obj), POINTER :: limvoi => null()
!
!         NUBO: FOR FINITE VOLUMES, GLOBAL NUMBERS OF VERTICES OF SEGMENTS
          TYPE(bief_obj), POINTER :: nubo => null()
!
!         FOR SEGMENT-BASED STORAGE
!
!         GLOSEG: GLOBAL NUMBERS OF VERTICES OF SEGMENTS
          TYPE(bief_obj), POINTER :: gloseg => null()
!         ELTSEG: SEGMENTS FORMING AN ELEMENT
          TYPE(bief_obj), POINTER :: eltseg => null()
!         ORISEG: ORIENTATION OF SEGMENTS FORMING AN ELEMENT 1:ANTI 2:CLOCKWISE
          TYPE(bief_obj), POINTER :: oriseg => null()

!         FOR UNSTRUCTURED 3D (IELM = 31 SO FAR)
!         GLOSEGBOR: GLOBAL NUMBERS OF VERTICES OF SEGMENTS
          TYPE(bief_obj), POINTER :: glosegbor => null()
!         ELTSEGBOR: SEGMENTS FORMING AN ELEMENT
          TYPE(bief_obj), POINTER :: eltsegbor => null()
!         ORISEGBOR: ORIENTATION OF SEGMENTS FORMING AN ELEMENT 1:ANTI 2:CLOCKWISE
          TYPE(bief_obj), POINTER :: orisegbor => null()
!
!         FOR THE METHOD OF CHARACTERISTICS
!
!         ELTCAR: STARTING ELEMENT FOR TREATING A POINT
!         IF 0, IT IS IN ANOTHER SUBDOMAIN
!
          TYPE(bief_obj), POINTER :: eltcar => null()
!
!         SERIES OF ARRAYS FOR PARALLEL MODE
!         HERE GLOBAL MEANS NUMBER IN THE WHOLE DOMAIN
!              LOCAL  MEANS NUMBER IN THE SUB-DOMAIN
!
!         KNOLG: GIVES THE INITIAL GLOBAL NUMBER OF A LOCAL POINT
          TYPE(bief_obj), POINTER :: knolg => null()
!         NACHB: NUMBERS OF PROCESSORS CONTAINING A GIVEN POINT
          TYPE(bief_obj), POINTER :: nachb => null()
!         ISEG: GLOBAL NUMBER OF FOLLOWING OR PRECEDING POINT IN THE BOUNDARY
!         IF IT IS IN ANOTHER SUB-DOMAIN.
          TYPE(bief_obj), POINTER :: iseg => null()
!         ADDRESSES IN ARRAYS SENT BETWEEN PROCESSORS
          TYPE(bief_obj), POINTER :: indpu => null()
!
!         DIMENSION NHP(NBMAXNSHARE,NPTIR)
!         NHP(IZH,IR) IS THE GLOBAL NUMBER IN THE SUB-DOMAIN OF A POINT
!         WHOSE NUMBER IS IR IN THE INTERFACE WITH THE IZ-TH HIGHER RANK PROCESSOR
          TYPE(bief_obj), POINTER :: nhp => null()
!         NHM IS LIKE NHP, BUT WITH LOWER RANK PROCESSORS
          TYPE(bief_obj), POINTER :: nhm => null()
!
!         FOR FINITE VOLUMES AND KINETIC SCHEMES
          TYPE(bief_obj), POINTER :: jmi => null()
!         ELEMENTAL HALO NEIGHBOURHOOD DESCRIPTION IN PARALLEL
!         IFAPAR(6,NELEM2)
!         IFAPAR(1:3,IELEM): PROCESSOR NUMBERS BEHIND THE 3 ELEMENT EDGES
!                            NUMBER FROM 0 TO NCSIZE-1
!         IFAPAR(4:6,IELEM): -LOCAL- ELEMENT NUMBERS BEHIND THE 3 EDGES
!                            IN THE NUMBERING OF PARTITIONS THEY BELONG TO
          TYPE(bief_obj), POINTER :: ifapar => null()
!
!         4) A SERIES OF BIEF_OBJ TO STORE REAL ARRAYS
!
!         XEL: COORDINATES X PER ELEMENT
          TYPE(bief_obj), POINTER :: xel => null()
!
!         YEL: COORDINATES Y PER ELEMENT
          TYPE(bief_obj), POINTER :: yel => null()
!
!         ZEL: COORDINATES Z PER ELEMENT
          TYPE(bief_obj), POINTER :: zel => null()
!
!         SURFAC: AREAS OF ELEMENTS (IN 2D)
          TYPE(bief_obj), POINTER :: surfac => null()
!
!         SURDET: 1/DET OF ISOPARAMETRIC TRANSFORMATION
          TYPE(bief_obj), POINTER :: surdet => null()
!
!         LGSEG: LENGTH OF 2D BOUNDARY SEGMENTS
          TYPE(bief_obj), POINTER :: lgseg => null()
!
!         XSGBOR: NORMAL X TO 1D BOUNDARY SEGMENTS
          TYPE(bief_obj), POINTER :: xsgbor => null()
!
!         YSGBOR: NORMAL Y TO 1D BOUNDARY SEGMENTS
          TYPE(bief_obj), POINTER :: ysgbor => null()
!
!         ZSGBOR: NORMAL Z TO 1D BOUNDARY SEGMENTS
          TYPE(bief_obj), POINTER :: zsgbor => null()
!
!         XNEBOR: NORMAL X TO 1D BOUNDARY POINTS
          TYPE(bief_obj), POINTER :: xnebor => null()
!
!         YNEBOR: NORMAL Y TO 1D BOUNDARY POINTS
          TYPE(bief_obj), POINTER :: ynebor => null()
!
!         ZNEBOR: NORMAL Z TO 1D BOUNDARY POINTS
          TYPE(bief_obj), POINTER :: znebor => null()
!
!         X: COORDINATES OF POINTS
          TYPE(bief_obj), POINTER :: x => null()
!
!         Y: COORDINATES OF POINTS
          TYPE(bief_obj), POINTER :: y => null()
!
!         Z: COORDINATES OF POINTS
          TYPE(bief_obj), POINTER :: z => null()
!
!         COSLAT: LATITUDE COSINE
          TYPE(bief_obj), POINTER :: coslat => null()
!
!         SINLAT: LATITUDE SINE
          TYPE(bief_obj), POINTER :: sinlat => null()
!
!         DISBOR: DISTANCE TO 1D BOUNDARIES
          TYPE(bief_obj), POINTER :: disbor => null()
!
!         M: WORKING MATRIX
          TYPE(bief_obj), POINTER :: m => null()
!
!         MSEG: WORKING MATRIX FOR SEGMENT-BASED STORAGE
          TYPE(bief_obj), POINTER :: mseg => null()
!
!         W: WORKING ARRAY FOR A NON-ASSEMBLED VECTOR
          TYPE(bief_obj), POINTER :: w => null()
!
!         WI8: WORKING ARRAY FOR A NON-ASSEMBLED VECTOR STORED IN INTEGERS
          INTEGER(KIND=K8), POINTER :: wi8(:) => null()
!
!         T: WORKING ARRAY FOR AN ASSEMBLED VECTOR
          TYPE(bief_obj), POINTER :: t => null()
!
!         TI8: WORKING ARRAY FOR AN ASSEMBLED VECTOR STORED IN INTEGERS
          INTEGER(KIND=K8), POINTER :: ti8(:) => null()
!
!         VNOIN: FOR FINITE VOLUMES
          TYPE(bief_obj), POINTER :: vnoin => null()
!
!         XSEG: X COORDINATE OF FOLLOWING OR PRECEDING POINT IN THE BOUNDARY
!         IF IT IS IN ANOTHER SUB-DOMAIN
          TYPE(bief_obj), POINTER :: xseg => null()
!
!         YSEG: Y COORDINATE OF FOLLOWING OR PRECEDING POINT IN THE BOUNDARY
!         IF IT IS IN ANOTHER SUB-DOMAIN
          TYPE(bief_obj), POINTER :: yseg => null()
!
!         IFAC: MULTIPLICATION FACTOR FOR POINTS IN THE BOUNDARY FOR
!               DOT PRODUCT. FAC=1 ON 1 SUBDOMAIN AND 0 FOR OTHERS
          TYPE(bief_obj), POINTER :: ifac => null()
!
!         FOR PARALLEL MODE AND NON BLOCKING COMMUNICATION (SEE PARINI.F)
!
!         NUMBER OF PROCESSORS WITH POINTS IN COMMON WITH THE SUB-DOMAIN
          INTEGER       , POINTER :: nb_neighb
!         FOR ANY NEIGHBOURING PROCESSOR, NUMBER OF POINTS
!         SHARED WITH IT
          TYPE(bief_obj), POINTER :: nb_neighb_pt
!         RANK OF PROCESSORS WITH WHICH TO COMMUNICATE FOR POINTS
          TYPE(bief_obj), POINTER :: list_send
!         NH_COM(DIM1NHCOM,NB_NEIGHB)
!         WHERE DIM1NHCOM IS THE MAXIMUM NUMBER OF POINTS SHARED
!         WITH ANOTHER PROCESSOR (OR SLIGHTLY MORE FOR 16 BYTES ALIGNMENT)
!         NH_COM(I,J) IS THE GLOBAL NUMBER IN THE SUB-DOMAIN OF I-TH
!         POINT SHARED WITH J-TH NEIGHBOURING PROCESSOR
          TYPE(bief_obj), POINTER :: nh_com
!
!         NUMBER OF NEIGHBOURING PROCESSORS WITH EDGES
!         IN COMMON WITH THE SUB-DOMAIN
          INTEGER       , POINTER :: nb_neighb_seg
!         FOR ANY NEIGHBOURING PROCESSOR, NUMBER OF EDGES
!         SHARED WITH IT
          TYPE(bief_obj), POINTER :: nb_neighb_pt_seg
!         RANK OF PROCESSORS WITH WHICH TO COMMUNICATE FOR EDGES
          TYPE(bief_obj), POINTER :: list_send_seg
!         LIKE NH_COM BUT FOR EDGES
          TYPE(bief_obj), POINTER :: nh_com_seg
!
!         WILL BE USED AS BUFFER BY MPI IN PARALLEL
!
          TYPE(bief_obj), POINTER :: buf_send
          TYPE(bief_obj), POINTER :: buf_recv
          TYPE(bief_obj), POINTER :: buf_send_err
          TYPE(bief_obj), POINTER :: buf_recv_err
          INTEGER(KIND=K8), POINTER :: buf_sendi8(:)
          INTEGER(KIND=K8), POINTER :: buf_recvi8(:)
!
!         FOR FINITE VOLUMES AND KINETIC SCHEMES
!
          TYPE(bief_obj), POINTER :: cmi,dpx,dpy
          TYPE(bief_obj), POINTER :: dthaut,airst
!
!         CENTER OF MASS OF ELEMENTS NEIGHBORING AN EDGE
!
          TYPE(bief_obj), POINTER :: coordg
!
        END TYPE bief_mesh
!
!=======================================================================
!
!  STRUCTURE OF SOLVER CONFIGURATION
!
!=======================================================================
!
        TYPE slvcfg
!
!         SLV: CHOICE OF SOLVER
          INTEGER slv
!
!         NITMAX: MAXIMUM NUMBER OF ITERATIONS
          INTEGER nitmax
!
!         PRECON: TYPE OF PRECONDITIONING
          INTEGER precon
!
!         KRYLOV: DIMENSION OF KRYLOV SPACE FOR GMRES SOLVER
          INTEGER krylov
!
!         EPS: ACCURACY
          DOUBLE PRECISION eps
!
!         ZERO: TO CHECK DIVISIONS BY ZERO
          DOUBLE PRECISION zero
!
!         OK: IF PRECISION EPS HAS BEEN REACHED
          LOGICAL ok
!
!         NIT: NUMBER OF ITERATIONS IF PRECISION REACHED
          INTEGER nit
!
        END TYPE slvcfg
!
!=======================================================================
!
!  STRUCTURE OF FILE
!
!=======================================================================
!
        TYPE bief_file
!
!         LU: LOGICAL UNIT TO OPEN THE FILE
          INTEGER lu
!
!         NAME: NAME OF FILE
          CHARACTER(LEN=PATH_LEN) name
!
!         TELNAME: NAME OF FILE IN TEMPORARY DIRECTORY
          CHARACTER(LEN=6) telname
!
!         FMT: FORMAT (SERAFIN, MED, ETC.)
          CHARACTER(LEN=8) fmt
!
!         ACTION: READ, WRITE OR READWRITE
          CHARACTER(LEN=9) action
!
!         BINASC: ASC FOR ASCII OR BIN FOR BINARY
          CHARACTER(LEN=3) binasc
!
!         TYPE: KIND OF FILE
          CHARACTER(LEN=12) type
!
        END TYPE bief_file
!
!=======================================================================
!
!  STRUCTURE OF CONTROL SECTION
!
!  ADDED BY JACEK JANKOWSKI, BAW KARLSRUHE,
!  USED BY TELEMAC-2D AND SISYPHE
!
!=======================================================================
!
      TYPE chain_type
        INTEGER :: npair(2)
        DOUBLE PRECISION :: xybeg(2), xyend(2)
        CHARACTER(LEN=24) :: descr
        INTEGER :: nseg
        INTEGER, POINTER :: liste(:,:)
      END TYPE chain_type
!
!=======================================================================
!
!  STRUCTURES FOR OIL SPILLS
!
!=======================================================================
!
      TYPE compo
        DOUBLE PRECISION::sol
        DOUBLE PRECISION::mass
        DOUBLE PRECISION::tb
      END TYPE compo

      TYPE oil_part
        INTEGER::state
        INTEGER::eltoil,etaoil
        INTEGER::tpsech
        INTEGER::id
        INTEGER::cls
        DOUBLE PRECISION::xoil,yoil,zoil
        DOUBLE PRECISION::mass0
        DOUBLE PRECISION::mass
        DOUBLE PRECISION::mass_evap,mass_diss
        DOUBLE PRECISION::surface,shzoil
        DOUBLE PRECISION,DIMENSION(3)::shpoil
        TYPE(compo),DIMENSION(:),ALLOCATABLE::compo
        TYPE(compo),DIMENSION(:),ALLOCATABLE::hap
      END TYPE oil_part
!
!=======================================================================
!
!  STRUCTURE OF WEIRS : WEIRS
!
!=======================================================================
!
      TYPE weir_element
        INTEGER :: num_glo
        INTEGER :: n_1a_1, n_1a_2
        INTEGER :: n_1b_1, n_1b_2
        INTEGER :: n_2a_1, n_2a_2
        INTEGER :: n_2b_1, n_2b_2
        INTEGER :: nb_neigh
        INTEGER :: deb, fin
        INTEGER :: ip1, ip2 ! 2 integer parameters
        INTEGER :: rupt ! To mark the breaches
        INTEGER, DIMENSION(NBMAXNSHARE) :: list_neigh
        DOUBLE PRECISION :: z1, z2
        DOUBLE PRECISION :: width
        DOUBLE PRECISION :: q, q0
        DOUBLE PRECISION :: qw, qw0
        DOUBLE PRECISION :: rp1, rp2 ! 2 reals parameters
      END TYPE weir_element
!
      TYPE weir_element_proc
        INTEGER :: num_neigh
        INTEGER :: nb_elem
        INTEGER, DIMENSION(:), ALLOCATABLE :: list_elem
      END TYPE weir_element_proc
!
      TYPE weir_nodes
        INTEGER :: num_glo
        INTEGER :: nb_neigh
        INTEGER, DIMENSION(NBMAXNSHARE) :: list_neigh
        INTEGER, DIMENSION(NBMAXNSHARE) :: num_loc
        DOUBLE PRECISION :: qn, zfn, hn
        DOUBLE PRECISION :: qw, hw, tw, dw
        DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: trac, trac0
      END TYPE weir_nodes
!
      TYPE weir_nodes_proc
        INTEGER :: num_neigh
        INTEGER :: nb_nodes
        INTEGER, DIMENSION(:), ALLOCATABLE :: list_nodes
        INTEGER, DIMENSION(:), ALLOCATABLE :: num_glo
        INTEGER, DIMENSION(:), ALLOCATABLE :: num_loc
      END TYPE weir_nodes_proc
!
!=======================================================================
!
!  SPECTRUM STRUCTURE (USED IN ARTEMIS)
!
!=======================================================================
!
!     THIS IS NECESSARY IN FORTRAN 90 TO HAVE ARRAYS OF POINTERS
!     LIKE THE COMPONENT ADR BELOW, WHICH ENABLES TO BUILD BLOCKS
!     WHICH ARE ARRAYS OF POINTERS TO MATRICES
!
      TYPE pointer_to_spec
          DOUBLE PRECISION, POINTER, DIMENSION(:,:) :: souter => null()
      END TYPE pointer_to_spec
!
!brief SPECTRUM STRUCTURE
!
      TYPE spectrum
!
!-----------------------------------------------------------------------
!
!     HEADER COMMON TO ALL OBJECTS
!
!brief NAME OF SPECTRUM IN 6 CHARACTERS
! nom du spectre
          CHARACTER(LEN=6) :: name
!
!brief DIRECTIONAL COMPONENT
! direction
          DOUBLE PRECISION, POINTER, DIMENSION(:) :: dir => null()
!
!brief FREQUENCY COMPONENT
! frequence
          DOUBLE PRECISION, POINTER, DIMENSION(:) :: fre => null()
!
!brief GLOBAL NODE NUMBER OF OUTER MODEL POINTS
! numero global des noeuds du modele d entree
          INTEGER, POINTER, DIMENSION(:) :: nouter => null()
!
!brief COORDINATES OF POINTS IN THE OUTER MODEL AREA
! coordonnees des noeuds du modele d entree
          DOUBLE PRECISION, POINTER, DIMENSION(:) :: xouter => null()
!
!brief COORDINATES OF POINTS IN THE OUTER MODEL AREA
! coordonnees des noeuds du modele d entree
          DOUBLE PRECISION, POINTER, DIMENSION(:) :: youter => null()
!
!-----------------------------------------------------------------------
!
!     BLOCKS ARE IN FACT ARRAYS OF POINTERS TO SPECTRUM STRUCTURES
!     ADR(I) WILL BE THE I-TH SPECTRUM OBJECT
!
!         N: NUMBER OF OBJECTS IN THE BLOCK
          INTEGER :: n
!         ADR: ARRAY OF POINTERS TO MATRICES CONTAINING THE
!         SPECTRUM COMPONENTS
          TYPE(pointer_to_spec), POINTER, DIMENSION(:) :: adr => null()
!
      END TYPE spectrum
!
      TYPE(spectrum) :: s_tom
!
!=======================================================================
!
!  STRUCTURES FOR API COUPLING
      TYPE api_cpl
        INTEGER::nsis_cfd
        LOGICAL::sisyphe_cfd,constflow
        LOGICAL::charr,susp
      END TYPE api_cpl

      SAVE

      END MODULE bief_def