declarations_telemac.f

Go to the documentation of this file.

!                   ***************************
                    MODULE declarations_telemac
!                   ***************************
!
!
!***********************************************************************
! BIEF
!***********************************************************************
!
!brief    DECLARATIONS COMMON TO ALL PROGRAMS
!+
!history  J-M HERVOUET (EDF LAB, LNHE)
!+        09/05/2014
!+        V7P0
!+   Parameter MODASS added.
!
!history  F. HUANG (CLARKSON U.) AND S.E. BOURBAN (HRW)
!+        19/11/2016
!+        V7P3
!+        New modelling component added KHIONE
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      USE bief_def
      IMPLICIT NONE
!----------------------------------------------------------------------
!
! 1./ INTEGER VALUES TO DESCRIBE BOUNDARY CONDITIONS:
!
!
!     FOR THE BOUNDARY CONDITIONS FILE:
!
!     ENTRANCE: PRESCRIBED VALUES (SAVE VELOCITIES)
      INTEGER, PARAMETER :: kent  =  5
!
!     VELOCITY IMPOSED (INSTEAD OF DISCHARGE)
      INTEGER, PARAMETER :: kentu =  6
!
!     FREE OUTPUT
      INTEGER, PARAMETER :: ksort =  4
!
!     NO-SLIP CONDITION
      INTEGER, PARAMETER :: kadh  =  0
!
!     WALL WITH OR WITHOUT FRICTION
      INTEGER, PARAMETER :: klog  =  2
!
!     OPEN BOUNDARY WITH INCIDENT WAVE
      INTEGER, PARAMETER :: kinc  =  1
!
!     ESTEL-2D : FREE DRAINAGE
      INTEGER, PARAMETER :: kdrain  =  3
!
!     ESTEL-2D : MIXED CONDITION
      INTEGER, PARAMETER :: kmix  =  4
!
!     DEPENDING ON ALGORITHMS AND CASES, THESE VALUES WILL BE
!     TRANSFORMED INTO:
!
!     TECHNICAL BOUNDARY CONDITIONS
!
!     NEUMANN
      INTEGER, PARAMETER :: kneu  =  1
!
!     DIRICHLET
      INTEGER, PARAMETER :: kdir  =  2
!
!     DEGREE OF FREEDOM
      INTEGER, PARAMETER :: kddl  =  3
!
!     INCIDENT WAVE
      INTEGER, PARAMETER :: kond  =  4
!
!----------------------------------------------------------------------
!
! 2./ INTEGER VALUES TO DESCRIBE ADVECTION SCHEMES:
!
!     NO ADVECTION
      INTEGER, PARAMETER :: adv_void    =  0
!     CHARACTERISTICS
      INTEGER, PARAMETER :: adv_car     =  1
!     SUPG
      INTEGER, PARAMETER :: adv_sup     =  2
!     LEO POSTMA
      INTEGER, PARAMETER :: adv_lpo     =  3
!     DISTRIBUTIVE N-SCHEME
      INTEGER, PARAMETER :: adv_nsc     =  4
!     DISTRIBUTIVE PSI SCHEME
      INTEGER, PARAMETER :: adv_psi     =  5
!     LEO POSTMA, EDGE-BASED FOR TIDAL FLATS
      INTEGER, PARAMETER :: adv_lpo_tf  = 13
!     DISTRIBUTIVE N SCHEME, EDGE-BASED FOR TIDAL FLATS
      INTEGER, PARAMETER :: adv_nsc_tf  = 14
!     DISTRIBUTIVE PSI SCHEME, EDGE-BASED FOR TIDAL FLATS
      INTEGER, PARAMETER :: adv_psi_tf  = 15
!
!-----------------------------------------------------------------------
!
! 3./ CODE COUPLING
!
      CHARACTER(LEN=PATH_LEN), TARGET :: coupling
!
! 4./ NAME OF CURRENT CODE (SEE BIEF_OPEN_FILES AND CONFIG_CODE)
!
      CHARACTER(LEN=24) :: namecode,nnamecode(6)
!
! 5./ DIFFERENT WAYS OF SPLITTING PRISMS :
!
!     TO ENSURE MATCHING OF TETRAHEDRONS, FACES OF TRIANGLES ARE "SIGNED"
!     WITH 1 OR 2 DEPENDING OF THE GLOBAL NUMBERS OF THEIR POINTS, TAKEN IN
!     COUNTER-CLOCKWISE DIRECTION. A FACE 1 IN A TRIANGLE WILL BE 2 IN ITS
!     NEIGHBOUR AND THIS IS USED TO HAVE A CORRECT SPLITTING. THE SPLITTING
!     DEPENDING ON THE "SIGNS" OF THE 3 FACES IS GIVEN IN ARRAY TETRA.
!
!
!     TETRA(2,2,2,3,4)
!
!     FIRST 3 DIMENSIONS : TYPE OF FACE
!                      1 : CUT RECTANGLE BETWEEN  LOW-LEFT AND HIGH-RIGHT
!                      2 : CUT RECTANGLE BETWEEN  HIGH-LEFT AND LOW-RIGHT
!
!     4TH DIMENSION : NUMBER OF TETRAHEDRON
!     5TH DIMENSION : 4 POINTS OF THE TETRAHEDRON (IN LOCAL PRISM NUMBERING)
!
!     1 1 2 SPLITTING
!
!     TETRA(1,1,2,1,1)= 1
!     TETRA(1,1,2,1,2)= 2
!     TETRA(1,1,2,1,3)= 3
!     TETRA(1,1,2,1,4)= 6
!
!     TETRA(1,1,2,2,1)= 4
!     TETRA(1,1,2,2,2)= 6
!     TETRA(1,1,2,2,3)= 5
!     TETRA(1,1,2,2,4)= 1
!
!     TETRA(1,1,2,3,1)= 5
!     TETRA(1,1,2,3,2)= 2
!     TETRA(1,1,2,3,3)= 1
!     TETRA(1,1,2,3,4)= 6
!
!     2 1 1 SPLITTING
!
!     TETRA(2,1,1,1,1)= 1
!     TETRA(2,1,1,1,2)= 2
!     TETRA(2,1,1,1,3)= 3
!     TETRA(2,1,1,1,4)= 4
!
!     TETRA(2,1,1,2,1)= 4
!     TETRA(2,1,1,2,2)= 6
!     TETRA(2,1,1,2,3)= 5
!     TETRA(2,1,1,2,4)= 2
!
!     TETRA(2,1,1,3,1)= 6
!     TETRA(2,1,1,3,2)= 3
!     TETRA(2,1,1,3,3)= 2
!     TETRA(2,1,1,3,4)= 4
!
!     1 2 1 SPLITTING
!
!     TETRA(1,2,1,1,1)= 1
!     TETRA(1,2,1,1,2)= 2
!     TETRA(1,2,1,1,3)= 3
!     TETRA(1,2,1,1,4)= 5
!
!     TETRA(1,2,1,2,1)= 4
!     TETRA(1,2,1,2,2)= 6
!     TETRA(1,2,1,2,3)= 5
!     TETRA(1,2,1,2,4)= 3
!
!     TETRA(1,2,1,3,1)= 4
!     TETRA(1,2,1,3,2)= 1
!     TETRA(1,2,1,3,3)= 3
!     TETRA(1,2,1,3,4)= 5
!
!     2 2 1 SPLITTING
!
!     TETRA(2,2,1,1,1)= 1
!     TETRA(2,2,1,1,2)= 2
!     TETRA(2,2,1,1,3)= 3
!     TETRA(2,2,1,1,4)= 4
!
!     TETRA(2,2,1,2,1)= 4
!     TETRA(2,2,1,2,2)= 6
!     TETRA(2,2,1,2,3)= 5
!     TETRA(2,2,1,2,4)= 3
!
!     TETRA(2,2,1,3,1)= 5
!     TETRA(2,2,1,3,2)= 2
!     TETRA(2,2,1,3,3)= 4
!     TETRA(2,2,1,3,4)= 3
!
!     1 2 2 SPLITTING
!
!     TETRA(1,2,2,1,1)= 1
!     TETRA(1,2,2,1,2)= 2
!     TETRA(1,2,2,1,3)= 3
!     TETRA(1,2,2,1,4)= 5
!
!     TETRA(1,2,2,2,1)= 4
!     TETRA(1,2,2,2,2)= 6
!     TETRA(1,2,2,2,3)= 5
!     TETRA(1,2,2,2,4)= 1
!
!     TETRA(1,2,2,3,1)= 6
!     TETRA(1,2,2,3,2)= 3
!     TETRA(1,2,2,3,3)= 5
!     TETRA(1,2,2,3,4)= 1
!
!     2 1 2 SPLITTING
!
!     TETRA(2,1,2,1,1)= 1
!     TETRA(2,1,2,1,2)= 2
!     TETRA(2,1,2,1,3)= 3
!     TETRA(2,1,2,1,4)= 6
!
!     TETRA(2,1,2,2,1)= 4
!     TETRA(2,1,2,2,2)= 6
!     TETRA(2,1,2,2,3)= 5
!     TETRA(2,1,2,2,4)= 2
!
!     TETRA(2,1,2,3,1)= 4
!     TETRA(2,1,2,3,2)= 1
!     TETRA(2,1,2,3,3)= 6
!     TETRA(2,1,2,3,4)= 2
!
!     IMPORTANT : ON EACH LAYER THE BOTTOM TETRAHEDRONS MUST BE
!                 TREATED FIRST, SO THAT IKLE SENT TO SUBROUTINE
!                 VOISIN BE THE SAME AS WITH PRISMS OR TRIANGLES
!                 FOR THE NELEM2 FIRST ELEMENTS.
!                 CONSEQUENTLY THE FIRSt 3 POINTS OF TETRAHEDRON 1
!                 ARE ALWAYS 1,2 AND 3.
!
!     TETRA : SEE EXPLANATIONS ABOVE, THE 0 CORRESPOND TO SITUATIONS
!             THAT NEVER HAPPEN (TETRA(1,1,1,... OR TETRA(2,2,2,...)
      INTEGER :: tetra(2,2,2,3,4)
      parameter( tetra = reshape( (/
     &    0,1,1,1,1,1,1,0,0,4,4,4,4,4,4,0,0,6,4,5,5,4,6,0,
     &    0,2,2,2,2,2,2,0,0,6,6,6,6,6,6,0,0,3,1,2,2,1,3,0,
     &    0,3,3,3,3,3,3,0,0,5,5,5,5,5,5,0,0,2,3,4,1,6,5,0,
     &    0,4,5,4,6,6,5,0,0,2,3,3,1,2,1,0,0,4,5,3,6,2,1,0
     &    /), shape=(/ 2,2,2,3,4 /) ) )
!
!     NUMBERING OF SEGMENTS IN A TETRAHEDRON
!     ISEGT(N,I) : POINT NUMBER I OF SEGMENT N. GIVES THE POINT IN
!                  LOCAL NUMBERING
!
      INTEGER :: isegt(6,2)
      parameter( isegt = reshape( (/
     &    1,2,3,1,2,3,2,3,1,4,4,4 /), shape=(/ 6,2 /) ) )
!
! 6./ ASSEMBLY MODE
!
!     1: FINITE ELEMENT ASSEMBLY IN PARALLEL DONE DIRECTLY ON
!        DOUBLE PRECISION VALUES
!
!     2: FINITE ELEMENT ASSEMBLY IN PARALLEL DONE WITH INTEGERS TO AVOID
!        TRUNCATION ERRORS IN PARALLEL, DUE TO DIFFERENT ORDER OF
!        ADDITIONS OF MORE THAN 2 NUMBERS.
!
!     HERE INITIALISED AT 1, IN CASE NO KEYWORD IS DEDICATED TO THIS
!     PARAMETER
!
      INTEGER :: modass = 1
!
!     SAVED VARIABLE
!
      ! TODO: Init values in bief_ini
      ! matvec
      LOGICAL :: w_is_full = .false.
      ! solve
      TYPE(bief_obj)          :: tbb
      TYPE(bief_obj), TARGET  :: bb,bx
      LOGICAL :: first_solve = .true.
      ! paraco
      INTEGER :: paraco_msg_tag = 5000
      ! paracoi
      INTEGER :: paracoi_msg_tag = 5000
      ! paracoi8
      INTEGER :: paracoi8_msg_tag = 5000
      ! cvtrvf_pos_2
      LOGICAL :: deja_cpos2 = .false.
      INTEGER, ALLOCATABLE :: indic_cpos2(:)
      ! positive_depths
      LOGICAL :: deja_pdept_eria = .false.
      INTEGER, ALLOCATABLE :: indic_pdept_eria(:)
      LOGICAL :: deja_pdept_nerd = .false.
      INTEGER, ALLOCATABLE :: indic_pdept_nerd(:)
      ! cvtrvf_pos
      LOGICAL :: deja_cpos = .false.
      INTEGER, ALLOCATABLE :: indic_cpos(:)
      ! sd_solve_1
!     MANAGES THE SIZE OF ALLOCATABLE ARRAYS
      INTEGER :: size_in = 0
      INTEGER :: size_ip = 0
      INTEGER :: size_isegip = 0
      INTEGER :: size_iw1 = 0
      INTEGER :: size_indtri = 0
      INTEGER :: size_inx = 0
      INTEGER :: size_ipx = 0
      INTEGER :: size_ac = 0
      INTEGER :: size_actri = 0
      INTEGER :: size_isp = 0
      INTEGER :: size_rsp = 0
      INTEGER, ALLOCATABLE :: indtri_ss1(:),inx_ss1(:),ipx_ss1(:)
      INTEGER, ALLOCATABLE :: in_ss1(:),ip_ss1(:),isp_ss1(:),iw1_ss1(:)
      INTEGER, ALLOCATABLE :: isegip_ss1(:)
      DOUBLE PRECISION, ALLOCATABLE :: ac_ss1(:),actri_ss1(:),rsp_ss1(:)
      ! sd_solve_4
      INTEGER, ALLOCATABLE          :: gloseg4_ss4(:)
      DOUBLE PRECISION, ALLOCATABLE :: xa_ss4(:),da_ss4(:)
      DOUBLE PRECISION, ALLOCATABLE :: rhs_ss4(:),xinc_ss4(:)
      INTEGER :: size_gloseg4 = 0
      INTEGER :: size_da = 0
      INTEGER :: size_xa = 0
      INTEGER :: size_rhs = 0
      INTEGER :: size_xinc = 0
      ! pre4_mumps
      INTEGER, ALLOCATABLE          :: gloseg4_p4m(:)
      DOUBLE PRECISION, ALLOCATABLE :: xa_p4m(:),da_p4m(:)
      DOUBLE PRECISION, ALLOCATABLE :: rhs_p4m(:),xinc_p4m(:)
      INTEGER :: size_gloseg4_p4m = 0
      INTEGER :: size_da_p4m = 0
      INTEGER :: size_xa_p4m = 0
      INTEGER :: size_rhs_p4m = 0
      INTEGER :: size_xinc_p4m = 0
      ! charac
      LOGICAL :: deja_charac = .false.
      TYPE(bief_obj), TARGET  :: t1weak,t2weak,t3weak,t4weak,t5weak
      TYPE(bief_obj), TARGET  :: t6weak,t7weak,shpwea
      TYPE(bief_obj), TARGET  :: ftild_weak,shpbuf,shzbuf,shzwea
      ! derive
      LOGICAL :: deja_derive = .false.
      LOGICAL :: deja_drogues_utimp = .false.
      TYPE(bief_obj) :: svoid_derive
!     DEFINE VARIABLES THAT ARE USED IN ALGAE TRANSPORT
!     THESE ARE NECESSARY IF NFLOT_MAX IS TOO LARGE
      LOGICAL :: init_alg = .true.
      LOGICAL :: alg_dislodge = .false.
      REAL :: secu_drogues = 1.0
      INTEGER sizebuf2_d
      DOUBLE PRECISION,DIMENSION(:)  ,ALLOCATABLE::buff_1d_d
      DOUBLE PRECISION,DIMENSION(:,:),ALLOCATABLE::buff_2d_d
      INTEGER, DIMENSION(:), ALLOCATABLE :: buff_elt_i
!     VARIABLE FOR DROGUES OUTPUT
      INTEGER iframe
!
! 7./ CHECKING THE MESH
!
!     KEYWORD INITIALISED TO FALSE (MAY BE MODIFIED BY KEYWORDS)
!
      LOGICAL :: check_mesh = .false.
!
!-----------------------------------------------------------------------
!
      INTEGER :: gracjg_cnt = 0

      SAVE
!
!-----------------------------------------------------------------------
!
      END MODULE declarations_telemac