PLAG_AllocateMemory.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 all variables associated with the Lagrangian 
!          particles (PLAG) for all active regions on current processor.
!
! Description: none.
!
! Input: region = current region
!
! Output: region%plag = plag variables
!
! Notes: none.
!
!******************************************************************************
!
! $Id: PLAG_AllocateMemory.F90,v 1.5 2008/12/06 08:44:32 mtcampbe Exp $
!
! Copyright: (c) 2002 by the University of Illinois
!
!******************************************************************************

SUBROUTINE plag_allocatememory( region )

  USE moddatatypes
  USE moddatastruct, ONLY : t_region, t_level
  USE modglobal, ONLY     : t_global
  USE modpartlag, ONLY    : t_plag, t_plag_input
  USE modinterfaces, ONLY : rflo_getdimensdummynodes, &
                            rflo_getnodeoffset
  USE plag_modinterfaces, ONLY : plag_allocatememorytile, &
                                 plag_initmemory,         &
                                 plag_injctileinitialize
  USE moderror
  USE modparameters
  USE modmpi
  USE plag_modparameters

#ifdef STATS
  USE plag_modeulerian, ONLY: plag_createeulerianfield
  USE plag_modstats, ONLY: plag_createstat
#endif

  IMPLICIT NONE

#include "Indexing.h"

! ... parameters
  TYPE(t_region) :: region

! ... loop variables
  INTEGER :: icont, ilev

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

  INTEGER :: errorflag, ibn, idnbeg, idnend, ien, inoff, ijnoff, &
             jdnbeg, jdnend, kdnbeg, kdnend, naiv, narv, ncont,  &
             ncv, ndv, nev, npclsmax, ntv, maxdisedges

  TYPE(t_level),        POINTER :: plevel
  TYPE(t_plag),         POINTER :: pplag
  TYPE(t_global),       POINTER :: global
  
!******************************************************************************

  rcsidentstring = '$RCSfile: PLAG_AllocateMemory.F90,v $ $Revision: 1.5 $'
  
  global => region%global
  
  CALL registerfunction( global, 'PLAG_AllocateMemory',&
  'PLAG_AllocateMemory.F90' )

  IF ( global%myProcid == masterproc .AND. & 
       global%verbLevel > verbose_none ) THEN 
    WRITE(stdout,'(A,3X,A)') solver_name,'Allocating memory for PLAG...'
  END IF ! global%verbLevel

! Set max discrete edges ------------------------------------------------------
  
  maxdisedges = region%inrtInput%maxDisEdges 

! Loop over all grid levels ---------------------------------------------------

  DO ilev=1,region%nGridLevels

    plevel    => region%levels(ilev)
    pplag     => region%levels(ilev)%plag

! - Get particle dimensions ---------------------------------------------------

    npclsmax = region%plagInput%nPclsMax
    ncont    = region%plagInput%nCont

! - Set pointers --------------------------------------------------------------

    naiv = pplag%nAiv
    narv = pplag%nArv
            
    ncv  = pplag%nCv
    ndv  = pplag%nDv
    ntv  = pplag%nTv
    nev  = pplag%nEv

    IF ( global%myProcid == masterproc .AND. & 
         global%verbLevel > verbose_none ) THEN 
      WRITE(stdout,1015) '   nPclsMax',npclsmax
      WRITE(stdout,1010) '   nCont   ',ncont
      WRITE(stdout,1010) '   nAiv    ',naiv
      WRITE(stdout,1010) '   nArv    ',narv
      WRITE(stdout,1010) '   nCv     ',ncv
      WRITE(stdout,1010) '   nDv     ',ndv
      WRITE(stdout,1010) '   nTv     ',ntv
      WRITE(stdout,1010) '   nEv     ',nev
    END IF ! global%verbLevel
     
! - Lagrangian particles variables --------------------------------------------

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

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

    ALLOCATE( pplag%dv (ndv,npclsmax),stat=errorflag )
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop( global, err_allocate,__line__ ,'pPlag%dv' ) 
    END IF ! global%error
    
    ALLOCATE( pplag%tv (ntv,npclsmax),stat=errorflag )
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop( global, err_allocate,__line__ ,'pPlag%tv' ) 
    END IF ! global%error
    
    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

    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
    
    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

! - Lagrangian particles mass and volume indices ------------------------------
          
    ALLOCATE( pplag%cvPlagMass(ncont),stat=errorflag )
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop( global, err_allocate,__line__ ,'pPlag%cvPlagMass' )
    END IF ! global%error
          
    ALLOCATE( pplag%dvPlagVolu(ncont),stat=errorflag )
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop( global, err_allocate,__line__ ,'pPlag%dvPlagVolu' )
    END IF ! global%error
 
    DO icont = 1, ncont
      pplag%cvPlagMass(icont) = cv_plag_last  +icont
      pplag%dvPlagVolu(icont) = dv_plag_last  +icont
    END DO ! iCont

! - Get dimensions and pointers -----------------------------------------------

    CALL rflo_getdimensdummynodes( region,ilev,idnbeg,idnend, &
                                   jdnbeg,jdnend,kdnbeg,kdnend )
    CALL rflo_getnodeoffset( region,ilev,inoff,ijnoff )

    ibn = indijk(idnbeg,jdnbeg,kdnbeg,inoff,ijnoff)
    ien = indijk(idnend,jdnend,kdnend,inoff,ijnoff)

! - Allocate array for face centroids ----------------------------------------- 
   
    ALLOCATE( pplag%fc(zcoord,kcoord,ibn:ien),stat=errorflag )
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop( global, err_allocate,__line__ ,'pPlag%fc' )
    END IF ! global%error

! - Allocate array for face vectors ------------------------------------------- 

    ALLOCATE( pplag%si(zcoord,ibn:ien),stat=errorflag )
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop( global, err_allocate,__line__ ,'pPlag%si' )
    END IF ! global%error

    ALLOCATE( pplag%sj(zcoord,ibn:ien),stat=errorflag )
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop( global, err_allocate,__line__ ,'pPlag%sj' )
    END IF ! global%error

    ALLOCATE( pplag%sk(zcoord,ibn:ien),stat=errorflag )
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop( global, err_allocate,__line__ ,'pPlag%sk' )
    END IF ! global%error

! - Allocate source for INRT ----------------------------------------------------

!    CALL PLAG_INRT_AllocMem( region, pPlag ) 

    IF ( maxdisedges > 0 ) THEN
      ALLOCATE( pplag%inrtSources(maxdisedges,npclsmax), stat=errorflag )

      global%error = errorflag
      IF (global%error /= err_none) THEN
        CALL errorstop( global,err_allocate,__line__,'pPlag%inrtSources'  )
      END IF ! global%error

    ELSE
      nullify( pplag%inrtSources )

    END IF ! maxDisEdges

! - Allocate arrays for statistics --------------------------------------------

#ifdef STATS
    IF ( ( global%flowType == flow_unsteady ) .AND. &
         ( global%doStat == active )                ) THEN
      CALL plag_createeulerianfield( region, pplag )
      CALL plag_createstat( region, pplag )
    END IF ! global%flowType
#endif

  ENDDO   ! iLev

! Allocate memory for tiles ---------------------------------------------------

  CALL plag_allocatememorytile( region )

! Initialize memory -----------------------------------------------------------

  CALL plag_initmemory( region )

! Initialize tile datastructure -----------------------------------------------

  CALL plag_injctileinitialize( region ) 

! finalize

  CALL deregisterfunction( global )
  
1010 FORMAT(a,' = ',i2)
1015 FORMAT(a,' = ',i7)

END SUBROUTINE plag_allocatememory

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PLAG_AllocateMemory.F90,v $
! Revision 1.5  2008/12/06 08:44:32  mtcampbe
! Updated license.
!
! Revision 1.4  2008/11/19 22:17:45  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.3  2007/03/06 23:13:13  fnajjar
! Renamed nPclsTot to nPclsMax
!
! Revision 1.2  2005/01/08 20:41:38  fnajjar
! Included memory allocation for PLAG statistics
!
! Revision 1.1  2004/12/01 20:56:50  fnajjar
! Initial revision after changing case
!
! Revision 1.7  2004/07/26 17:05:51  fnajjar
! moved allocation of inrtSources into Rocpart
!
! Revision 1.6  2004/03/01 21:57:54  fnajjar
! Removed definitions of nAiv, nCv, nDv, nTv since now set in PLAG_derivedInputValues
!
! Revision 1.5  2003/11/03 21:19:29  fnajjar
! Added face vectors to PLAG infrastructure
!
! Revision 1.4  2003/05/27 19:14:16  fnajjar
! Removed distPartBurning and all pertinent LOGICAL datastructure
!
! Revision 1.3  2003/05/15 02:57:04  jblazek
! Inlined index function.
!
! Revision 1.2  2003/03/04 22:12:35  jferry
! Initial import of Rocinteract
!
! Revision 1.1  2002/10/25 14:13:59  f-najjar
! Initial Import of Rocpart
!
!
!******************************************************************************