TURB_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 of TURB subroutines and functions.
!
! Description: none
!
! Notes: none.
!
!******************************************************************************
!
! $Id: TURB_ModInterfaces.F90,v 1.28 2008/12/06 08:44:42 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************
  
MODULE turb_modinterfaces

  IMPLICIT NONE

  INTERFACE

! =============================================================================
! Interfaces to external code
! =============================================================================

#ifdef RFLO
  SUBROUTINE turb_calcstrainrate( region,ibn,ien,grIndx,gradi,gradj,gradk, &
                                  sratei,sratej,sratek )
#endif
#ifdef RFLU
  SUBROUTINE turb_calcstrainrate( region,ibn,ien,grIndx,gradf,sRateI )
#endif
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER        :: ibn, ien
#ifdef RFLO
    INTEGER        :: grindx(9)
    REAL(RFREAL), POINTER :: gradi(:,:),gradj(:,:),gradk(:,:)
    REAL(RFREAL), POINTER :: sratei(:,:),sratej(:,:),sratek(:,:)
#endif
#ifdef RFLU
    INTEGER        :: grindx(3)
    REAL(RFREAL), POINTER :: gradf(:,:,:)
    REAL(RFREAL), POINTER :: sratei(:,:)
#endif
  END SUBROUTINE turb_calcstrainrate

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

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

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

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

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

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

  SUBROUTINE turb_lescalceddyvis( region,ibn,ien,ijk )
    USE moddatastruct, ONLY : t_region
#ifdef RFLO
    TYPE(t_region), TARGET  :: region
#endif
#ifdef RFLU
    TYPE(t_region), POINTER :: region
#endif
    INTEGER                 :: ibn,ien,ijk
  END SUBROUTINE turb_lescalceddyvis

  SUBROUTINE turb_lescoefdynmixd( region,ibn,ien,ijk )
    USE moddatastruct, ONLY : t_region
#ifdef RFLO
    TYPE(t_region), TARGET  :: region
#endif
#ifdef RFLU
    TYPE(t_region), POINTER :: region
#endif
    INTEGER                 :: ibn,ien,ijk
  END SUBROUTINE turb_lescoefdynmixd

  SUBROUTINE turb_lescoefdynsmag( region,ibn,ien,ijk )
    USE moddatastruct, ONLY : t_region
#ifdef RFLO
    TYPE(t_region), TARGET  :: region
#endif
#ifdef RFLU
    TYPE(t_region), POINTER :: region
#endif
    INTEGER                 :: ibn,ien,ijk
  END SUBROUTINE turb_lescoefdynsmag

  SUBROUTINE turb_lescontract( region,ijk )
    USE moddatastruct, ONLY : t_region
#ifdef RFLO
    TYPE(t_region)          :: region
#endif
#ifdef RFLU
    TYPE(t_region), POINTER :: region
#endif
    INTEGER                 :: ijk
  END SUBROUTINE turb_lescontract

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

  SUBROUTINE turb_lesfluxfixsmag( region,ibn,ien )
    USE moddatastruct, ONLY : t_region
#ifdef RFLO
    TYPE(t_region)          :: region
#endif
#ifdef RFLU
    TYPE(t_region), POINTER :: region
#endif
    INTEGER                 :: ibn,ien
  END SUBROUTINE turb_lesfluxfixsmag

  SUBROUTINE turb_lesfluxscalsim( region,ibn,ien )
    USE moddatastruct, ONLY : t_region
#ifdef RFLO
    TYPE(t_region), TARGET  :: region
#endif
#ifdef RFLU
    TYPE(t_region), POINTER :: region
#endif
    INTEGER                 :: ibn,ien
  END SUBROUTINE turb_lesfluxscalsim

  SUBROUTINE turb_lesgeteddyvis( region,ibc,iec,ibn,ien )
    USE moddatastruct, ONLY : t_region
#ifdef RFLO
    TYPE(t_region), TARGET  :: region
#endif
#ifdef RFLU
    TYPE(t_region), POINTER :: region
#endif
    INTEGER        :: ibc,iec,ibn,ien
  END SUBROUTINE turb_lesgeteddyvis

  SUBROUTINE turb_leshij( region,ijk )
    USE moddatastruct, ONLY : t_region
#ifdef RFLO
    TYPE(t_region)          :: region
#endif
#ifdef RFLU
    TYPE(t_region), POINTER :: region
#endif
    INTEGER                 :: ijk
  END SUBROUTINE turb_leshij

  SUBROUTINE turb_leslij( region,ijk,nDel,lij )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
#ifdef RFLO
    TYPE(t_region)          :: region
#endif
#ifdef RFLU
    TYPE(t_region), POINTER :: region
#endif
    INTEGER                 :: ijk,ndel(diri:dirk)
    REAL(RFREAL), POINTER   :: lij(:,:)
  END SUBROUTINE turb_leslij

  SUBROUTINE turb_lesmij( region,ijk )
    USE moddatastruct, ONLY : t_region
#ifdef RFLO
    TYPE(t_region)          :: region
#endif
#ifdef RFLU
    TYPE(t_region), POINTER :: region
#endif
    INTEGER                 :: ijk
  END SUBROUTINE turb_lesmij

  SUBROUTINE turb_lesrkinit( region,iStage )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER :: istage
  END SUBROUTINE turb_lesrkinit

  SUBROUTINE turb_lestestrhov( region,ibc,iec )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER        :: ibc,iec
  END SUBROUTINE turb_lestestrhov

  SUBROUTINE turb_ransemsinit( region,iStage )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER :: istage
  END SUBROUTINE turb_ransemsinit

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

  SUBROUTINE turb_ransrkinit( region, iStage )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER :: istage
  END SUBROUTINE turb_ransrkinit

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

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

  SUBROUTINE turb_ranssavisflux( region )
    USE moddatastruct, ONLY : t_region
#ifdef RFLO
    TYPE(t_region) :: region
#endif
#ifdef RFLU
    TYPE(t_region), POINTER :: region
#endif
  END SUBROUTINE turb_ranssavisflux

  SUBROUTINE turb_ranssavisfluxpatch( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_ranssavisfluxpatch

  SUBROUTINE turb_ranstotaltv( region,indxMu,indxTCo,tvt )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER        :: indxmu, indxtco
    REAL(RFREAL), POINTER :: tvt(:,:)
  END SUBROUTINE turb_ranstotaltv

  SUBROUTINE turb_ranswalldistovpatch( region,patch )  
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_ranswalldistovpatch

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

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

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

  SUBROUTINE turb_statccollector( region,iBegSt,iEndSt,colVar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER        :: ibegst, iendst
    REAL(RFREAL), POINTER :: colvar(:,:)
  END SUBROUTINE turb_statccollector

#ifdef RFLO
  SUBROUTINE turb_statfcollector( region,ijk,iBegSt,iEndSt,colVar )
#endif
#ifdef RFLU
  SUBROUTINE turb_statfcollector( region,ijk,iBegSt,iEndSt,colVar,colBVar )
#endif
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER        :: ijk, ibegst, iendst
    REAL(RFREAL), POINTER :: colvar(:,:)
#ifdef RFLU
    REAL(RFREAL), POINTER :: colbvar(:,:)
#endif
  END SUBROUTINE turb_statfcollector

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

  SUBROUTINE turb_vfluxhybridpatch( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), TARGET :: region
    TYPE(t_patch)          :: patch
  END SUBROUTINE turb_vfluxhybridpatch

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

  SUBROUTINE turb_visfluxeddypatch( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), TARGET :: region
    TYPE(t_patch)          :: patch
  END SUBROUTINE turb_visfluxeddypatch

  SUBROUTINE turb_wlmfluxpatch( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_wlmfluxpatch

  SUBROUTINE turb_wlminitia( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_wlminitia

  SUBROUTINE turb_wlmreyanalogy( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_wlmreyanalogy

  SUBROUTINE turb_wlmtauwallmapping( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_wlmtauwallmapping

  SUBROUTINE turb_wlmupdate( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_wlmupdate

  SUBROUTINE turb_wlmupdatebndlay( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_wlmupdatebndlay

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

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

#ifdef RFLO
! =============================================================================
! Rocflo-specific routines
! =============================================================================

  SUBROUTINE turb_floextrapintcellscal( region,fVec )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)          :: region
    REAL(RFREAL), POINTER   :: fvec(:)
  END SUBROUTINE turb_floextrapintcellscal

  SUBROUTINE turb_floextrapintcellvec( region,idBeg,idEnd,fVec )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)          :: region
    INTEGER                 :: idbeg,idend
    REAL(RFREAL), POINTER   :: fvec(:,:)
  END SUBROUTINE turb_floextrapintcellvec

  SUBROUTINE turb_floextrapolcellvec( region,idBeg,idEnd,fVec )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)          :: region
    INTEGER                 :: idbeg,idend
    REAL(RFREAL), POINTER   :: fvec(:,:)
  END SUBROUTINE turb_floextrapolcellvec

  SUBROUTINE turb_floextrapolfacevec( region,intDIR,idBeg,idEnd,fVec )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)          :: region
    INTEGER                 :: intdir,idbeg,idend
    REAL(RFREAL), POINTER   :: fvec(:,:)
  END SUBROUTINE turb_floextrapolfacevec

  SUBROUTINE turb_flofacevolume( region,ijk )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)  :: region
    INTEGER         :: ijk
  END SUBROUTINE turb_flofacevolume

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

  SUBROUTINE turb_flofacewidthdummy( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_flofacewidthdummy

  SUBROUTINE turb_flofacewidthdummyconn( region,lbound,idir,jdir,kdir, &
                                  indbeg,indend,jndbeg,jndend,kndbeg,kndend )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER        :: lbound,idir,jdir,kdir
    INTEGER        :: indbeg, indend, jndbeg, jndend, kndbeg, kndend
  END SUBROUTINE turb_flofacewidthdummyconn

  SUBROUTINE turb_flofacewidthdummyphys( region,lbound,idir,jdir,kdir, &
                                  indbeg,indend,jndbeg,jndend,kndbeg,kndend )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER        :: lbound,idir,jdir,kdir
    INTEGER        :: indbeg, indend, jndbeg, jndend, kndbeg, kndend
  END SUBROUTINE turb_flofacewidthdummyphys

  SUBROUTINE turb_flolesaverageface( region,ijk,faceVar,avgFaceVar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)        :: region
    INTEGER               :: ijk
    REAL(RFREAL), POINTER :: facevar(:),avgfacevar(:)
  END SUBROUTINE turb_flolesaverageface

  SUBROUTINE turb_flolesgenc2f( region,ijk )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)  :: region
    INTEGER         :: ijk
  END SUBROUTINE turb_flolesgenc2f

  SUBROUTINE turb_flolesunifiltcc( region,nDel,idBeg,idEnd,fVar,fbVar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    TYPE(t_region)        :: region
    INTEGER               :: ijk,ndel(diri:dirk),idbeg,idend
    REAL(RFREAL), POINTER :: fvar(:,:),fbvar(:,:)
  END SUBROUTINE turb_flolesunifiltcc

  SUBROUTINE turb_flolesunifiltcci( global,nDumi,ibeg,iend,jbeg,jend,kbeg,kend, &
                         icoff,ijcoff,ndel,idbeg,idend,fact1,fact2,fvar, &
                         filtvar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: ndumi,ibeg,iend,jbeg,jend,kbeg,kend,icoff,ijcoff
    INTEGER               :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL)          :: fact1(filwidth_four),fact2(filwidth_four)
    REAL(RFREAL), POINTER :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesunifiltcci

  SUBROUTINE turb_flolesunifiltccj( global,nDumi,ibeg,iend,jbeg,jend,kbeg,kend, &
                         icoff,ijcoff,ndel,idbeg,idend,fact1,fact2,fvar, &
                         filtvar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: ndumi,ibeg,iend,jbeg,jend,kbeg,kend,icoff,ijcoff
    INTEGER               :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL)          :: fact1(filwidth_four),fact2(filwidth_four)
    REAL(RFREAL), POINTER :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesunifiltccj

  SUBROUTINE turb_flolesunifiltcck( global,nDumi,ibeg,iend,jbeg,jend,kbeg,kend, &
                         icoff,ijcoff,ndel,idbeg,idend,fact1,fact2,fvar, &
                         filtvar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: ndumi,ibeg,iend,jbeg,jend,kbeg,kend,icoff,ijcoff
    INTEGER               :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL)          :: fact1(filwidth_four),fact2(filwidth_four)
    REAL(RFREAL), POINTER :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesunifiltcck

  SUBROUTINE turb_flolesunifiltff( region,ijk,nDel,idBeg,idEnd,fVar,fbVar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    TYPE(t_region)        :: region
    INTEGER               :: ijk,ndel(diri:dirk),idbeg,idend
    REAL(RFREAL), POINTER :: fvar(:,:),fbvar(:,:)
  END SUBROUTINE turb_flolesunifiltff

  SUBROUTINE turb_flolesunifiltffi( global,ibeg,iend,jbeg,jend,kbeg,kend,iNOff, &
                          ijnoff,ndel,idbeg,idend,fact1,fact2,fvar,filtvar )
    USE moddatatypes
    USE turb_modparameters
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: ibeg,iend,jbeg,jend,kbeg,kend,inoff,ijnoff
    INTEGER               :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL)          :: fact1(filwidth_four),fact2(filwidth_four)
    REAL(RFREAL), POINTER :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesunifiltffi

  SUBROUTINE turb_flolesunifiltffj( global,ibeg,iend,jbeg,jend,kbeg,kend,iNOff, &
                          ijnoff,ndel,idbeg,idend,fact1,fact2,fvar,filtvar )
    USE moddatatypes
    USE turb_modparameters
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: ibeg,iend,jbeg,jend,kbeg,kend,inoff,ijnoff
    INTEGER               :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL)          :: fact1(filwidth_four),fact2(filwidth_four)
    REAL(RFREAL), POINTER :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesunifiltffj

  SUBROUTINE turb_flolesunifiltffk( global,ibeg,iend,jbeg,jend,kbeg,kend,iNOff, &
                        ijnoff,ndel,idbeg,idend,fact1,fact2,fvar,filtvar )
    USE moddatatypes
    USE turb_modparameters
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: ibeg,iend,jbeg,jend,kbeg,kend,inoff,ijnoff
    INTEGER               :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL)          :: fact1(filwidth_four),fact2(filwidth_four)
    REAL(RFREAL), POINTER :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesunifiltffk

  SUBROUTINE turb_flolesgenfiltcc( region,nDel,idBeg,idEnd,fVar,fbVar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    TYPE(t_region)        :: region
    INTEGER               :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL), POINTER :: fvar(:,:),fbvar(:,:)
  END SUBROUTINE turb_flolesgenfiltcc

  SUBROUTINE turb_flolesgenfiltcci( region,nDumi,ibeg,iend,jbeg,jend,kbeg,kend, &
                               icoff,ijcoff,ndel,idbeg,idend,fvar,filtvar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    TYPE(t_region), TARGET :: region
    INTEGER                :: ndumi,ibeg,iend,jbeg,jend,kbeg,kend,icoff,ijcoff
    INTEGER                :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL), POINTER  :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesgenfiltcci

  SUBROUTINE turb_flolesgenfiltccj( region,nDumi,ibeg,iend,jbeg,jend,kbeg,kend, &
                               icoff,ijcoff,ndel,idbeg,idend,fvar,filtvar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    TYPE(t_region), TARGET :: region
    INTEGER                :: ndumi,ibeg,iend,jbeg,jend,kbeg,kend,icoff,ijcoff
    INTEGER                :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL), POINTER  :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesgenfiltccj

  SUBROUTINE turb_flolesgenfiltcck( region,nDumi,ibeg,iend,jbeg,jend,kbeg,kend, &
                               icoff,ijcoff,ndel,idbeg,idend,fvar,filtvar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    TYPE(t_region), TARGET :: region
    INTEGER                :: ndumi,ibeg,iend,jbeg,jend,kbeg,kend,icoff,ijcoff
    INTEGER                :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL), POINTER  :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesgenfiltcck

  SUBROUTINE turb_flolesgenfiltff( region,ijk,nDel,idBeg,idEnd,fVar,fbVar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    TYPE(t_region)        :: region
    INTEGER               :: ijk,ndel(diri:dirk),idbeg,idend
    REAL(RFREAL), POINTER :: fvar(:,:),fbvar(:,:)
  END SUBROUTINE turb_flolesgenfiltff

  SUBROUTINE turb_flolesgenfiltffi( region,ijk,ibeg,iend,jbeg,jend,kbeg,kend, &
                                    inoff,ijnoff,ndel,idbeg,idend,fvar,filtvar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    TYPE(t_region), TARGET :: region
    INTEGER                :: ijk,ibeg,iend,jbeg,jend,kbeg,kend,inoff,ijnoff
    INTEGER                :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL), POINTER  :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesgenfiltffi

  SUBROUTINE turb_flolesgenfiltffj( region,ijk,ibeg,iend,jbeg,jend,kbeg,kend, &
                                    inoff,ijnoff,ndel,idbeg,idend,fvar,filtvar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    TYPE(t_region), TARGET :: region
    INTEGER                :: ijk,ibeg,iend,jbeg,jend,kbeg,kend,inoff,ijnoff
    INTEGER                :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL), POINTER  :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesgenfiltffj

  SUBROUTINE turb_flolesgenfiltffk( region,ijk,ibeg,iend,jbeg,jend,kbeg,kend, &
                                    inoff,ijnoff,ndel,idbeg,idend,fvar,filtvar )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    TYPE(t_region), TARGET :: region
    INTEGER                :: ijk,ibeg,iend,jbeg,jend,kbeg,kend,inoff,ijnoff
    INTEGER                :: ndel(diri:dirk),idbeg,idend
    REAL(RFREAL), POINTER  :: fvar(:,:),filtvar(:,:)
  END SUBROUTINE turb_flolesgenfiltffk

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

  SUBROUTINE turb_flolesgencocchi( global,ijk,ibeg,iend,jbeg,jend,kbeg,kend, &
                                minidx,maxidx,segid,icoff,ijcoff,inoff,ijnoff, &
                                ds,segm,cccofa,cccofb )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: ijk,ibeg,iend,jbeg,jend,kbeg,kend,minidx,maxidx
    INTEGER               :: segid,icoff,ijcoff,inoff,ijnoff
    REAL(RFREAL)          :: ds(minidx:maxidx)
    REAL(RFREAL), POINTER :: segm(:,:),cccofa(:,:),cccofb(:,:)
  END SUBROUTINE turb_flolesgencocchi

  SUBROUTINE turb_flolesgencocclo( global,ijk,ibeg,iend,jbeg,jend,kbeg,kend, &
                                minidx,maxidx,segid,icoff,ijcoff,inoff,ijnoff, &
                                ds,segm,cccofa,cccofb )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: ijk,ibeg,iend,jbeg,jend,kbeg,kend,minidx,maxidx
    INTEGER               :: segid,icoff,ijcoff,inoff,ijnoff
    REAL(RFREAL)          :: ds(minidx:maxidx)
    REAL(RFREAL), POINTER :: segm(:,:),cccofa(:,:),cccofb(:,:)
  END SUBROUTINE turb_flolesgencocclo

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

  SUBROUTINE turb_flolesgencoffhi( global,ijk,ibeg,iend,jbeg,jend,kbeg,kend, &
                                minidx,maxidx,segid,inoff,ijnoff,ds,segm, &
                                ffcofa,ffcofb )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: ijk,ibeg,iend,jbeg,jend,kbeg,kend,minidx,maxidx
    INTEGER               :: segid,inoff,ijnoff
    REAL(RFREAL)          :: ds(minidx:maxidx)
    REAL(RFREAL), POINTER :: segm(:,:),ffcofa(:,:),ffcofb(:,:)
  END SUBROUTINE turb_flolesgencoffhi

  SUBROUTINE turb_flolesgencofflo( global,ijk,ibeg,iend,jbeg,jend,kbeg,kend, &
                                minidx,maxidx,segid,inoff,ijnoff,ds,segm, &
                                ffcofa,ffcofb )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: ijk,ibeg,iend,jbeg,jend,kbeg,kend,minidx,maxidx
    INTEGER               :: segid,inoff,ijnoff
    REAL(RFREAL)          :: ds(minidx:maxidx)
    REAL(RFREAL), POINTER :: segm(:,:),ffcofa(:,:),ffcofb(:,:)
  END SUBROUTINE turb_flolesgencofflo

  SUBROUTINE turb_flolesgencofchi( global,filtDir,ibeg,iend,jbeg,jend,kbeg, &
                                kend,minidx,maxidx,segid,inoff,ijnoff,ds,segm, &
                                ffcofa,ffcofb )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: filtdir,ibeg,iend,jbeg,jend,kbeg,kend
    INTEGER               :: minidx,maxidx,segid,inoff,ijnoff
    REAL(RFREAL)          :: ds(minidx:maxidx)
    REAL(RFREAL), POINTER :: segm(:,:),ffcofa(:,:),ffcofb(:,:)
  END SUBROUTINE turb_flolesgencofchi

  SUBROUTINE turb_flolesgencofclo( global,filtDir,ibeg,iend,jbeg,jend,kbeg, &
                                kend,minidx,maxidx,segid,inoff,ijnoff,ds,segm, &
                                ffcofa,ffcofb )
    USE moddatatypes
    USE modglobal, ONLY : t_global
    TYPE(t_global), POINTER :: global
    INTEGER               :: filtdir,ibeg,iend,jbeg,jend,kbeg,kend
    INTEGER               :: minidx,maxidx,segid,inoff,ijnoff
    REAL(RFREAL)          :: ds(minidx:maxidx)
    REAL(RFREAL), POINTER :: segm(:,:),ffcofa(:,:),ffcofb(:,:)
  END SUBROUTINE turb_flolesgencofclo

  SUBROUTINE turb_floransbcondinflow( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_floransbcondinflow

  SUBROUTINE turb_floransbcondinjection( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_floransbcondinjection

  SUBROUTINE turb_floransbcondnoslipwall( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_floransbcondnoslipwall

  SUBROUTINE turb_floransbcondsymmetry( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_floransbcondsymmetry 

  SUBROUTINE turb_floransbcondzerograd( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_floransbcondzerograd

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

  SUBROUTINE turb_floranscorrcornedgecells( region,patch,bcType )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
    INTEGER        :: bctype
  END SUBROUTINE turb_floranscorrcornedgecells

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

  SUBROUTINE turb_floransexchangedummyconf( region,regionSrc,patch,patchSrc )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region, regionsrc
    TYPE(t_patch)  :: patch, patchsrc
  END SUBROUTINE turb_floransexchangedummyconf

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

  SUBROUTINE turb_floransrecvdummyvals( region,regionSrc,patch,patchSrc )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region, regionsrc
    TYPE(t_patch)  :: patch, patchsrc
  END SUBROUTINE turb_floransrecvdummyvals

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

  SUBROUTINE turb_floranssacentfluxpatch( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_floranssacentfluxpatch

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

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

  SUBROUTINE turb_floranssaroefluxpatch( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_floranssaroefluxpatch

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

  SUBROUTINE turb_floranssenddummyconf( region,regionSrc,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region, regionsrc
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_floranssenddummyconf

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

  SUBROUTINE turb_flowlmmetric( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_flowlmmetric

  SUBROUTINE turb_flowlmupdateloglay( region,patch )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    TYPE(t_patch)  :: patch
  END SUBROUTINE turb_flowlmupdateloglay
#endif

#ifdef RFLU
! =============================================================================
! Rocflu-specific routines
! =============================================================================

  SUBROUTINE turb_flucv2cons( region,cvStateFuture )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), TARGET :: region
    INTEGER, INTENT(IN) :: cvstatefuture
  END SUBROUTINE turb_flucv2cons

  SUBROUTINE turb_flucv2prim( region,cvStateFuture )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), TARGET :: region
    INTEGER, INTENT(IN) :: cvstatefuture
  END SUBROUTINE turb_flucv2prim

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

  SUBROUTINE turb_flulesblij( region,nDel,lij )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE turb_modparameters
    TYPE(t_region), POINTER :: region
    INTEGER                 :: ndel(diri:dirk)
    REAL(RFREAL), POINTER   :: lij(:,:)
  END SUBROUTINE turb_flulesblij

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

  SUBROUTINE turb_flulesc2f( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)  :: region
  END SUBROUTINE turb_flulesc2f
#endif

  END INTERFACE

END MODULE turb_modinterfaces

!******************************************************************************
!
! RCS Revision history:
!
! $Log: TURB_ModInterfaces.F90,v $
! Revision 1.28  2008/12/06 08:44:42  mtcampbe
! Updated license.
!
! Revision 1.27  2008/11/19 22:17:54  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.26  2004/11/17 23:45:21  wasistho
! used generic RK-update for rocturb
!
! Revision 1.25  2004/10/22 23:17:03  wasistho
! added TURB_StatCCollector
!
! Revision 1.24  2004/08/04 02:45:37  wasistho
! removed turb%avgCoI,J,K as it is defined as grid%c2fCoI,J,K
!
! Revision 1.23  2004/07/30 22:35:25  wasistho
! replaced floLesUniC2F by floLesGenC2F
!
! Revision 1.22  2004/05/28 01:57:12  wasistho
! update unstructured grid LES
!
! Revision 1.21  2004/03/29 21:09:30  wasistho
! add flu routines
!
! Revision 1.20  2004/03/27 02:16:42  wasistho
! compiled with Rocflu
!
! Revision 1.19  2004/03/23 03:35:00  wasistho
! prepared for RFLU
!
! Revision 1.18  2004/03/19 22:33:47  wasistho
! confined flo interfaces within ifdef RFLO
!
! Revision 1.17  2004/03/13 03:15:03  wasistho
! get rid of flo/flu identifier in TURB_Co.. routines
!
! Revision 1.16  2004/03/12 02:55:35  wasistho
! changed rocturb routine names
!
! Revision 1.15  2004/03/08 23:29:09  wasistho
! changed turb nomenclature
!
! Revision 1.14  2004/02/26 21:20:26  wasistho
! added TURB_ransRkInit, TURB_lesRkInit, TURB_ransEmsInit
!
! Revision 1.13  2004/02/12 03:46:14  wasistho
! filled in RaNS lengthscale in dummy cells
!
! Revision 1.12  2004/01/23 00:35:43  wasistho
! added new RaNS edge/corners routines
!
! Revision 1.11  2003/10/27 04:52:26  wasistho
! added RaNS upwind schemes
!
! Revision 1.10  2003/10/16 20:19:00  wasistho
! installed RaNS in steady state flow (Exp.Mult.Stg)
!
! Revision 1.9  2003/10/09 23:06:53  wasistho
! renamed CalcEddyVis to LesCalcEddyVis
!
! Revision 1.8  2003/10/07 02:04:15  wasistho
! initial installation of RaNS-SA and DES
!
! Revision 1.7  2003/08/06 15:57:28  wasistho
! added CalcVortic and SolutionUpdate for vorticities
!
! Revision 1.6  2003/06/05 19:18:37  wasistho
! implemented heat transfer model
!
! Revision 1.5  2003/05/31 01:45:32  wasistho
! installed turb. wall layer model
!
! Revision 1.4  2003/05/24 02:09:48  wasistho
! turbulence statistics expanded
!
! Revision 1.3  2003/05/16 05:45:41  wasistho
! modified array range of CC-filtered
!
! Revision 1.2  2002/10/14 23:53:46  wasistho
! Install Rocturb
!
!
!******************************************************************************