PLAG_InitPatchData.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: Initialize patch data for Rocpart.
!
! Description: None.
!
! Input: 
!   pRegion     Pointer to region
!
! Output: None.
!
! Notes:
!   1. Only treat injection boundaries right now.  
!   2. Avoid error if randUnif is 0, and set timefactor such that 
!      EXP(-50) = 1.9E-22
!
!******************************************************************************
!
! $Id: PLAG_InitPatchData.F90,v 1.7 2009/03/02 00:19:36 mtcampbe Exp $
!
! Copyright: (c) 2004 by the University of Illinois
!
!******************************************************************************

SUBROUTINE plag_initpatchdata(pRegion)

  USE moddatatypes
  USE modpartlag, ONLY: t_tile_plag
  USE modbndpatch, ONLY: t_patch
  USE moddatastruct, ONLY: t_region
  USE modglobal, ONLY: t_global
  USE modrandom, ONLY: rand1uniform
  USE moderror
  USE modparameters
  USE modmpi

  USE plag_modparameters
  
  USE plag_modinterfaces, ONLY: plag_injcmakeparticle

  IMPLICIT NONE

! ******************************************************************************
! Declarations and definitions
! ******************************************************************************  

! ==============================================================================
! Arguments
! ==============================================================================

  TYPE(t_region), POINTER :: pregion  
   
! ==============================================================================
! Local variables
! ==============================================================================

  CHARACTER(CHRLEN) :: rcsidentstring
  INTEGER :: injcdiamdist,ipatch,itile,npatches,ntiles
#ifdef RFLO
  INTEGER :: ilev,n1,n2
#endif
  REAL(RFREAL) :: randunif
  TYPE(t_patch), POINTER :: ppatch
  TYPE(t_tile_plag), POINTER :: ptileplag
  TYPE(t_global), POINTER :: global

! ******************************************************************************
! Start
! ******************************************************************************

  rcsidentstring = '$RCSfile: PLAG_InitPatchData.F90,v $ $Revision: 1.7 $'

  global => pregion%global

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

#ifdef RFLO
  ilev     = pregion%currLevel
  npatches = pregion%nPatches
#endif
#ifdef RFLU
  npatches = pregion%grid%nPatches
#endif

  injcdiamdist = pregion%plagInput%injcDiamDist

! ******************************************************************************
! Loop over patches
! ******************************************************************************

  DO ipatch=1,npatches
#ifdef RFLO
    ppatch => pregion%levels(ilev)%patches(ipatch)
#endif
#ifdef RFLU
    ppatch => pregion%patches(ipatch)
#endif

! ==============================================================================
!   Select patch type
! ==============================================================================

    SELECT CASE ( ppatch%bcType )
    
! ------------------------------------------------------------------------------    
!     Injection boundary
! ------------------------------------------------------------------------------    
    
#ifdef RFLU
      CASE ( bc_injection:bc_injection+bc_range, &
             bc_inflow:bc_inflow+bc_range        ) 
#else
      CASE ( bc_injection:bc_injection+bc_range )
#endif
! ----- Get dimensions ---------------------------------------------------------

#ifdef RFLO
        n1     = abs(ppatch%l1end-ppatch%l1beg) + 1    
        n2     = abs(ppatch%l2end-ppatch%l2beg) + 1
        ntiles = n1*n2
#endif
#ifdef RFLU
        ntiles = ppatch%nBFaces
#endif

        ptileplag => ppatch%tilePlag


! ----- Loop over tiles --------------------------------------------------------

        DO itile = 1,ntiles
          CALL plag_injcmakeparticle(pregion,injcdiamdist, &
                                     ptileplag%dv(dv_tile_diam,itile), &
                                     ptileplag%dv(dv_tile_spload,itile))

          randunif = rand1uniform(pregion%randData) 

          IF ( randunif <= 0.0_rfreal ) THEN          
            ptileplag%dv(dv_tile_countdown,itile) = 50.0_rfreal 
          ELSE
            ptileplag%dv(dv_tile_countdown,itile) = -log(randunif)
          END IF ! randUnif
        END DO ! iTile
    END SELECT ! pPatch%bcType
  END DO ! iPatch

! ******************************************************************************
! End
! ******************************************************************************

  CALL deregisterfunction(global)

END SUBROUTINE plag_initpatchdata

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_InitPatchData.F90,v $
! Revision 1.7  2009/03/02 00:19:36  mtcampbe
! Added some ifdefs around Rocflo to disable particle injection on INFLOW
! boundaries and added some checks around MPI tags utilizing a new global
! data item, global%mpiTagMax.
!
! Revision 1.6  2008/12/06 08:44:33  mtcampbe
! Updated license.
!
! Revision 1.5  2008/11/19 22:17:46  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.4  2006/09/18 20:29:07  fnajjar
! Activated tile infrastructure for inflow bc
!
! Revision 1.3  2006/04/07 15:19:23  haselbac
! Removed tabs
!
! Revision 1.2  2004/06/16 22:58:13  fnajjar
! Renamed injcModel to injcDiamDist and dv(TIMEFCTR) to dv(COUNTDOWN) for CRE kernel
!
! Revision 1.1  2004/03/05 23:15:54  haselbac
! Initial revision
!
!******************************************************************************