RFLU_ModInterfacesSolver.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 for Rocflu
!   solver.
!
! Description: None
!
! Notes: None.
!
! ******************************************************************************
!
! $Id: RFLU_ModInterfacesSolver.F90,v 1.21 2008/12/06 08:44:22 mtcampbe Exp $
!
! Copyright: (c) 2003-2004 by the University of Illinois
!
! ******************************************************************************
  
MODULE rflu_modinterfacessolver

  IMPLICIT NONE

  INTERFACE

  SUBROUTINE rflu_centralfirstpatch(pRegion,pPatch)
    USE modbndpatch, ONLY: t_patch
    USE moddatastruct, ONLY: t_region
    TYPE(t_patch), POINTER :: ppatch
    TYPE(t_region), POINTER :: pregion   
  END SUBROUTINE rflu_centralfirstpatch

  SUBROUTINE rflu_centralfirstpatch_gl(pRegion,pPatch)
    USE modbndpatch, ONLY: t_patch
    USE moddatastruct, ONLY: t_region
    TYPE(t_patch), POINTER :: ppatch
    TYPE(t_region), POINTER :: pregion
  END SUBROUTINE rflu_centralfirstpatch_gl

  SUBROUTINE rflu_centralsecondpatch(pRegion,pPatch)
    USE modbndpatch, ONLY: t_patch
    USE moddatastruct, ONLY: t_region
    TYPE(t_patch), POINTER :: ppatch
    TYPE(t_region), POINTER :: pregion 
  END SUBROUTINE rflu_centralsecondpatch

  SUBROUTINE rflu_centralsecondpatch_gl(pRegion,pPatch)
    USE modbndpatch, ONLY: t_patch
    USE moddatastruct, ONLY: t_region
    TYPE(t_patch), POINTER :: ppatch
    TYPE(t_region), POINTER :: pregion
  END SUBROUTINE rflu_centralsecondpatch_gl

  SUBROUTINE rflu_checkgridspeeds(pRegion)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region), POINTER :: pregion
  END SUBROUTINE rflu_checkgridspeeds
  
  SUBROUTINE rflu_computeenerdissoles(region)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region) :: region
  END SUBROUTINE rflu_computeenerdissoles

  SUBROUTINE rflu_computefluxinv(pRegion,fluxPart)
    USE moddatastruct, ONLY: t_region
    INTEGER, INTENT(IN) :: fluxpart    
    TYPE(t_region), POINTER :: pregion     
  END SUBROUTINE rflu_computefluxinv

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

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

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

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

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

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

#ifndef GENX
  SUBROUTINE rflu_computeintegralvalues(regions)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE rflu_computeintegralvalues
#else
  SUBROUTINE rflu_computeintegralvalues(regions,integ)
    USE modrocstar ! To access MAN_INTEG_SIZE
    USE moddatastruct, ONLY: t_region
    DOUBLE PRECISION, DIMENSION(MAN_INTEG_SIZE) :: integ
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE rflu_computeintegralvalues
#endif

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

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

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

  SUBROUTINE rflu_createfields(global,pLevel)
    USE modglobal, ONLY: t_global
    USE moddatastruct, ONLY: t_level
    TYPE(t_global), POINTER :: global
    TYPE(t_level), POINTER :: plevel
  END SUBROUTINE rflu_createfields

  SUBROUTINE rflu_endflowsolver(levels)
    USE moddatastruct, ONLY: t_level
    TYPE(t_level), POINTER :: levels(:)
  END SUBROUTINE rflu_endflowsolver

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

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

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

#ifndef GENX
  SUBROUTINE rflu_flowsolver(dTimeSystem,dIterSystem,levels)
    USE moddatatypes
    USE moddatastruct, ONLY: t_level
    INTEGER, INTENT(IN) :: ditersystem  
    REAL(RFREAL), INTENT(IN) :: dtimesystem
    TYPE(t_level), POINTER :: levels(:)
  END SUBROUTINE rflu_flowsolver
#else
  SUBROUTINE rflu_flowsolver(globalGenx,timeSystem,dTimeSystem,genxHandleBc, & 
                             genxhandlegm)
    USE moddatatypes
    USE modrocstar, ONLY: t_globalgenx 
    INTEGER, INTENT(IN) :: genxhandlebc,genxhandlegm
    DOUBLE PRECISION, INTENT(IN) :: dtimesystem,timesystem
    TYPE(t_globalgenx), POINTER :: globalgenx         
  END SUBROUTINE rflu_flowsolver
#endif

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

#ifndef GENX
  SUBROUTINE rflu_initflowsolver(casename,verbLevel,global,levels)
    USE moddatatypes  
    USE modglobal, ONLY: t_global
    USE moddatastruct, ONLY: t_level
    CHARACTER(CHRLEN), INTENT(IN) :: casename
    INTEGER, INTENT(IN) :: verblevel
    TYPE(t_global), POINTER :: global
    TYPE(t_level), POINTER :: levels(:)
  END SUBROUTINE rflu_initflowsolver  
#else
  SUBROUTINE rflu_initflowsolver(globalGenx,initialTime,communicator,genxHandle)
    USE modrocstar, ONLY: t_globalgenx    
    INTEGER, INTENT(IN) :: communicator,genxhandle
    DOUBLE PRECISION, INTENT(IN) :: initialtime
    TYPE(t_globalgenx), POINTER :: globalgenx
  END SUBROUTINE rflu_initflowsolver  
#endif

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

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

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

  SUBROUTINE rflu_movegridxyz(regions,context)
    USE moddatastruct, ONLY: t_region
    INTEGER, INTENT(IN) :: context
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE rflu_movegridxyz

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

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

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

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

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

  SUBROUTINE rflu_residualnorm(regions)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE rflu_residualnorm
  
  SUBROUTINE rflu_setmovegridoptions(pRegion)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region), POINTER :: pregion    
  END SUBROUTINE rflu_setmovegridoptions

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

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

  SUBROUTINE rflu_timestepping(dTimeSystem,dIterSystem,regions)
    USE moddatatypes
    USE moddatastruct, ONLY: t_region
    INTEGER, INTENT(IN) :: ditersystem  
    REAL(RFREAL), INTENT(IN) :: dtimesystem
    TYPE(t_region), POINTER :: regions(:)
  END SUBROUTINE rflu_timestepping

  SUBROUTINE rflu_user_getdeformation(region)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region) :: region   
  END SUBROUTINE rflu_user_getdeformation
  
  SUBROUTINE rflu_updateboundaryvalues(region,istage)
    USE moddatastruct, ONLY: t_region
    INTEGER, INTENT(IN) :: istage
    TYPE(t_region) :: region
  END SUBROUTINE rflu_updateboundaryvalues
  
  SUBROUTINE rflu_writeintegrals1245oles(pRegion)
    USE moddatastruct, ONLY: t_region
    TYPE(t_region), POINTER :: pregion    
  END SUBROUTINE rflu_writeintegrals1245oles

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

  END INTERFACE

END MODULE rflu_modinterfacessolver

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: RFLU_ModInterfacesSolver.F90,v $
! Revision 1.21  2008/12/06 08:44:22  mtcampbe
! Updated license.
!
! Revision 1.20  2008/11/19 22:17:33  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.19  2006/05/01 21:01:52  haselbac
! Added if for RFLU_ComputeFluxInv
!
! Revision 1.18  2006/03/26 20:22:05  haselbac
! Added ifs for GL routines
!
! Revision 1.17  2005/05/16 20:43:11  haselbac
! Removed interfaces for flux routines, adapted interfaces for patch flux routines
!
! Revision 1.16  2005/04/29 12:55:54  haselbac
! Removed interfaces for probe routines
!
! Revision 1.15  2005/04/15 16:30:47  haselbac
! Added interface for RFLU_PrintWriteConvergence
!
! Revision 1.14  2004/12/19 15:47:59  haselbac
! Added interface for RFLU_InvFlux_I
!
! Revision 1.13  2004/11/03 17:03:21  haselbac
! Removed interface for RFLU_HACK_UpdateVirtualCells
!
! Revision 1.12  2004/10/19 19:28:10  haselbac
! Modified interfaces for time-step routines
!
! Revision 1.11  2004/07/30 22:47:36  jferry
! Implemented Equilibrium Eulerian method for Rocflu
!
! Revision 1.10  2004/07/06 15:14:44  haselbac
! Cosmetics only
!
! Revision 1.9  2004/02/26 21:02:04  haselbac
! Cosmetics only
!
! Revision 1.8  2004/02/13 02:58:03  haselbac
! Added interface for fast Roe routines
!
! Revision 1.7  2004/01/29 22:57:37  haselbac
! Added ifs for RFLU_RoeFirst and RFLU_RoeSecond.F90
!
! Revision 1.6  2003/12/04 03:28:50  haselbac
! Added entries for new routines, removed RFLU_UpdateCommLists (bug fix)
!
! Revision 1.5  2003/11/25 21:03:26  haselbac
! Added interface for RFLU_UpdateDummyCells
!
! Revision 1.4  2003/10/03 20:45:47  haselbac
! Added interface for RFLU_UpdateBoundaryValues
!
! Revision 1.3  2003/06/04 22:11:13  haselbac
! Added RFLU_CentralFirstPatch, rm RFLU_RoeCentralFirstPatch
!
! Revision 1.2  2003/05/16 22:09:29  haselbac
! Added RFLU_HLLCFirst
!
! Revision 1.1  2003/04/10 14:37:10  haselbac
! Initial revision
!
! ******************************************************************************