INRT_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: INRT_ModInterfaces.F90,v 1.15 2008/12/06 08:44:31 mtcampbe Exp $
!
! Copyright: (c) 2003 by the University of Illinois
!
!******************************************************************************

MODULE inrt_modinterfaces

  IMPLICIT NONE

  INTERFACE

! These are PUBLIC (i.e., in ModInterfacesInteract)
!
! INRT_BurnStatusUpdate, INRT_PrintMaterialInput,
! INRT_PrintUserInput, INRT_ReadMaterialInput,
! INRT_SetMaterial, INRT_SetParticleTemp, INRT_SourceTerms,
! INRT_TwoDimAverage, INRT_UserInput, INRT_VaporEnergyConversion

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

  SUBROUTINE inrt_allocateauxillary( global,inrt,nEdges,nSwitches,nData )
    USE modglobal,   ONLY : t_global
    USE modinteract, ONLY : t_inrt_interact
    TYPE(t_global),        POINTER    :: global
    TYPE(t_inrt_interact), POINTER    :: inrt
    INTEGER,               INTENT(IN) :: nedges,nswitches,ndata
  END SUBROUTINE inrt_allocateauxillary

  SUBROUTINE inrt_augmentconsources( region,iInrt )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
    INTEGER,        INTENT(IN)    :: iinrt
  END SUBROUTINE inrt_augmentconsources

  SUBROUTINE inrt_augmentdissources( region,iInrt )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT), TARGET :: region
    INTEGER,        INTENT(IN)            :: iinrt
  END SUBROUTINE inrt_augmentdissources

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

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

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

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

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

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

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

  SUBROUTINE inrt_defineburning( region,matIndIn,matIndOut,matIndOx, &
                                 oxused,plagoutexists )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), INTENT(INOUT) :: region
    INTEGER,        INTENT(IN)    :: matindin,matindout,matindox
    LOGICAL,        INTENT(INOUT) :: oxused
    LOGICAL,        INTENT(OUT)   :: plagoutexists
  END SUBROUTINE inrt_defineburning

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

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

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

  SUBROUTINE inrt_determinetokens( region,inrt )
    USE moddatastruct, ONLY : t_region
    USE modinteract,   ONLY : t_inrt_interact
    TYPE(t_region),        INTENT(INOUT) :: region
    TYPE(t_inrt_interact), POINTER       :: inrt
  END SUBROUTINE inrt_determinetokens

  SUBROUTINE inrt_finishmomentumedge(global,inrt,iXEdge,iEnd)
    USE modglobal,   ONLY : t_global
    USE modinteract, ONLY : t_inrt_interact
    TYPE(t_global),        POINTER    :: global
    TYPE(t_inrt_interact), POINTER    :: inrt
    INTEGER,               INTENT(IN) :: ixedge,iend
  END SUBROUTINE inrt_finishmomentumedge

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

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

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

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

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

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

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

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

  SUBROUTINE inrt_setactiveness( global,val,actv )
    USE modglobal, ONLY : t_global
    USE moddatatypes
    TYPE(t_global), POINTER     :: global
    REAL(RFREAL),   INTENT(IN)  :: val
    INTEGER,        INTENT(OUT) :: actv
  END SUBROUTINE inrt_setactiveness

  SUBROUTINE inrt_setpermission( global,val,perm )
    USE modglobal, ONLY : t_global
    USE moddatatypes
    TYPE(t_global), POINTER     :: global
    REAL(RFREAL),   INTENT(IN)  :: val
    INTEGER,        INTENT(OUT) :: perm
  END SUBROUTINE inrt_setpermission

  END INTERFACE

END MODULE inrt_modinterfaces

!******************************************************************************
!
! RCS Revision history:
!
! $Log: INRT_ModInterfaces.F90,v $
! Revision 1.15  2008/12/06 08:44:31  mtcampbe
! Updated license.
!
! Revision 1.14  2008/11/19 22:17:44  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.13  2004/07/28 15:42:12  jferry
! deleted defunct constructs: useDetangle, useSmokeDrag, useSmokeHeatTransfer
!
! Revision 1.12  2004/07/27 21:27:13  jferry
! removed rocinteract allocation routines (moved to rocpart)
!
! Revision 1.11  2004/07/26 17:05:51  fnajjar
! moved allocation of inrtSources into Rocpart
!
! Revision 1.10  2004/04/15 16:04:21  jferry
! minor formatting (removed trailing spaces)
!
! Revision 1.9  2004/03/08 21:57:36  jferry
! better error checking for burning without smoke case
!
! Revision 1.8  2004/03/02 21:47:29  jferry
! Added After Update interactions
!
! Revision 1.7  2003/09/25 15:48:43  jferry
! implemented Boiling Regulation interaction
!
! Revision 1.6  2003/09/19 20:35:26  jferry
! Implemented oxidizer species for burning interaction
!
! Revision 1.5  2003/04/03 16:18:28  fnajjar
! Include routines for burning and scouring
!
! Revision 1.4  2003/04/02 22:32:03  jferry
! codified Activeness and Permission structures for rocinteract
!
! Revision 1.3  2003/03/24 23:30:52  jferry
! overhauled rocinteract to allow interaction design to use user input
!
! Revision 1.2  2003/03/11 16:09:17  jferry
! Added new routines
!
! Revision 1.1  2003/03/04 22:12:35  jferry
! Initial import of Rocinteract
!
!******************************************************************************