PEUL_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: PEUL_ModInterfaces.F90,v 1.10 2008/12/06 08:44:39 mtcampbe Exp $
!
! Copyright: (c) 2002 by the University of Illinois
!
!******************************************************************************

MODULE peul_modinterfaces

  IMPLICIT NONE

  INTERFACE

! These are PUBLIC (i.e., in ModInterfacesEulerian)
!
! PEUL_AllocateDataBuffers, PEUL_AllocateMemory,
! PEUL_boundaryConditionsRecv, PEUL_boundaryConditionsSend,
! PEUL_BoundaryConditionsSet,
! PEUL_CentralDissipation, PEUL_ClearSendRequests, PEUL_ConvectiveFluxes,
! PEUL_EnforcePositivity,
! PEUL_InitSolution, PEUL_PrintUserInput, PEUL_ReadSolution,
! PEUL_ResidualSmoothing, PEUL_ResidualSmoothingCoeffs,
! PEUL_SourceTerms,
! PEUL_SpectralRadii PEUL_UserInput, PEUL_WriteSolution

! These are PRIVATE (i.e., not in ModInterfacesEulerian)

  SUBROUTINE peul_bcondinflow( region,patch )
    USE moddatastruct, ONLY : t_region
    USE modbndpatch,   ONLY : t_patch
    TYPE(t_region), INTENT(INOUT) :: region
    TYPE(t_patch),  INTENT(IN)    :: patch
  END SUBROUTINE peul_bcondinflow

  SUBROUTINE peul_bcondinjection( region,patch )
    USE moddatastruct, ONLY : t_region
    USE modbndpatch,   ONLY : t_patch
    TYPE(t_region), INTENT(INOUT) :: region
    TYPE(t_patch),  INTENT(IN)    :: patch
  END SUBROUTINE peul_bcondinjection

  SUBROUTINE peul_bcondoutflow( region,patch )
    USE moddatastruct, ONLY : t_region
    USE modbndpatch,   ONLY : t_patch
    TYPE(t_region), INTENT(INOUT) :: region
    TYPE(t_patch),  INTENT(IN)    :: patch
  END SUBROUTINE peul_bcondoutflow

  SUBROUTINE peul_bcondslipwall( region,patch )
    USE moddatastruct, ONLY : t_region
    USE modbndpatch,   ONLY : t_patch
    TYPE(t_region), INTENT(INOUT) :: region
    TYPE(t_patch),  INTENT(IN)    :: patch
  END SUBROUTINE peul_bcondslipwall

  SUBROUTINE peul_bcondsymmetry( region,patch )
    USE moddatastruct, ONLY : t_region
    USE modbndpatch,   ONLY : t_patch
    TYPE(t_region), INTENT(INOUT) :: region
    TYPE(t_patch),  INTENT(IN)    :: patch
  END SUBROUTINE peul_bcondsymmetry

  SUBROUTINE peul_centralflux( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
  END SUBROUTINE peul_centralflux

  SUBROUTINE peul_centralfluxpatch( region,patch )
    USE moddatastruct, ONLY : t_region
    USE modbndpatch,   ONLY : t_patch
    TYPE(t_region), INTENT(INOUT) :: region
    TYPE(t_patch),  INTENT(IN)    :: patch
  END SUBROUTINE peul_centralfluxpatch

  SUBROUTINE peul_correctcorneredgecells( region,patch,bcType )
    USE moddatastruct, ONLY : t_region
    USE modbndpatch,   ONLY : t_patch
    TYPE(t_region), INTENT(INOUT) :: region
    TYPE(t_patch),  INTENT(IN)    :: patch
    INTEGER,        INTENT(IN)    :: bctype
  END SUBROUTINE peul_correctcorneredgecells

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

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

  SUBROUTINE peul_exchangedummyconf( region,regionSrc,patch,patchSrc )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
    TYPE(t_region), INTENT(IN)    :: regionsrc
    TYPE(t_patch),  INTENT(INOUT) :: patch
    TYPE(t_patch),  INTENT(IN)    :: patchsrc
  END SUBROUTINE peul_exchangedummyconf

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

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

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

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

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

  SUBROUTINE peul_readconpartptypesection( regions,brbeg,brend,iPtype )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
    INTEGER, INTENT(IN)     :: brbeg,brend,iptype
  END SUBROUTINE peul_readconpartptypesection

  SUBROUTINE peul_readconpartsection( regions,nPtypes,brbeg,brend )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
    INTEGER, INTENT(IN)     :: nptypes
    INTEGER, INTENT(OUT)    :: brbeg,brend
  END SUBROUTINE peul_readconpartsection

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

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

  SUBROUTINE peul_receivedummyvals( region,regionSrc,patch,patchSrc )
    USE modbndpatch, ONLY   : t_patch
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
    TYPE(t_region), INTENT(IN)    :: regionsrc
    TYPE(t_patch),  INTENT(INOUT) :: patch
    TYPE(t_patch),  INTENT(IN)    :: patchsrc
  END SUBROUTINE peul_receivedummyvals

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

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

  SUBROUTINE peul_setcorneredgecells( region )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
  END SUBROUTINE peul_setcorneredgecells

  SUBROUTINE peul_sourceeqeul( region,ipt )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
    INTEGER,        INTENT(IN)    :: ipt
  END SUBROUTINE peul_sourceeqeul

  END INTERFACE

END MODULE peul_modinterfaces

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PEUL_ModInterfaces.F90,v $
! Revision 1.10  2008/12/06 08:44:39  mtcampbe
! Updated license.
!
! Revision 1.9  2008/11/19 22:17:51  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.8  2004/05/03 15:09:42  jferry
! added equilibrium Eulerian capability for smoke
!
! Revision 1.7  2004/03/02 21:42:47  jferry
! Added clipping options and corner and edge cell updates
!
! Revision 1.6  2003/04/09 15:10:22  jferry
! added slip wall boundary condition
!
! Revision 1.5  2003/04/09 14:30:30  fnajjar
! Added Interfaces for Multi-region and MPI-based routines
!
! Revision 1.4  2003/04/07 18:29:01  jferry
! added inflow boundary condition and initialization to a constant
!
! Revision 1.3  2003/03/04 22:12:35  jferry
! Initial import of Rocinteract
!
! Revision 1.2  2003/02/11 22:52:50  jferry
! Initial import of Rocsmoke
!
! Revision 1.1.1.1  2002/12/03 21:44:04  jblazek
! Import of RocfluidMP
!
!******************************************************************************