PLAG_CECellsWrapper.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: wrapper for corner and edge Cells update step in PLAG module.
!
! Description: none.
!
! Input: regions = data of all regions,
!
! Output: regions%levels%plag = solution in corner and edge cells
!                               after one RK stage.
!
! Notes: none.
!
!******************************************************************************
!
! $Id: PLAG_CECellsWrapper.F90,v 1.3 2008/12/06 08:44:33 mtcampbe Exp $
!
! Copyright: (c) 2003 by the University of Illinois
!
!******************************************************************************

SUBROUTINE plag_cecellswrapper( regions )

  USE moddatatypes
  USE moddatastruct, ONLY : t_region
  USE modglobal, ONLY     : t_global
  USE moderror
  USE modmpi
  USE modparameters
  USE plag_modinterfaces, ONLY : plag_cecellsexchange,        &
                                 plag_cecellsgetbuffersize,   &
                                 plag_cecellsloaddatawrapper, &
                                 plag_cecellssendrecvwrapper 

  IMPLICIT NONE

! ... parameters
  TYPE(t_region), POINTER :: regions(:)

! ... loop variables
  INTEGER :: ireg

! ... local variables
  CHARACTER(CHRLEN) :: rcsidentstring

  TYPE(t_global), POINTER :: global

!******************************************************************************

  rcsidentstring = '$RCSfile: PLAG_CECellsWrapper.F90,v $ $Revision: 1.3 $'

  global => regions(1)%global

  CALL registerfunction( global,'PLAG_CECellsWrapper',&
  'PLAG_CECellsWrapper.F90' )

! check if module is active in any region======================================

  IF (.NOT. global%plagUsed) goto 999

! Load buffer data for on-processor regions -----------------------------------

  DO ireg=1,global%nRegions
    IF (regions(ireg)%procid==global%myProcid .AND. &   ! region active and
        regions(ireg)%active==active ) THEN             ! on my processor

#ifdef PLAG_CECELLS_DEBUG
      WRITE(*,*) '----------------------------------------------------'
      WRITE(*,*) 'Entering PLAG_CECellsGetBufferSize  : iReg=',ireg
#endif
      CALL plag_cecellsgetbuffersize(   regions(ireg), ireg )

#ifdef PLAG_CECELLS_DEBUG
      WRITE(*,*) '----------------------------------------------------'
      WRITE(*,*) 'Entering PLAG_CECellsLoadDataWrapper: iReg=',ireg
#endif
      CALL plag_cecellsloaddatawrapper( regions      , ireg )
    ENDIF ! regions

  ENDDO ! iReg

! Exchange buffer for on-processor regions ------------------------------------

  DO ireg=1,global%nRegions
    IF (regions(ireg)%procid==global%myProcid .AND. &   ! region active and
        regions(ireg)%active==active ) THEN             ! on my processor

#ifdef PLAG_CECELLS_DEBUG
      WRITE(*,*) '----------------------------------------------------'
      WRITE(*,*) 'Entering PLAG_CECellsExchange: iReg=',ireg
#endif
      CALL plag_cecellsexchange( regions, ireg )

    ENDIF ! regions

  ENDDO ! iReg

! ******************************************************************************
! Synchronize through an MPI barrier 
! ******************************************************************************

#ifdef MPI
  CALL mpi_barrier( global%mpiComm,global%mpierr )
  IF ( global%mpierr /= err_none ) &
    CALL errorstop( global,err_mpi_trouble,__line__ )
#endif

! Communicate buffer data for off-processor regions ---------------------------

  CALL plag_cecellssendrecvwrapper( regions )

! finalize ====================================================================

999 CONTINUE
  CALL deregisterfunction( global )

END SUBROUTINE plag_cecellswrapper

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_CECellsWrapper.F90,v $
! Revision 1.3  2008/12/06 08:44:33  mtcampbe
! Updated license.
!
! Revision 1.2  2008/11/19 22:17:45  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.1  2004/12/01 20:57:21  fnajjar
! Initial revision after changing case
!
! Revision 1.4  2004/03/10 23:14:04  fnajjar
! Cleaned dead sections and included call for MPI-based corner-edge cells wrapper
!
! Revision 1.3  2004/03/05 22:09:03  jferry
! created global variables for peul, plag, and inrt use
!
! Revision 1.2  2004/01/26 22:54:43  fnajjar
! Included new wrapper for load data, PLAG_cECellsLoadDataWrapper
!
! Revision 1.1  2003/11/12 21:37:59  fnajjar
! Initial import of Corner-Edge cells Infrastructure
!
!******************************************************************************