PREP_ModInterfaces.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.
!
! Description: none
!
! Notes: none.
!
!******************************************************************************
!
! $Id: PREP_ModInterfaces.F90,v 1.6 2008/12/06 08:44:50 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************
  
MODULE prep_modinterfaces

  IMPLICIT NONE

  INTERFACE

  SUBROUTINE buildversionstring( versionString )
    CHARACTER(*) :: versionstring
  END SUBROUTINE buildversionstring

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

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

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

  SUBROUTINE initializeflowfield( iLev,region )
    USE moddatastruct, ONLY : t_region
    INTEGER :: ilev
    TYPE(t_region) :: region
  END SUBROUTINE initializeflowfield

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

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

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

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

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

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

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

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

  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 rflo_copygeometrydummy( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
  END SUBROUTINE rflo_copygeometrydummy

  SUBROUTINE rflo_extrapolategeometry( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
  END SUBROUTINE rflo_extrapolategeometry

  SUBROUTINE rflo_generatecoarsegrids( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
  END SUBROUTINE rflo_generatecoarsegrids

  SUBROUTINE rflo_getdimensdummy( region,iLev,idcbeg,idcend,jdcbeg,jdcend, &
                                  kdcbeg,kdcend )
    USE moddatastruct, ONLY : t_region
    INTEGER        :: ilev, idcbeg, idcend, jdcbeg, jdcend, kdcbeg, kdcend
    TYPE(t_region) :: region
  END SUBROUTINE rflo_getdimensdummy

  SUBROUTINE rflo_getcelloffset( region,iLev,iCellOffset,ijCellOffset )
    USE moddatastruct, ONLY : t_region
    INTEGER        :: ilev, icelloffset, ijcelloffset
    TYPE(t_region) :: region
  END SUBROUTINE rflo_getcelloffset

  SUBROUTINE rflo_getnodeoffset( region,iLev,iNodeOffset,ijNodeOffset )
    USE moddatastruct, ONLY : t_region
    INTEGER        :: ilev, inodeoffset, ijnodeoffset
    TYPE(t_region) :: region
  END SUBROUTINE rflo_getnodeoffset

  SUBROUTINE rflo_getdimensdummynodes( region,iLev,idnbeg,idnend,jdnbeg,jdnend,&
                                       kdnbeg,kdnend )
    USE moddatastruct, ONLY : t_region
    INTEGER        :: ilev, idnbeg, idnend, jdnbeg, jdnend, kdnbeg, kdnend
    TYPE(t_region) :: region
  END SUBROUTINE rflo_getdimensdummynodes

  SUBROUTINE rflo_getpatchindicesnodes( region,patch,iLev,ibeg,iend, &
                                        jbeg,jend,kbeg,kend )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    INTEGER        :: ilev, ibeg, iend, jbeg, jend, kbeg, kend
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE rflo_getpatchindicesnodes

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

  SUBROUTINE rflo_readregiontopology( global,regions )
    USE moddatastruct, ONLY : t_region
    USE modglobal, ONLY     : t_global
    TYPE(t_global), POINTER :: global
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE rflo_readregiontopology

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

#ifdef GENX
  SUBROUTINE rflo_initgenxinterfaceprep( iReg,region,wins,winv )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    INTEGER :: ireg
    TYPE(t_region) :: region
    CHARACTER(CHRLEN) :: wins, winv
  END SUBROUTINE rflo_initgenxinterfaceprep 
                                   
  SUBROUTINE genxinitsolution( gridLevel,iReg,regions,wins,winv )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    INTEGER :: gridlevel, ireg
    TYPE(t_region), POINTER :: regions(:)
    CHARACTER(CHRLEN) :: wins, winv
  END SUBROUTINE genxinitsolution

  SUBROUTINE genxwritesolution( gridLevel,iReg,region,wins,winv )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    INTEGER :: gridlevel, ireg
    TYPE(t_region) :: region
    CHARACTER(CHRLEN) :: wins, winv
  END SUBROUTINE genxwritesolution

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

  END INTERFACE

END MODULE prep_modinterfaces

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PREP_ModInterfaces.F90,v $
! Revision 1.6  2008/12/06 08:44:50  mtcampbe
! Updated license.
!
! Revision 1.5  2008/11/19 22:18:00  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.4  2005/09/30 00:14:24  wasistho
! added post read grid processing routines
!
! Revision 1.3  2005/05/02 18:07:45  wasistho
! added cylindrical Taylor inflow profile capability
!
! Revision 1.2  2004/12/03 03:29:57  wasistho
! rflo_modinterfacesprep to prep_modinterfaces
!
! Revision 1.1  2004/12/03 02:20:08  wasistho
! added prefix
!
! Revision 1.5  2004/07/27 20:28:48  wasistho
! added readBcInputFile and checkBcValidity
!
! Revision 1.4  2004/07/27 03:36:35  wasistho
! add printPrepInput
!
! Revision 1.3  2004/07/23 04:31:18  wasistho
! Genx: readin from Rocin, standalone: read .inp file i.o. command line input
!
! Revision 1.2  2004/06/30 00:00:12  wasistho
! migrated to Roccom-3
!
! Revision 1.1  2003/03/20 22:29:29  haselbac
! Initial revision
!
! Revision 1.5  2002/09/05 17:40:22  jblazek
! Variable global moved into regions().
!
! Revision 1.4  2002/06/14 17:35:11  jblazek
! Added version string.
!
! Revision 1.3  2002/06/07 16:40:37  jblazek
! Grid & solution for all regions in one file.
!
! Revision 1.2  2002/02/21 23:25:06  jblazek
! Blocks renamed as regions.
!
! Revision 1.1  2002/01/02 15:57:08  jblazek
! Added flow initialization.
!
!******************************************************************************