declarations_parallel.F

Go to the documentation of this file.

!                   ****************************
                    MODULE declarations_parallel
!                   ****************************
!
!***********************************************************************
! PARALLEL VERSION V7P3
!***********************************************************************
!
!brief     Creating a declaration wrapper for some of the MPI keywords
!+   that are used in other declarations.
!+   The variables defined in the MPI module / include are also
!+   declared with dummy values when used in scalar mode.
!
!history  JAN RIEHME  (ADJOINTWARE)
!+
!+        V7P3
!+   Allowing for a switch from the include 'mpif.h'
!+     to the 'USE MPI' module.
!
!history  S.E. BOURBAN (HRW)
!+        17/03/2017
!+        V7P3
!+   Further simplifying the switch with USE MPI and debugging the
!+     use in scalar mode.
!
!warning  JAN RIEHME  (ADJOINTWARE )
!+   For a system-wide installed OpenMPI the parameter MPI_ADDRESS_KIND
!+     has a compiler dependent value (for instance, gfortran :8).
!+   This value might not be invalid for others, so it is no good idea
!+     to use any sort of kind parameters exported by MPI, if a
!+     compiler independent MPI installation should be used.
!+   Solution: Define your own constants ... MY_ADDRESS_KIND
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
!
!+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
!
#if defined HAVE_MPI
!
#  if defined HAVE_MPI_MOD
        USE mpi
        IMPLICIT NONE
        INTEGER, PARAMETER :: my_address_kind = mpi_address_kind
#  else
        IMPLICIT NONE
        include 'mpif.h'
!       DEFINE 4-BYTE INTEGER KIND (PORTABLE) FOR MPI ADDRESSES
        INTEGER, PARAMETER :: my_address_kind = selected_int_kind(16)
#  endif
!
        INTEGER wait_req_paraco(mpi_status_size,100)
        INTEGER :: comm = mpi_comm_world
        CHARACTER(LEN=MPI_MAX_ERROR_STRING):: mpi_error_msg
        INTEGER mpi_error_len
#else
        IMPLICIT NONE
        INTEGER, PARAMETER :: my_address_kind = selected_int_kind(16)
        INTEGER, PARAMETER :: mpi_integer = 0
        INTEGER, PARAMETER :: mpi_double_precision = 0
        INTEGER, PARAMETER :: mpi_ub = 0
        INTEGER, PARAMETER :: mpi_comm_world = -1
        INTEGER, PARAMETER :: mpi_success =0
        INTEGER :: comm=0
!
!   Define AMPI_TYPE parameter for non-MPI compilation,
!     only required for oil_org_charac_type.F (there is
!       a  #ifdef HAVE_MPI missing ...)
#  ifdef COMPAD
        INTEGER, PARAMETER :: ampi_type = -333
#  endif
#endif
!
!------------------------------------------------------------------------
!
        TYPE charac_type
          sequence   ! BUT SEEMS USELESS (HENCE TRICK BELOW WITH VOID)
          INTEGER :: mypid ! PARTITION OF THE TRACEBACK ORIGIN (HEAD)
          INTEGER :: nepid ! THE NEIGHBOUR PARTITION THE TRACEBACK ENTERS TO
          INTEGER :: ine   ! THE LOCAL 2D ELEMENT NR THE TRACEBACK ENTERS IN THE NEIGBOUR PARTITION
          INTEGER :: kne   ! THE LOCAL LEVEL THE TRACEBACK ENTERS IN THE NEIGBOUR PARTITION
          INTEGER :: ior   ! THE POSITION OF THE TRAJECTORY -HEAD- IN MYPID [THE 2D/3D NODE OF ORIGIN]
          INTEGER :: isp   ! CURRENT RUNGE-KUTTA STEPS PASSED AS COLLECTED
          INTEGER :: nsp   ! TOTAL RUNGE-KUTTA STEPS
          INTEGER :: ifr   ! TRICK FOR ALIGNMENT
          DOUBLE PRECISION :: xp,yp,zp,fp             ! THE (X,Y,Z)-POSITION NOW
          DOUBLE PRECISION :: dx,dy,dz,df             ! THE DISPLACEMENTS
          DOUBLE PRECISION :: basket(10) ! VARIABLES INTERPOLATED AT THE FOOT
        END TYPE charac_type
!
!------------------------------------------------------------------------
!
        TYPE alg_type
          sequence   ! NECESSARY TO DEFINE MPI TYPE ALG_CHAR
          INTEGER :: mypid ! PARTITION OF THE TRACEBACK ORIGIN (HEAD)
          INTEGER :: nepid ! THE NEIGHBOUR PARTITION THE TRACEBACK ENTERS TO
          INTEGER :: iglob  ! THE GLOBAL NUMBER OF THE PARTICLES
          INTEGER :: flag  ! USED TO ALIGN FIELDS
          INTEGER :: iclass ! THE ALGAE CLASS
          INTEGER :: dislodge ! 0 : NOT DISLODGED. 1 : DISLODGED.
          DOUBLE PRECISION :: vx,vy,vz  ! THE (X,Y,Z) PARTICLE VELOCITY
          DOUBLE PRECISION :: ux,uy,uz  ! THE (X,Y,Z) FLUID VELOCITY
          DOUBLE PRECISION :: ux_av,uy_av,uz_av  ! THE (X,Y,Z) AVERAGE FLUID VELOCITY
          DOUBLE PRECISION :: k_av,eps_av  ! THE VALUES OF K AND EPS
          DOUBLE PRECISION :: h_flu  ! THE WATER DEPTH AT POSITION OF VELOCITY
          DOUBLE PRECISION :: teff ! EFFECTIVE TIME OF ALGAE DEGRADATION
          DOUBLE PRECISION :: psi(3*101) ! VARIABLE PSI USED FOR THE BASSET FORCE
        END TYPE alg_type
!
!------------------------------------------------------------------------
!
        TYPE oil_type
          sequence
          INTEGER :: mypid ! PARTITION OF THE TRACEBACK ORIGIN (HEAD)
          INTEGER :: nepid ! THE NEIGHBOUR PARTITION THE TRACEBACK ENTERS TO
          INTEGER :: ine   ! THE LOCAL 2D ELEMENT NR THE TRACEBACK ENTERS IN THE NEIGBOUR PARTITION
          INTEGER :: kne   ! THE LOCAL LEVEL THE TRACEBACK ENTERS IN THE NEIGBOUR PARTITION
          INTEGER :: ior   ! THE POSITION OF THE TRAJECTORY -HEAD- IN MYPID [THE 2D/3D NODE OF ORIGIN]
          INTEGER :: state   ! CURRENT RUNGE-KUTTA STEPS PASSED AS COLLECTED
          INTEGER :: tpsech   ! TOTAL RUNGE-KUTTA STEPS
          INTEGER :: ifr   ! FREQUENCY
          DOUBLE PRECISION :: surface
          DOUBLE PRECISION :: mass0
          DOUBLE PRECISION :: mass
          DOUBLE PRECISION :: mass_evap
          DOUBLE PRECISION :: mass_diss
          DOUBLE PRECISION :: mass_hap(10)
          DOUBLE PRECISION :: mass_compo(10)
          DOUBLE PRECISION :: tb_hap(10)
          DOUBLE PRECISION :: tb_compo(10)
          DOUBLE PRECISION :: sol_hap(10)
          DOUBLE PRECISION :: sol_compo(10)
        END TYPE oil_type
!
!=======================================================================
!
      END MODULE