PLAG_RFLU_AllocMemTStep.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: Allocate memory for Lagrangian particles related to time stepping.
!
! Description: None.
!
! Input: 
!   pRegion     Region pointer
!   pPlag       Pointer to particle data structure
!
! Output: None.
!
! Notes: None.
!
!******************************************************************************
!
! $Id: PLAG_RFLU_AllocMemTStep.F90,v 1.8 2008/12/06 08:44:35 mtcampbe Exp $
!
! Copyright: (c) 2004 by the University of Illinois
!
!******************************************************************************

SUBROUTINE plag_rflu_allocmemtstep(pRegion,pPlag)

  USE moddatatypes
  USE moderror
  USE modparameters  
  USE modglobal, ONLY: t_global 
  USE modgrid, ONLY: t_grid
  USE moddatastruct, ONLY: t_region
  USE modpartlag, ONLY: t_plag  
  USE modmpi
   
  IMPLICIT NONE

! ******************************************************************************
! Definitions and declarations
! ******************************************************************************

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

  TYPE(t_region), POINTER :: pregion
  TYPE(t_plag), POINTER :: pplag

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

  CHARACTER(CHRLEN) :: rcsidentstring
  INTEGER :: errorflag,ipcl,ivar,naiv,narv,ncv,npclsmax
  TYPE(t_grid), POINTER :: pgrid
  TYPE(t_global), POINTER :: global 

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

  rcsidentstring = '$RCSfile: PLAG_RFLU_AllocMemTStep.F90,v $ $Revision: 1.8 $'

  global => pregion%global

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

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

  pgrid  => pregion%grid

  npclsmax = pregion%plag%nPclsMax

  naiv = pplag%nAiv
  narv = pplag%nArv

  ncv  = pplag%nCv

! ******************************************************************************
! Allocate memory
! ******************************************************************************

! ==============================================================================
! Old state vector
! ==============================================================================

  ALLOCATE(pplag%cvOld(ncv,npclsmax),stat=errorflag)
  global%error = errorflag
  IF (global%error /= err_none) THEN 
    CALL errorstop(global,err_allocate,__line__,'pPlag%cvOld')
  END IF ! global%error 

! ==============================================================================
! Additional variables  
! ==============================================================================

  ALLOCATE(pplag%aivOld(naiv,npclsmax),stat=errorflag)
  global%error = errorflag
  IF (global%error /= err_none) THEN 
    CALL errorstop(global,err_allocate,__line__,'pPlag%aivOld')
  END IF ! global%error 

  ALLOCATE(pplag%arvOld(narv,npclsmax),stat=errorflag)
  global%error = errorflag
  IF (global%error /= err_none) THEN 
    CALL errorstop(global,err_allocate,__line__,'pPlag%arvOld')
  END IF ! global%error

! ==============================================================================     
! Residuals 
! ==============================================================================
  
  ALLOCATE(pplag%rhs(ncv,npclsmax),stat=errorflag)
  global%error = errorflag
  IF (global%error /= err_none) THEN 
    CALL errorstop(global,err_allocate,__line__,'pPlag%rhs')
  END IF ! global%error  
  
  ALLOCATE(pplag%rhsSum(ncv,npclsmax),stat=errorflag)
  global%error = errorflag
  IF (global%error /= err_none) THEN 
    CALL errorstop(global,err_allocate,__line__,'pPlag%rhsSum')
  END IF ! global%error  

! ******************************************************************************
! Initialize memory
! ******************************************************************************

  DO ipcl = 1,npclsmax
    DO ivar = 1,ncv
      pplag%cvOld(ivar,ipcl)  = 0.0_rfreal
      pplag%rhs(ivar,ipcl)    = 0.0_rfreal
      pplag%rhsSum(ivar,ipcl) = 0.0_rfreal
    END DO ! iVar

    DO ivar = 1,naiv
      pplag%aivOld(ivar,ipcl) = 0
    END DO ! iVar
    
    DO ivar = 1,narv   
      pplag%arvOld(ivar,ipcl) = 0
    END DO ! iVar
  END DO ! iPcl
  
! ******************************************************************************
! End
! ******************************************************************************

  CALL deregisterfunction(global)

END SUBROUTINE plag_rflu_allocmemtstep

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_RFLU_AllocMemTStep.F90,v $
! Revision 1.8  2008/12/06 08:44:35  mtcampbe
! Updated license.
!
! Revision 1.7  2008/11/19 22:17:47  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.6  2007/03/06 23:15:32  fnajjar
! Renamed nPclsTot to nPclsMax
!
! Revision 1.5  2006/04/07 15:19:24  haselbac
! Removed tabs
!
! Revision 1.4  2004/07/28 18:58:13  fnajjar
! Included new definition for nPclsTot from dynamic memory reallocation
!
! Revision 1.3  2004/07/16 20:09:39  fnajjar
! Bug fix to initialize cvOld instead of cv
!
! Revision 1.2  2004/03/08 23:02:28  fnajjar
! Added initialization section within DO-loop construct
!
! Revision 1.1  2004/02/26 21:00:39  haselbac
! Initial revision
!
!******************************************************************************