PLAG_RFLU_Update.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: Update step for PLAG module.
!
! Description: None.
!
! Input: 
!   pRegion     Pointer to region
!   iStage      Current RK stage
!
! Output: None.
!
! Notes: 
!   1. This corresponds to Part IV Steps 10d and Part V in RocfluidMP 
!      framework description.
!
! ******************************************************************************
!
! $Id: PLAG_RFLU_Update.F90,v 1.22 2008/12/06 08:44:35 mtcampbe Exp $
!
! Copyright: (c) 2004-2005 by the University of Illinois
!
! ******************************************************************************

SUBROUTINE plag_rflu_update(pRegion,iStage)

  USE moddatatypes
  USE modglobal, ONLY: t_global
  USE moddatastruct, ONLY: t_region
  USE modpartlag, ONLY: t_plag
  USE moderror
  USE modmpi

  USE modparameters
  USE plag_modparameters         

  USE modinterfaces, ONLY: rflu_decideprint, & 
                           rkupdategeneric

  USE plag_modinterfaces, ONLY: plag_calcbreakup, &
                                plag_calcrhsposition, &
                                plag_rflu_injectiondriver, &
                                plag_updatedatastruct

  USE plag_modreallocatememory
  USE plag_rflu_modfindcells
  USE plag_rflu_modcomm
  
  IMPLICIT NONE

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

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

  INTEGER, INTENT(IN) :: istage
  TYPE(t_region), POINTER :: pregion

! ==============================================================================  
! Locals
! ==============================================================================  

  CHARACTER(CHRLEN) :: rcsidentstring
  LOGICAL :: doprint
  INTEGER :: ireg
  TYPE(t_global), POINTER :: global
  TYPE(t_plag),   POINTER :: pplag

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

  rcsidentstring = '$RCSfile: PLAG_RFLU_Update.F90,v $ $Revision: 1.22 $'

  global => pregion%global

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

! ******************************************************************************
! Set variables and pointers
! ******************************************************************************

  pplag => pregion%plag

  ireg  = pregion%iRegionGlobal

! ******************************************************************************
! Initialize send counters even for null nPcls
! ******************************************************************************

  CALL plag_rflu_initsendcounters(pregion)      

! ******************************************************************************
! Main algorithm for discrete particle evolution
! ******************************************************************************

  IF ( pplag%nPcls > 0 ) THEN

! ============================================================================== 
!   Calculate RHS for position vector
! ============================================================================== 

    CALL plag_calcrhsposition(pregion)

! ============================================================================== 
!   Invoke RK Update
! ============================================================================== 

    CALL rkupdategeneric(pregion,var_type_point,istage,1,pplag%nPcls,1, & 
                         pplag%nCv,pplag%cv,pplag%cvOld,pplag%rhs,pplag%rhsSum)

! TEMPORARY
! ============================================================================== 
!   Create New location for particle search testing  
! ============================================================================== 
!
!    CALL PLAG_CreateLocation(pRegion)
! END TEMPORARY

! ============================================================================== 
!   Determine total distance travelled
! ============================================================================== 

    CALL plag_rflu_computedisttot(pregion)      

! ============================================================================== 
!   Invoke particle location search. NOTE brute-force and Octree cannot deal 
!   with particles hitting the wall and bouncing. They should only be used for
!   testing purposes.
! ============================================================================== 

    SELECT CASE ( pregion%plagInput%findPclMethod )
      CASE ( find_pcl_method_traj_fast ) 
        CALL plag_rflu_findcellstrajfast(pregion,1,pplag%nPcls)      
      CASE ( find_pcl_method_traj_safe ) 
        CALL plag_rflu_findcellstrajsafe(pregion,1,pplag%nPcls)  
      CASE ( find_pcl_method_brute ) 
        CALL plag_rflu_findcellsbrutemod(pregion)
      CASE ( find_pcl_method_oct ) 
        CALL plag_rflu_findcellsoctmod(pregion)
      CASE ( find_pcl_method_lohner ) 
        CALL plag_rflu_findcellslohner(pregion)
      CASE default 
        CALL errorstop(global,err_reached_default,__line__)
    END SELECT ! pRegion%plagInput%findPclMethod

! ============================================================================== 
!   Update particle data structure 
!    Note: done for serial computations, else for parallel runs
!          update performed in PLAG_RFLU_CommDriver
! ============================================================================== 
    
    IF ( global%nRegions == 1 ) &
      CALL plag_updatedatastruct(pregion)    
  END IF ! nPcls

! ******************************************************************************
! Invoke injection algorithm at last RK stage 
! ******************************************************************************

  IF ( istage == global%nrkSteps ) THEN 
    CALL plag_rflu_injectiondriver(pregion)
  END IF ! iStage

! ******************************************************************************
! Print number of particles in the domain 
! ******************************************************************************

! TEMPORARY
!  IF ( iStage == global%nrkSteps ) THEN 
!    doPrint = RFLU_DecidePrint(global)
!    IF ( (global%verbLevel > VERBOSE_NONE) .AND. (doPrint .EQV. .TRUE.)  ) & 
!      WRITE(STDOUT,'(A,I4,I8)') 'iReg: nPcls = ',iReg,pPlag%nPcls
!  END IF ! iStage
! END TEMPORARY

! ******************************************************************************
! Invoke breakup algorithm at last RK stage
! ******************************************************************************

  IF ( pregion%plagInput%breakupModel > plag_breakup_nomodel .AND. &
       istage == global%nrkSteps ) THEN 
    CALL plag_calcbreakup(pregion,ireg)
  END IF ! pRegion%plagInput%breakupModel

! ******************************************************************************
! Invoke memory reallocation at last RK stage and for non null size
! ******************************************************************************

  IF ( pplag%nPcls > 0 .AND. istage == global%nrkSteps ) THEN 
    CALL plag_reallocmemwrapper(pregion)   
  END IF ! pPlag%nPcls

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

  CALL deregisterfunction( global )

END SUBROUTINE plag_rflu_update

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_RFLU_Update.F90,v $
! Revision 1.22  2008/12/06 08:44:35  mtcampbe
! Updated license.
!
! Revision 1.21  2008/11/19 22:17:48  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.20  2007/03/20 22:04:07  fnajjar
! Turned off printing of number of particles for each region separately
!
! Revision 1.19  2006/05/20 19:08:24  fnajjar
! Fixed bug by moving initialization of nPclsSend out IF nPcls Statement
!
! Revision 1.18  2006/04/07 15:19:24  haselbac
! Removed tabs
!
! Revision 1.17  2005/12/19 16:47:12  fnajjar
! Added if statement to call PLAG_UpdateDataStruc for single region
!
! Revision 1.16  2005/05/18 22:21:29  fnajjar
! Added init of send counters, comp of distTot
!
! Revision 1.15  2005/05/02 21:59:02  haselbac
! Adapted to changes in interface of PLAG_RFLU_FindCellsTraj routines
!
! Revision 1.14  2005/04/27 14:57:58  fnajjar
! Included module call to PLAG_RFLU_ModFindCells
!
! Revision 1.13  2005/03/11 02:28:16  haselbac
! Adapted to new PLAG_RFLU_FindCellsTrajXYZ routines
!
! Revision 1.12  2005/01/01 21:32:21  haselbac
! Added routine to find particle cells using Aptes method
!
! Revision 1.11  2004/11/17 16:42:41  haselbac
! Replaced RKUpdate call with call to RkUpdateGeneric
!
! Revision 1.10  2004/11/06 21:08:41  fnajjar
! Bug fix: added interface entries for particle-cell search routines
!
! Revision 1.9  2004/11/06 18:48:44  fnajjar
! Added doPrint statement to decide printout for nPcls
!
! Revision 1.8  2004/11/05 21:50:09  fnajjar
! Updated calls to particle-cell search routines
!
! Revision 1.7  2004/10/11 22:10:01  haselbac
! Renamed procedures, changed IF to SELECT
!
! Revision 1.6  2004/10/08 22:11:20  haselbac
! Added brute-force search option for finding particle positions
!
! Revision 1.5  2004/07/29 16:32:22  fnajjar
! Removed temporary io flag for cleaner version
!
! Revision 1.4  2004/07/29 16:05:36  fnajjar
! Removed temporary io file after memory reallocation
!
! Revision 1.3  2004/07/28 18:58:54  fnajjar
! Included dynamic memory reallocation call
!
! Revision 1.2  2004/05/05 20:59:55  fnajjar
! Clean up; removed output statements
!
! Revision 1.1  2004/03/26 21:33:24  fnajjar
! Initial import for RFLU-specific update routine
!
! ******************************************************************************