interface_hermes.f

Go to the documentation of this file.

!                   ***********************
                    MODULE interface_hermes
!                   ***********************
!
!
!***********************************************************************
! HERMES VERSION 7.0                                     26/12/2013
!***********************************************************************
!
!brief    INTERFACES OF HERMES PUBLIC SUBROUTINES
!+
!
!history  Y. AUDOUIN (EDF R&D, LNHE)
!+        24/03/2014
!+        V7P0
!+     Creation of the file.
!
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!
      INTERFACE
!
!-----------------------------------------------------------------------
!
!     DEFINITION OF INTERFACES
!
      SUBROUTINE open_mesh(FFORMAT,FILE_NAME,FILE_ID,OPENMODE,IERR,
     &                     MESH_NUMBER)
      CHARACTER(LEN=8),  INTENT(INOUT) :: FFORMAT
      CHARACTER(LEN=*),  INTENT(IN)    :: FILE_NAME
      INTEGER,           INTENT(OUT)   :: FILE_ID
      CHARACTER(LEN=9),  INTENT(IN)    :: OPENMODE
      INTEGER,           INTENT(OUT)   :: IERR
      INTEGER, OPTIONAL, INTENT(IN)    :: MESH_NUMBER
      END SUBROUTINE
!
      SUBROUTINE close_mesh(FFORMAT,FID,IERR,MESH_NUMBER)
      CHARACTER(LEN=8),  INTENT(IN)  :: FFORMAT
      INTEGER,           INTENT(IN)  :: FID
      INTEGER,           INTENT(OUT) :: IERR
      INTEGER, OPTIONAL, INTENT(IN)  :: MESH_NUMBER
      END SUBROUTINE
!
      SUBROUTINE open_bnd(FFORMAT,FNAME,FID,OPENMODE,IERR,MESH_NUMBER)
      CHARACTER(LEN=8),  INTENT(IN)  :: FFORMAT
      INTEGER,           INTENT(IN)  :: FID
      CHARACTER(LEN=*),  INTENT(IN)  :: FNAME
      CHARACTER(LEN=9),  INTENT(IN)  :: OPENMODE
      INTEGER,           INTENT(OUT) :: IERR
      INTEGER, OPTIONAL, INTENT(IN)  :: MESH_NUMBER
      END SUBROUTINE
!
      SUBROUTINE close_bnd(FFORMAT,FID,IERR,MESH_NUMBER)
      CHARACTER(LEN=8),  INTENT(IN)  :: FFORMAT
      INTEGER,           INTENT(IN)  :: FID
      INTEGER,           INTENT(OUT) :: IERR
      INTEGER, OPTIONAL, INTENT(IN)  :: MESH_NUMBER
      END SUBROUTINE
!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!     Reading section
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
!     --Mesh
!
      SUBROUTINE get_mesh_title(FFORMAT,FID,TITLE,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      CHARACTER(LEN=80), INTENT(OUT) :: TITLE
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_mesh_date(FFORMAT,FID,DATE,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(INOUT) :: DATE(6)
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE

      SUBROUTINE get_mesh_nelem(FFORMAT,FID,TYP_ELEM,NELEM,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(IN) :: TYP_ELEM
      INTEGER, INTENT(OUT) :: NELEM
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_mesh_npoin_per_element(FFORMAT,FID,TYP_ELEM,
     &                                      NDP,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(IN) :: TYP_ELEM
      INTEGER, INTENT(OUT) :: NDP
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_mesh_connectivity(FFORMAT,FID,TYP_ELEM,IKLE,
     &                                 NELEM,NDP,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(IN) :: TYP_ELEM
      INTEGER, INTENT(IN) :: NELEM
      INTEGER, INTENT(IN) :: NDP
      INTEGER, INTENT(INOUT) :: IKLE(nelem*ndp)
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE

      SUBROUTINE get_mesh_npoin(FFORMAT,FID,TYP_ELEM,NPOIN,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(IN) :: TYP_ELEM
      INTEGER, INTENT(OUT) :: NPOIN
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_mesh_nplan(FFORMAT,FID,NPLAN,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(OUT) :: NPLAN
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_mesh_dimension(FFORMAT,FID,NDIM,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(OUT) :: NDIM
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_mesh_orig(FFORMAT,FID,X_ORIG,Y_ORIG,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(INOUT) :: X_ORIG, Y_ORIG
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_mesh_coord(FFORMAT,FID,JDIM,NDIM,NPOIN,COORD,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID,JDIM,NDIM,NPOIN
      DOUBLE PRECISION, INTENT(INOUT) :: COORD(npoin)
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE get_mesh_l2g_numbering(FFORMAT,FID,KNOLG,NPOIN,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(IN) :: NPOIN
      INTEGER, INTENT(INOUT) :: KNOLG(npoin)
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_mesh_nptir(FFORMAT,FID,NPTIR,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(OUT) :: NPTIR
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
!
!     --Boundary conditions
!
      SUBROUTINE get_bnd_ipobo(FFORMAT,FID,NPOIN,NELEBD,TYP_ELEM_BND,
     & IPOBO,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID,NPOIN,NELEBD,TYP_ELEM_BND
      INTEGER, INTENT(INOUT) :: IPOBO(npoin)
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE get_bnd_numbering(FFORMAT,FID,TYP_ELEM_BND,NPTFR,
     & NBOR,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID,NPTFR,TYP_ELEM_BND
      INTEGER, INTENT(INOUT) :: NBOR(nptfr)
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE get_bnd_connectivity(FFORMAT,FID,TYP_BND_ELEM,NELEBD,
     &                                NDP,IKLE_BND,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID,TYP_BND_ELEM,NELEBD,NDP
      INTEGER, INTENT(INOUT) :: IKLE_BND(ndp*nelebd)
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE get_bnd_npoin(FFORMAT,FID,TYPE_BND_ELEM,NPTFR,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(IN) :: TYPE_BND_ELEM
      INTEGER, INTENT(OUT) :: NPTFR
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE get_bnd_nelem(FFORMAT,FID,TYPE_BND_ELEM,NELEM,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(IN) :: TYPE_BND_ELEM
      INTEGER, INTENT(OUT) :: NELEM
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE get_bnd_value
     &(fformat,fid,typ_bnd_elem,nelebd,lihbor,liubor,
     & livbor,hbor,ubor,vbor,chbord,trac,
     & litbor,tbor,atbor,btbor,nptfr,ierr)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(IN) :: TYP_BND_ELEM
      INTEGER, INTENT(IN) :: NELEBD
      INTEGER, INTENT(IN) :: NPTFR
      INTEGER,          INTENT(INOUT) :: LIUBOR(nptfr),LIVBOR(nptfr)
      INTEGER,          INTENT(INOUT) :: LIHBOR(nptfr),LITBOR(*)
      DOUBLE PRECISION, INTENT(INOUT) :: UBOR(*),VBOR(*)
      DOUBLE PRECISION, INTENT(INOUT) :: HBOR(nptfr),CHBORD(nptfr)
      DOUBLE PRECISION, INTENT(INOUT) :: TBOR(*),ATBOR(*)
      DOUBLE PRECISION, INTENT(INOUT) :: BTBOR(*)
      LOGICAL,          INTENT(IN)    :: TRAC
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
!
!     --Data
!
      SUBROUTINE get_data_nvar(FFORMAT,FID,NVAR,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(OUT) :: NVAR
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_data_var_list(FFORMAT,FID,NVAR,VARLIST,UNITLIST,
     &                             IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(IN) :: NVAR
      CHARACTER(LEN=16), INTENT(INOUT) :: VARLIST(nvar)
      CHARACTER(LEN=16), INTENT(INOUT) :: UNITLIST(nvar)
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_data_ntimestep(FFORMAT,FID,NTIMESTEP,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(OUT) :: NTIMESTEP
      INTEGER, INTENT(INOUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_data_time(FFORMAT,FID,RECORD,TIME,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(IN) :: RECORD
      DOUBLE PRECISION, INTENT(OUT) :: TIME
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_data_timestep(FFORMAT,FID,RECORD,TIME,IERR)
      CHARACTER(LEN=8), INTENT(IN)  :: FFORMAT
      INTEGER,          INTENT(IN)  :: FID
      INTEGER,          INTENT(OUT) :: RECORD
      DOUBLE PRECISION, INTENT(IN)  :: TIME
      INTEGER,          INTENT(OUT) :: IERR
      END SUBROUTINE
      SUBROUTINE get_data_value(FFORMAT,FID,RECORD,VAR_NAME,
     &                          RES_VALUE,N,IERR)
      CHARACTER(LEN=8), INTENT(IN) :: FFORMAT
      INTEGER, INTENT(IN) :: FID
      INTEGER, INTENT(IN) :: RECORD
      CHARACTER(LEN=16), INTENT(IN) :: VAR_NAME
      INTEGER, INTENT(IN) :: N
      DOUBLE PRECISION, INTENT(INOUT) :: RES_VALUE(n)
      INTEGER, INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE lit
     &( x , w , i , c , nval , TYPE , canal , std2 , istat )
      INTEGER, INTENT(IN)             :: NVAL,CANAL
      INTEGER, INTENT(INOUT)          :: ISTAT
      CHARACTER(LEN=*), INTENT(IN)       :: TYPE,STD2
      INTEGER, INTENT(INOUT)          :: I(*)
      DOUBLE PRECISION, INTENT(INOUT) :: X(*)
      REAL, INTENT(INOUT)             :: W(*)
      CHARACTER(LEN=*), INTENT(INOUT)    :: C
      END SUBROUTINE
!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!     Writing section
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
!
      SUBROUTINE set_header
     &(fformat,file_id,title,nvar,var_name,ierr)
      CHARACTER(LEN=8),                 INTENT(IN)  :: FFORMAT
      INTEGER,                          INTENT(IN)  :: FILE_ID
      CHARACTER(LEN=80),                INTENT(IN)  :: TITLE
      INTEGER,                          INTENT(IN)  :: NVAR
      CHARACTER(LEN=32),                INTENT(IN)  :: VAR_NAME(nvar)
      INTEGER,                          INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE set_mesh(FFORMAT,FILE_ID,MESH_DIM,TYPELM,NDP,NPTFR,
     &                    NPTIR,NELEM,NPOIN,IKLES,IPOBO,
     &                    KNOLG,X,Y,NPLAN,DATE,TIME,X_ORIG,Y_ORIG,
     &                    IERR,Z,IN_PLACE)
      CHARACTER(LEN=8), INTENT(IN)  :: FFORMAT
      INTEGER,          INTENT(IN)  :: FILE_ID,NPLAN
      INTEGER,          INTENT(IN)  :: DATE(3)
      INTEGER,          INTENT(IN)  :: TIME(3)
      INTEGER,          INTENT(IN)  :: MESH_DIM
      INTEGER,          INTENT(IN)  :: TYPELM
      INTEGER,          INTENT(IN)  :: NDP
      INTEGER,          INTENT(IN)  :: NPTFR
      INTEGER,          INTENT(IN)  :: NPTIR
      INTEGER,          INTENT(IN)  :: NELEM
      INTEGER,          INTENT(IN)  :: NPOIN
      INTEGER,          INTENT(IN)  :: X_ORIG
      INTEGER,          INTENT(IN)  :: Y_ORIG
      INTEGER,          INTENT(IN)  :: IKLES(nelem*ndp)
      INTEGER,          INTENT(IN)  :: IPOBO(*)
      INTEGER,          INTENT(IN)  :: KNOLG(*)
      DOUBLE PRECISION, INTENT(IN)  :: X(npoin),Y(npoin)
      INTEGER,          INTENT(OUT) :: IERR
      DOUBLE PRECISION, INTENT(IN), OPTIONAL :: Z(*)
      LOGICAL,          INTENT(IN), OPTIONAL :: IN_PLACE
      END SUBROUTINE
!
      SUBROUTINE add_data(FFORMAT,FILE_ID,VAR_NAME,TIME,RECORD,
     &                    FIRST_VAR,VAR_VALUE,N,IERR)
      CHARACTER(LEN=8),  INTENT(IN)  :: FFORMAT
      INTEGER,           INTENT(IN)  :: FILE_ID,N
      CHARACTER(LEN=32), INTENT(IN)  :: VAR_NAME
      DOUBLE PRECISION,  INTENT(IN)  :: TIME
      INTEGER,           INTENT(IN)  :: RECORD
      LOGICAL,           INTENT(IN)  :: FIRST_VAR
      DOUBLE PRECISION,  INTENT(IN)  :: VAR_VALUE(n)
      INTEGER,           INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE update_data_mesh(FFORMAT,FILE_ID,TIME,RECORD,
     &                            NB_DIM_MESH,NPOIN,COORD,IERR)
      CHARACTER(LEN=8),  INTENT(IN)  :: FFORMAT
      INTEGER,           INTENT(IN)  :: FILE_ID
      DOUBLE PRECISION,  INTENT(IN)  :: TIME
      INTEGER,           INTENT(IN)  :: RECORD
      INTEGER,           INTENT(IN)  :: NB_DIM_MESH, NPOIN
      DOUBLE PRECISION,  INTENT(IN)  :: COORD(nb_dim_mesh*npoin)
      INTEGER,           INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE transfer_group_info
     &(fformat,fid,fid2,type_elt,type_bnd_elt,ikle_bnd,nelebd,ndp,
     & trans_elem,trans_point,ierr)
      CHARACTER(LEN=8), INTENT(IN)  :: FFORMAT
      INTEGER,          INTENT(IN)  :: FID, FID2
      INTEGER,          INTENT(IN)  :: NELEBD
      INTEGER,          INTENT(IN)  :: NDP
      INTEGER,          INTENT(IN)  :: IKLE_BND(*)
      INTEGER,          INTENT(IN)  :: TYPE_ELT
      INTEGER,          INTENT(IN)  :: TYPE_BND_ELT
      LOGICAL,          INTENT(IN)  :: TRANS_ELEM
      LOGICAL,          INTENT(IN)  :: TRANS_POINT
      INTEGER,          INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE transfer_group_part_info
     &(fformat,source_id, dest_id,
     & typ_bnd_elem, ikle_bnd_dest, nelebd_dest,
     & ndp_dest, nelebd_src, knolg_bnd,
     & trans_point, npoin_src, npoin_dest, knolg, ierr)
      CHARACTER(LEN=8), INTENT(IN)  :: FFORMAT
      INTEGER,          INTENT(IN)  :: SOURCE_ID
      INTEGER,          INTENT(IN)  :: DEST_ID
      INTEGER,          INTENT(IN)  :: NELEBD_DEST
      INTEGER,          INTENT(IN)  :: NDP_DEST
      INTEGER,       INTENT(IN)  :: IKLE_BND_DEST(nelebd_dest*ndp_dest)
      INTEGER,          INTENT(IN)  :: TYP_BND_ELEM
      INTEGER,          INTENT(IN)  :: NELEBD_SRC
      INTEGER,          INTENT(IN)  :: KNOLG_BND(nelebd_src)
      LOGICAL,          INTENT(IN)  :: TRANS_POINT
      INTEGER,          INTENT(IN)  :: NPOIN_SRC
      INTEGER,          INTENT(IN)  :: NPOIN_DEST
      INTEGER,          INTENT(IN)  :: KNOLG(npoin_dest)
      INTEGER,          INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE set_bnd
     &(fformat,fid,type_bnd_elt,nelebd,ndp,ikle,nptfr,
     & lihbor,liubor,livbor,hbor,ubor,vbor,chbord,
     & litbor,tbor,atbor,btbor,color,ierr)
      CHARACTER(LEN=8), INTENT(IN)  :: FFORMAT
      INTEGER,          INTENT(IN)  :: FID
      INTEGER,          INTENT(IN)  :: TYPE_BND_ELT
      INTEGER,          INTENT(IN)  :: NELEBD
      INTEGER,          INTENT(IN)  :: NDP
      INTEGER,          INTENT(IN)  :: IKLE(nelebd*ndp)
      INTEGER,          INTENT(IN)  :: NPTFR
      INTEGER,          INTENT(IN)  :: LIUBOR(nptfr),LIVBOR(nptfr)
      INTEGER,          INTENT(IN)  :: LIHBOR(nptfr),LITBOR(nptfr)
      DOUBLE PRECISION, INTENT(IN)  :: UBOR(nptfr),VBOR(nptfr)
      DOUBLE PRECISION, INTENT(IN)  :: HBOR(nptfr),CHBORD(nptfr)
      DOUBLE PRECISION, INTENT(IN)  :: TBOR(nptfr),ATBOR(nptfr)
      DOUBLE PRECISION, INTENT(IN)  :: BTBOR(nptfr)
      INTEGER,          INTENT(IN)  :: COLOR(nptfr)
      INTEGER,          INTENT(OUT) :: IERR
      END SUBROUTINE
!
      SUBROUTINE ecri2
     &(x , i , c , nval , TYPE , canal , std , istat)
      INTEGER, INTENT(IN) :: NVAL,CANAL
      DOUBLE PRECISION, INTENT(IN) :: X(*)
      INTEGER, INTENT(IN) :: I(*)
      CHARACTER(LEN=*), INTENT(IN) :: TYPE,STD,C
      INTEGER, INTENT(OUT) :: ISTAT
      END SUBROUTINE
!
      SUBROUTINE get_error_message(MESSAGE)
      CHARACTER(LEN=200), INTENT(OUT) :: MESSAGE
      END SUBROUTINE
!
      END INTERFACE


!
!=======================================================================
!
      END MODULE interface_hermes