PLAG_ModInterfacesCECells.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 corner and edge cells.
!
! Description: none.
!
! Notes: none.
!
!******************************************************************************
!
! $Id: PLAG_ModInterfacesCECells.F90,v 1.7 2008/12/06 08:44:34 mtcampbe Exp $
!
! Copyright: (c) 2003 by the University of Illinois
!
!******************************************************************************
  
MODULE plag_modinterfacescecells

  IMPLICIT NONE

  INTERFACE

! =============================================================================
! PLAG specific library
! =============================================================================
 
  SUBROUTINE plag_cecellsallocatedata( regions,iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
    INTEGER, INTENT(IN)     :: ireg
  END SUBROUTINE plag_cecellsallocatedata

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

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

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

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

  SUBROUTINE plag_cecellsfacecentroids( regions,iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
    INTEGER, INTENT(IN)     :: ireg
  END SUBROUTINE plag_cecellsfacecentroids
        
  SUBROUTINE plag_cecellsfacevectors( regions,iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
    INTEGER, INTENT(IN)     :: ireg
  END SUBROUTINE plag_cecellsfacevectors
        
  SUBROUTINE plag_cecellsgetbuffersize( region,iReg )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region)      :: region
    INTEGER, INTENT(IN) :: ireg
  END SUBROUTINE plag_cecellsgetbuffersize

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

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

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

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

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

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

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

  SUBROUTINE plag_corncellsloadsendbuff( regions, iReg, ir, nBuffSizeEdge, &
                                         nbuffsizecorn )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
    INTEGER, INTENT(IN)     :: ireg, ir
    INTEGER, INTENT(IN)     :: nbuffsizeedge
    INTEGER, INTENT(OUT)    :: nbuffsizecorn
  END SUBROUTINE plag_corncellsloadsendbuff

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

  SUBROUTINE plag_edgecellsloadsendbuff( regions, iReg, ir, nBuffSizeEdge )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
    INTEGER, INTENT(IN)     :: ireg, ir
    INTEGER, INTENT(OUT)    :: nbuffsizeedge
  END SUBROUTINE plag_edgecellsloadsendbuff

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

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

  SUBROUTINE plag_rflo_findsourcecell( regions,iReg,iLev,ic,jc,kc,&
                                       found,iregsrc,indexmapmat )
    USE moddatastruct, ONLY : t_region
    TYPE(t_region), POINTER :: regions(:)
    INTEGER, INTENT(IN)     :: ireg, ilev
    INTEGER, INTENT(INOUT)  :: ic, jc, kc
    INTEGER, INTENT(OUT)    :: iregsrc, indexmapmat(3,4)
    LOGICAL, INTENT(OUT)    :: found
  END SUBROUTINE plag_rflo_findsourcecell

  SUBROUTINE plag_rflo_getfacemapping( mapMat, srcDir, srcFace )
    INTEGER, INTENT(IN)  :: mapmat(3,4)
    INTEGER, INTENT(OUT) :: srcdir(3)
    INTEGER, INTENT(OUT) :: srcface(6)
  END SUBROUTINE plag_rflo_getfacemapping

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

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

  SUBROUTINE plag_rflo_sourcecell( region,regionSrc,patch,patchSrc, &
                                   ilev,ic,jc,kc,found,indexmapmat )
    USE moddatastruct, ONLY : t_region
    USE modbndpatch,   ONLY : t_patch
    TYPE(t_region)          :: region, regionsrc
    TYPE(t_patch), POINTER  :: patch, patchsrc
    INTEGER, INTENT(IN)     :: ilev
    INTEGER, INTENT(INOUT)  :: ic,jc,kc
    INTEGER, INTENT(OUT)    :: indexmapmat(3,4)
    LOGICAL, INTENT(INOUT)  :: found
  END SUBROUTINE plag_rflo_sourcecell
 
  END INTERFACE

END MODULE plag_modinterfacescecells

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_ModInterfacesCECells.F90,v $
! Revision 1.7  2008/12/06 08:44:34  mtcampbe
! Updated license.
!
! Revision 1.6  2008/11/19 22:17:46  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.5  2004/03/19 23:49:12  fnajjar
! Added interface call to loading buffers for MPI-based communications
!
! Revision 1.4  2004/03/10 23:12:54  fnajjar
! Included interfaces for MPI-based routines for corner-edge cells
!
! Revision 1.3  2004/02/10 21:23:08  fnajjar
! Added call and interfaces for index mapping between corner-edge regions
!
! Revision 1.2  2004/01/26 22:55:31  fnajjar
! Included calls to routines for corner-edge data loading
!
! Revision 1.1  2004/01/15 21:17:37  fnajjar
! Initial Import of Interface for corner-edge cell routines
!
!******************************************************************************