PLAG_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: PLAG_ModInterfaces.F90,v 1.48 2008/12/06 08:44:34 mtcampbe Exp $
!
! Copyright: (c) 2001-2004 by the University of Illinois
!
!******************************************************************************
  
MODULE plag_modinterfaces

  USE plag_modinterfacescecells
  
  IMPLICIT NONE
  
  INTERFACE

! =============================================================================
! PLAG specific library
! =============================================================================

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

  SUBROUTINE plag_appenddatafrombuffers( region, iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)      :: region
    INTEGER, INTENT(IN) :: ireg
  END SUBROUTINE plag_appenddatafrombuffers

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

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

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

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

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

  SUBROUTINE plag_calcbreakup( region, iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
    INTEGER,        INTENT(IN)    :: ireg
  END SUBROUTINE plag_calcbreakup
       
  SUBROUTINE plag_calcderivedvariables( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
  END SUBROUTINE plag_calcderivedvariables
  
  SUBROUTINE plag_calcfacecentroids( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
  END SUBROUTINE plag_calcfacecentroids
        
  SUBROUTINE plag_calcrhsposition( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
  END SUBROUTINE plag_calcrhsposition

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

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

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

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

  SUBROUTINE plag_deallocatedatabuffers( regions, iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
    INTEGER :: ireg
  END SUBROUTINE plag_deallocatedatabuffers 
  
  SUBROUTINE plag_derivedinputvalues( regions )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region    
    TYPE(t_region), POINTER  :: regions(:)
  END SUBROUTINE plag_derivedinputvalues 
  
  SUBROUTINE plag_getcellindices( region, iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER :: ireg
  END SUBROUTINE plag_getcellindices 
  
  SUBROUTINE plag_getcellindicesoutflow( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
  END SUBROUTINE plag_getcellindicesoutflow 

  SUBROUTINE plag_incelltest( region, posPlag, indexSearch, &
                              ijknr,ijknri,ijknrj,ijknrk,   &
                              indexnew,celllocate  )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER,                    INTENT(IN)    :: ijknr,ijknri,ijknrj,ijknrk
    INTEGER,      DIMENSION(4), INTENT(IN)    :: indexsearch
    INTEGER,      DIMENSION(4), INTENT(OUT)   :: indexnew
    LOGICAL,                    INTENT(OUT)   :: celllocate  
    REAL(RFREAL), DIMENSION(3), INTENT(IN)    :: posplag
  END SUBROUTINE plag_incelltest

  SUBROUTINE plag_incelltestrobust( region, posPlag, indexSearch, &
                                    indexnew,celllocate  )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER,      DIMENSION(4), INTENT(IN)  :: indexsearch
    INTEGER,      DIMENSION(4), INTENT(OUT) :: indexnew
    LOGICAL,                    INTENT(OUT) :: celllocate
    REAL(RFREAL), DIMENSION(3), INTENT(IN)  :: posplag
  END SUBROUTINE plag_incelltestrobust

  SUBROUTINE plag_initinputvalues( regions )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE plag_initinputvalues
  
  SUBROUTINE plag_initmemory( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
  END SUBROUTINE plag_initmemory 

  SUBROUTINE plag_injcejectparticle( region, iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)      :: region
    INTEGER, INTENT(IN) :: ireg
  END SUBROUTINE plag_injcejectparticle

  SUBROUTINE plag_injcmakeparticle( region, injcDiamDist, diam, spLoad )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)            :: region
    INTEGER, INTENT(IN)       :: injcdiamdist
    REAL(RFREAL), INTENT(OUT) :: diam, spload
  END SUBROUTINE plag_injcmakeparticle 

  SUBROUTINE plag_injcsetinjection( region, pTilePlag, iTile, tCoeff, tSum, &
                                    poolvol, injectq,  ratio )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region
    USE modpartlag, ONLY    : t_tile_plag
    TYPE(t_region)              :: region
    TYPE(t_tile_plag), POINTER  :: ptileplag
    INTEGER,      INTENT(IN)    :: itile
    REAL(RFREAL), INTENT(IN)    :: tcoeff
    REAL(RFREAL), INTENT(OUT)   :: ratio
    REAL(RFREAL), INTENT(INOUT) :: poolvol,tsum
    LOGICAL, INTENT(OUT)        :: injectq    
  END SUBROUTINE plag_injcsetinjection 

  SUBROUTINE plag_injctilecalcrhs( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
  END SUBROUTINE plag_injctilecalcrhs
     
  SUBROUTINE plag_injctileinitialize( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
  END SUBROUTINE plag_injctileinitialize
  
  SUBROUTINE plag_injctilerkupdate( region, iStage )
    USE moddatastruct, ONLY : t_region    
    TYPE(t_region) :: region
    INTEGER        :: istage
  END SUBROUTINE plag_injctilerkupdate 
  
  SUBROUTINE plag_injctileupdate( region, iReg, iStage )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region    
    TYPE(t_region) :: region
    INTEGER        :: ireg, istage
  END SUBROUTINE plag_injctileupdate
  
  SUBROUTINE plag_injctilezerorhs( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
  END SUBROUTINE plag_injctilezerorhs
    
  SUBROUTINE plag_intrpmixtproperties( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
  END SUBROUTINE plag_intrpmixtproperties
  
  SUBROUTINE plag_patchbuffersendrecv( regions )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE plag_patchbuffersendrecv
   
  SUBROUTINE plag_patchexchangeconf( region,regionDes,patch,patchDes,iReg,iRegDes )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region, regiondes
    TYPE(t_patch)  :: patch, patchdes
    INTEGER        :: ireg, iregdes
  END SUBROUTINE plag_patchexchangeconf

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

  SUBROUTINE plag_patchloaddatabuffers( region, iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER        :: ireg
  END SUBROUTINE plag_patchloaddatabuffers 

  SUBROUTINE plag_patchremovedataoutflow( region, iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
    INTEGER        :: ireg
  END SUBROUTINE plag_patchremovedataoutflow 
  
  SUBROUTINE plag_patchupdate( regions, iReg )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region    
    TYPE(t_region), POINTER :: regions(:)
    INTEGER        :: ireg
  END SUBROUTINE plag_patchupdate
  
  SUBROUTINE plag_readdispartsection( regions )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE plag_readdispartsection

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

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

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

  SUBROUTINE plag_reallocatedatabuffers( regions, iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
    INTEGER :: ireg
  END SUBROUTINE plag_reallocatedatabuffers 
      
  SUBROUTINE plag_reflectparticledata(pPatch,pPlag,ifl,iPcl,xLocOld,yLocOld, & 
                                      zlocold,xloc,yloc,zloc,xtraj,ytraj,ztraj)   
    USE moddatatypes
    USE modbndpatch, ONLY: t_patch
    USE modpartlag, ONLY: t_plag    
    INTEGER, INTENT(IN) :: ifl,ipcl
    REAL(RFREAL), INTENT(INOUT) :: xloc,xlocold,yloc,ylocold,zloc,zlocold
    REAL(RFREAL), INTENT(INOUT), OPTIONAL :: xtraj,ytraj,ztraj                                   
    TYPE(t_patch), POINTER :: ppatch
    TYPE(t_plag), POINTER :: pplag    
  END SUBROUTINE plag_reflectparticledata 
  
  SUBROUTINE plag_readpdffromfile(regions, brbeg, brend )
    USE moddatastruct, ONLY : t_region 
    TYPE(t_region), POINTER :: regions(:)
    INTEGER,INTENT(IN)      :: brbeg,brend
  END SUBROUTINE plag_readpdffromfile

  SUBROUTINE plag_rkupdate( region, iStage )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region    
    TYPE(t_region), INTENT(INOUT) :: region
    INTEGER,        INTENT(IN)    :: istage
  END SUBROUTINE plag_rkupdate 
  
  SUBROUTINE plag_rkupdategeneric(region,iStage,ipBeg,ipEnd,ivBeg,ivEnd, &
                                  cv,cvold,rhs,rhssum)
    USE moddatatypes
    USE moddatastruct, ONLY: t_region
    INTEGER, INTENT(IN) :: ipbeg,ipend,istage,ivbeg,ivend
    REAL(RFREAL), DIMENSION(:,:), POINTER :: cv,cvold,rhs,rhssum    
    TYPE(t_region) :: region
  END SUBROUTINE plag_rkupdategeneric
  
  SUBROUTINE plag_update( region, iReg, iStage )
    USE moddatatypes
    USE moddatastruct, ONLY : t_region    
    TYPE(t_region), INTENT(INOUT) :: region
    INTEGER,        INTENT(IN)    :: ireg, istage
  END SUBROUTINE plag_update
  
#ifdef RFLO
  SUBROUTINE plag_updatedatastruct( region, iReg )
    USE moddatastruct, ONLY : t_region    
    TYPE(t_region) :: region
    INTEGER, INTENT(IN)  :: ireg
  END SUBROUTINE plag_updatedatastruct
#endif 
  
  SUBROUTINE plag_wallbounce( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region) :: region
  END SUBROUTINE plag_wallbounce
  
  SUBROUTINE plag_zerorhs( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
  END SUBROUTINE plag_zerorhs

! -----------------------------------------------------------------------------
! RFLU-specific routines
! -----------------------------------------------------------------------------
  
#ifdef RFLU
  SUBROUTINE plag_rflu_initsolserial_1d(pRegion)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region), POINTER :: pregion  
  END SUBROUTINE plag_rflu_initsolserial_1d

  SUBROUTINE plag_rflu_initsolserial_3d(pRegion)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region), POINTER :: pregion  
  END SUBROUTINE plag_rflu_initsolserial_3d

  SUBROUTINE plag_rflu_injctilecalcrhs(pRegion)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region), POINTER :: pregion  
  END SUBROUTINE plag_rflu_injctilecalcrhs

  SUBROUTINE plag_rflu_injectiondriver(pRegion)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region), POINTER :: pregion  
  END SUBROUTINE plag_rflu_injectiondriver
  
  SUBROUTINE plag_rflu_update( pRegion, iStage )
    USE moddatastruct, ONLY : t_region    
    TYPE(t_region), POINTER :: pregion
    INTEGER,    INTENT(IN)  :: istage
  END SUBROUTINE plag_rflu_update

  SUBROUTINE plag_updatedatastruct( pRegion )
    USE moddatastruct, ONLY : t_region    
    TYPE(t_region), POINTER :: pregion
  END SUBROUTINE plag_updatedatastruct
#endif 
  
  END INTERFACE

END MODULE plag_modinterfaces

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_ModInterfaces.F90,v $
! Revision 1.48  2008/12/06 08:44:34  mtcampbe
! Updated license.
!
! Revision 1.47  2008/11/19 22:17:46  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.46  2007/03/15 22:00:18  haselbac
! Added IFs for PLAG_RFLU_InitSolSerial_{1,3}D.F90
!
! Revision 1.45  2005/05/19 16:01:40  fnajjar
! Removed Interfaces for obsolete routine calls
!
! Revision 1.44  2005/04/27 15:00:08  fnajjar
! Removed interface calls to individual FindCells routines
!
! Revision 1.43  2005/04/25 18:39:10  luca1
! Imposed PDF from file option for random particle ejection
!
! Revision 1.42  2005/03/11 02:23:06  haselbac
! Adapted interfaces for new PLAG_RFLU_FindCellsTrajXYZ routines
!
! Revision 1.41  2005/01/01 21:33:12  haselbac
! Added interface for Apte method, modif interface for PLAG_ReflectParticleData
!
! Revision 1.40  2004/11/05 21:51:01  fnajjar
! Added interfaces to particle-cell search routines
!
! Revision 1.39  2004/11/05 21:09:14  haselbac
! Fixed bad check-in
!
! Revision 1.38  2004/11/05 20:33:57  haselbac
! Adapted interface for PLAG_ReflectParticleData
!
! Revision 1.37  2004/10/11 22:09:22  haselbac
! Renamed procedures
!
! Revision 1.36  2004/10/08 22:09:26  haselbac
! Added entry for PLAG_RFLU_FindParticleCellsBrut
!
! Revision 1.35  2004/08/20 23:27:13  fnajjar
! Added Infrastructure for Plag prep tool
!
! Revision 1.34  2004/06/16 22:58:48  fnajjar
! Renamed injcModel to injcDiamDist for CRE kernel
!
! Revision 1.33  2004/04/09 22:57:45  fnajjar
! Added Interfaces for RFLO-specific routines
!
! Revision 1.32  2004/04/08 01:33:00  haselbac
! Added interface for PLAG_ReflectParticleData
!
! Revision 1.31  2004/03/26 21:26:26  fnajjar
! Added new routines for RFLU-specific routines
!
! Revision 1.30  2004/03/15 21:05:54  haselbac
! Deleted/added interface
!
! Revision 1.29  2004/03/08 22:17:22  fnajjar
! Included interface calls for RFLU-specific injection routines
!
! Revision 1.28  2004/03/05 23:17:05  haselbac
! Added interface for PLAG_RFLU_FindParticleCellsTraj
!
! Revision 1.27  2004/02/26 21:02:12  haselbac
! Added common and RFLU-specific interfaces
!
! Revision 1.26  2004/02/25 21:56:45  fnajjar
! Included generic RKUpdate for PLAG
!
! Revision 1.25  2004/02/06 21:19:36  fnajjar
! Included proper INTENT to Interfaces
!
! Revision 1.24  2004/01/15 21:10:52  fnajjar
! Separated Interfaces for corner-edge cell routines
!
! Revision 1.23  2003/11/21 22:44:35  fnajjar
! Changed global to region for updated Random Number Generator
!
! Revision 1.22  2003/11/12 21:34:36  fnajjar
! Added Corner-Edge cells Interface calls
!
! Revision 1.21  2003/11/03 21:22:20  fnajjar
! Added PLAG_copyFaceVectors
!
! Revision 1.20  2003/09/13 20:14:21  fnajjar
! Added infrastructure for Breakup model
!
! Revision 1.19  2003/05/28 15:16:11  fnajjar
! Removed obsolete PLAG_mixt calls as embedded in Rocinteract
!
! Revision 1.18  2003/04/17 00:12:08  fnajjar
! Added INTENT(IN) for ijkNR, ijkNRI, ijkNRJ, ijkNRK
!
! Revision 1.17  2003/04/14 19:02:57  fnajjar
! Bug fix to include POINTER attribute for PLAG_PatchUpdate
!
! Revision 1.16  2003/04/14 14:32:20  fnajjar
! Added PLAG_initInputValues for proper initialization
!
! Revision 1.15  2003/03/28 19:50:39  fnajjar
! Moved interfaces for wrapper routines
!
! Revision 1.14  2003/02/21 17:06:55  fnajjar
! Added Interfaces to Data Send and Recv
!
! Revision 1.13  2003/01/24 22:07:57  f-najjar
! Include Interface call to PLAG_ClearRequests
!
! Revision 1.12  2003/01/23 17:12:14  f-najjar
! Included Interface for PLAG_BufferSizeRecv and PLAG_BufferSizeSend
!
! Revision 1.11  2003/01/23 17:05:06  f-najjar
! Moved Interface call to PLAG_patchBufferSendRecv into ModInterfacesLagrangian
!
! Revision 1.10  2003/01/17 19:32:20  f-najjar
! Included correct INTERFACE for PLAG_PatchRemoveDataOutflow and PLAG_PatchLoadDataBuffers
!
! Revision 1.9  2003/01/16 22:46:18  f-najjar
! Include iReg to calling sequence for PLAG_GetCellIndices
!
! Revision 1.8  2003/01/16 22:30:10  f-najjar
! Included INTERFACE call for PLAG_PatchBufferSendRecv
!
! Revision 1.7  2003/01/16 22:28:40  f-najjar
! Included INTERFACE call for PLAG_AppendDataFromBuffers
!
! Revision 1.6  2003/01/13 19:00:33  f-najjar
! Removed PLAG_allocateDataBuffers
!
! Revision 1.5  2003/01/10 19:37:40  f-najjar
! Included Interface call to PLAG_BoundaryConditionsSet
!
! Revision 1.4  2003/01/10 19:28:04  f-najjar
! Included Interface call for PLAG_PatchExchangeConf
!
! Revision 1.3  2003/01/10 19:09:10  f-najjar
! Included iReg in calling sequence
!
! Revision 1.2  2002/10/25 14:11:12  f-najjar
! Included interface calls to PLAG subroutines
!
! Revision 1.1.1.1  2001/12/03 21:44:04  jblazek
! Import of RocfluidMP
!
!******************************************************************************