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

MODULE modinterfacesspecies

  IMPLICIT NONE

  INTERFACE

! ==============================================================================
!   Common routines
! ==============================================================================

    SUBROUTINE spec_buildversionstring(versionString)
      CHARACTER(*) :: versionstring
    END SUBROUTINE spec_buildversionstring

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

    SUBROUTINE spec_updatedependentvars(pRegion,icgBeg,icgEnd)
      USE moddatastruct, ONLY : t_region
      INTEGER, INTENT(IN) :: icgbeg,icgend        
      TYPE(t_region), POINTER :: pregion
    END SUBROUTINE spec_updatedependentvars

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

# ifdef RFLU
! ==============================================================================
!   Rocflu-specific routines
! ==============================================================================

    SUBROUTINE spec_eqeulcorr(pRegion,iSpec)
      USE moddatastruct, ONLY : t_region
      INTEGER, INTENT(IN) :: ispec
      TYPE(t_region), POINTER :: pregion
    END SUBROUTINE spec_eqeulcorr

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    SUBROUTINE spec_rflu_readbcsectiondummy(pRegion)
      USE moddatastruct, ONLY : t_region
      TYPE(t_region), POINTER :: pregion
    END SUBROUTINE spec_rflu_readbcsectiondummy
    
    SUBROUTINE spec_rflu_seteev(pRegion,iSpec)
      USE moddatastruct, ONLY : t_region
      INTEGER, INTENT(IN) :: ispec
      TYPE(t_region), POINTER :: pregion
    END SUBROUTINE spec_rflu_seteev

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

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

  END INTERFACE

END MODULE modinterfacesspecies

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: ModInterfacesSpecies.F90,v $
! Revision 1.13  2008/12/06 08:44:18  mtcampbe
! Updated license.
!
! Revision 1.12  2008/11/19 22:17:30  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.11  2006/03/26 20:21:55  haselbac
! Added if for new routine
!
! Revision 1.10  2005/11/27 01:50:27  haselbac
! Added IFs for EEv routines, removed IFs for {Read/Write}Flow routines
!
! Revision 1.9  2005/04/15 15:06:31  haselbac
! Removed and updated interfaces, cosmetics
!
! Revision 1.8  2005/03/31 16:53:39  haselbac
! Added interface for SPEC_RFLU_ReadBcSectionDummy
!
! Revision 1.7  2004/12/01 00:09:31  wasistho
! added BuildVersionString
!
! Revision 1.6  2004/11/14 19:45:06  haselbac
! Changed interface
!
! Revision 1.5  2004/11/02 02:28:55  haselbac
! Added interface for SPEC_RFLU_SetVarInfo
!
! Revision 1.4  2004/07/30 22:47:35  jferry
! Implemented Equilibrium Eulerian method for Rocflu
!
! Revision 1.3  2004/01/29 22:57:25  haselbac
! Added interfaces for new routines
!
! Revision 1.2  2003/11/25 21:03:12  haselbac
! Added interfaces for new routines
!
! Revision 1.1  2002/12/27 22:07:14  jblazek
! Splitted up RFLO_ModInterfaces and ModInterfaces.
!
! ******************************************************************************