ModInterfacesIO.F90

Go to the documentation of this file.

! *********************************************************************
! * Rocstar Simulation Suite                                          *
! * Copyright@2015, Illinois Rocstar LLC. All rights reserved.        *
! *                                                                   *
! * Illinois Rocstar LLC                                              *
! * Champaign, IL                                                     *
! * www.illinoisrocstar.com                                           *
! * sales@illinoisrocstar.com                                         *
! *                                                                   *
! * License: See LICENSE file in top level of distribution package or *
! * http://opensource.org/licenses/NCSA                               *
! *********************************************************************
! *********************************************************************
! * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,   *
! * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES   *
! * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND          *
! * NONINFRINGEMENT.  IN NO EVENT SHALL THE CONTRIBUTORS OR           *
! * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER       *
! * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,   *
! * Arising FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE    *
! * USE OR OTHER DEALINGS WITH THE SOFTWARE.                          *
! *********************************************************************
!******************************************************************************
!
! Purpose: set explicit interfaces to subroutines and functions
!          related to I/O.
!
! Description: none
!
! Notes: none.
!
!******************************************************************************
!
! $Id: ModInterfacesIO.F90,v 1.9 2008/12/06 08:44:18 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************

MODULE modinterfacesio

  IMPLICIT NONE

  INTERFACE

  INTEGER FUNCTION buildpatchidentifier(iRegion,iPatch)
    INTEGER, INTENT(IN) :: ipatch,iregion
  END FUNCTION buildpatchidentifier

  SUBROUTINE makenumberedkeys(keys,indBegin,string,numBegin,numEnd,numSkip)
    CHARACTER(*), INTENT(inout) :: keys(:)
    CHARACTER(*), INTENT(in)    :: string
    INTEGER,      INTENT(in)    :: indbegin,numbegin,numend,numskip
  END SUBROUTINE makenumberedkeys

  SUBROUTINE readbothregionsection( global,fileID,nvals,nStrVals,keys, &
                                    strkeys,vals,strvals,brbeg,brend,  &
                                    defined,strdefined )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    INTEGER      :: fileid, nvals, nstrvals, brbeg, brend
    CHARACTER(*) :: keys(nvals), strkeys(nstrvals)
    LOGICAL      :: defined(nvals), strdefined(nstrvals)
    REAL(RFREAL) :: vals(nvals)
    CHARACTER(*) :: strvals(nstrvals)
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readbothregionsection

  SUBROUTINE readbothsection( global,fileID,nvals,nStrVals,keys,strKeys, &
                              vals,strvals,defined,strdefined )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    INTEGER      :: fileid, nvals, nstrvals
    CHARACTER(*) :: keys(nvals), strkeys(nstrvals)
    LOGICAL      :: defined(nvals), strdefined(nstrvals)
    REAL(RFREAL) :: vals(nvals)
    CHARACTER(*) :: strvals(nstrvals)
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readbothsection

  SUBROUTINE readaccelerationsection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readaccelerationsection

  SUBROUTINE readflowsection( regions )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE readflowsection

  SUBROUTINE readforcessection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readforcessection

  SUBROUTINE readformatssection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readformatssection

#ifdef RFLO
  SUBROUTINE readgridmotionsection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readgridmotionsection
#endif
#ifdef RFLU
  SUBROUTINE readgridmotionsection(regions)
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE readgridmotionsection
#endif

  SUBROUTINE readinitflowsection(regions)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region), DIMENSION(:), POINTER :: regions
  END SUBROUTINE readinitflowsection

  SUBROUTINE readinputfile( regions )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE readinputfile

  SUBROUTINE readlistsection( global,fileID,key,nCols,nRows,vals,defined )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    INTEGER      :: fileid, ncols, nrows
    CHARACTER(*) :: key
    LOGICAL      :: defined
    REAL(RFREAL), POINTER :: vals(:,:)
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readlistsection
  
  SUBROUTINE readmixturesection(regions)
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE readmixturesection

  SUBROUTINE readmultigridsection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readmultigridsection

  SUBROUTINE readnumericssection( regions )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE readnumericssection

#ifdef RFLO
  SUBROUTINE readpatchsection( global,fileID,nvals,keys,vals,brbeg,brend, &
                               prbeg,prend,distrib,fname,defined )
#endif
#ifdef RFLU
  SUBROUTINE readpatchsection( global,fileID,nvals,keys,vals, &
                               prbeg,prend,distrib,fname,bcname,defined )
#endif
    USE moddatatypes
    USE modglobal, ONLY : t_global
#ifdef RFLO
    INTEGER      :: brbeg, brend
#endif    
    INTEGER      :: fileid, nvals, prbeg, prend, distrib
    CHARACTER(*) :: keys(nvals), fname
#ifdef RFLU
    CHARACTER(*) :: bcname
#endif    
    LOGICAL      :: defined(nvals)
    REAL(RFREAL) :: vals(nvals)
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readpatchsection

  SUBROUTINE readpostsection(global)
    USE modglobal, ONLY: t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readpostsection

  SUBROUTINE readprefixedlistsection( global,fileID,key,nCols,nRows, &
                                      vals,strvals,defined )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    INTEGER      :: fileid, ncols, nrows
    CHARACTER(*) :: key
    LOGICAL      :: defined
    REAL(RFREAL), POINTER :: vals(:,:)
    CHARACTER(*), POINTER :: strvals(:)
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readprefixedlistsection

  SUBROUTINE readprepsection(global)
    USE modglobal, ONLY: t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readprepsection

  SUBROUTINE readprobesection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readprobesection

  SUBROUTINE readrandomsection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readrandomsection

  SUBROUTINE readreferencesection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readreferencesection

#ifdef RFLU
  SUBROUTINE readtimezoomingsection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readtimezoomingsection

  SUBROUTINE readrocketsection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readrocketsection
#endif

  SUBROUTINE readregionsection( global,fileID,nvals,keys,vals, &
                                brbeg,brend,defined )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    INTEGER      :: fileid, nvals, brbeg, brend
    CHARACTER(*) :: keys(nvals)
    LOGICAL      :: defined(nvals)
    REAL(RFREAL) :: vals(nvals)
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readregionsection

  SUBROUTINE readsection( global,fileID,nvals,keys,vals,defined )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    INTEGER      :: fileid, nvals
    CHARACTER(*) :: keys(nvals)
    LOGICAL      :: defined(nvals)
    REAL(RFREAL) :: vals(nvals)
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readsection

  SUBROUTINE readstringsection( global,fileID,nvals,keys,vals,defined )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    INTEGER        :: fileid, nvals
    CHARACTER(*)   :: keys(nvals)
    LOGICAL        :: defined(nvals)
    CHARACTER(*)   :: vals(nvals)
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readstringsection

  SUBROUTINE readthrustsection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readthrustsection

  SUBROUTINE readtimestepsection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readtimestepsection

  SUBROUTINE readtransformsection( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE readtransformsection

  SUBROUTINE readviscositysection( regions )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE readviscositysection

  SUBROUTINE writeconvergence( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE writeconvergence

  SUBROUTINE writetotalmass(regions)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE writetotalmass

  SUBROUTINE writeprobe( regions,iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
    INTEGER :: ireg
  END SUBROUTINE writeprobe

  SUBROUTINE writethrust( global )
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
  END SUBROUTINE writethrust

  END INTERFACE

END MODULE modinterfacesio

!******************************************************************************
!
! RCS Revision history:
!
! $Log: ModInterfacesIO.F90,v $
! Revision 1.9  2008/12/06 08:44:18  mtcampbe
! Updated license.
!
! Revision 1.8  2008/11/19 22:17:29  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.7  2007/04/14 14:29:34  mtcampbe
! Updated for TZ and rocket case constraints
!
! Revision 1.6  2005/10/31 19:26:48  haselbac
! Added interface for ReadMixtureSection
!
! Revision 1.5  2004/06/16 20:00:54  haselbac
! Removed buildFileNameXXX routines
!
! Revision 1.4  2004/04/08 03:17:07  wasistho
! nDummyCells in Rocflo read from INITFLOW section
!
! Revision 1.3  2003/11/21 22:35:51  fnajjar
! Update Random Number Generator
!
! Revision 1.2  2003/08/28 20:05:39  jblazek
! Added acceleration terms.
!
! Revision 1.1  2003/08/11 21:50:00  jblazek
! Splitted ModInterfaces into 4 sections.
!
!******************************************************************************