RADI_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: RADI_ModInterfaces.F90,v 1.6 2008/12/06 08:44:37 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************
  
MODULE radi_modinterfaces

  IMPLICIT NONE

  INTERFACE

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  SUBROUTINE radi_floflimcorrcornedgecells( 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 radi_floflimcorrcornedgecells

  SUBROUTINE radi_floflimexchangedummyconf( 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 radi_floflimexchangedummyconf

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

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

  SUBROUTINE radi_floflimrecvdummyvals( 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 radi_floflimrecvdummyvals

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

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

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

  END INTERFACE

END MODULE radi_modinterfaces

!******************************************************************************
!
! RCS Revision history:
!
! $Log: RADI_ModInterfaces.F90,v $
! Revision 1.6  2008/12/06 08:44:37  mtcampbe
! Updated license.
!
! Revision 1.5  2008/11/19 22:17:50  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.4  2004/09/30 17:11:30  wasistho
! prepared for full FLD radiation model
!
! Revision 1.3  2004/09/18 17:42:11  wasistho
! install Limited Flux Diffusion radiation
!
! Revision 1.2  2003/07/17 01:12:11  wasistho
! initial activation rocrad
!
! Revision 1.1.1.1  2001/12/03 21:44:04  jblazek
! Import of RocfluidMP
!
!******************************************************************************