PEUL_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 Eulerian
!          particles for all active regions on current processor.
!
! Description: none.
!
! Input: region = current region
!
! Output: region%levels(iLev)%peul = Eulerian particle variables
!         region%levels(iLev)%grid = grid variables
!
! Notes: none.
!
!******************************************************************************
!
! $Id: PEUL_AllocateMemory.F90,v 1.3 2008/12/06 08:44:38 mtcampbe Exp $
!
! Copyright: (c) 2002 by the University of Illinois
!
!******************************************************************************

SUBROUTINE peul_allocatememory( region ) ! PUBLIC

  USE moddatatypes
  USE moddatastruct, ONLY : t_region, t_level
  USE modglobal,     ONLY : t_global
  USE modgrid,       ONLY : t_grid
  USE modparteul,    ONLY : t_peul
  USE moderror
  USE modparameters

  USE modinterfaces, ONLY : rflo_getdimensdummynodes, rflo_getnodeoffset, &
                            rflo_getdimensdummy, rflo_getcelloffset
  IMPLICIT NONE

#include "Indexing.h"

! ... parameters
  TYPE(t_region), INTENT(INOUT) :: region

! ... loop variables
  INTEGER :: ilev

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

  INTEGER :: idcbeg, idcend, jdcbeg, jdcend, kdcbeg, kdcend
  INTEGER :: idnbeg, idnend, jdnbeg, jdnend, kdnbeg, kdnend
  INTEGER :: ibc, iec, ibn, ien, icelloffset, ijcelloffset
  INTEGER :: inodeoffset, ijnodeoffset, errorflag

  TYPE(t_level),  POINTER :: level
  TYPE(t_grid) ,  POINTER :: grid, gridold
  TYPE(t_peul) ,  POINTER :: peul
  TYPE(t_global), POINTER :: global

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

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

  global => region%global

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

! begin -----------------------------------------------------------------------

! loop over all grid levels

  DO ilev=1,region%nGridLevels

    level   => region%levels(ilev)
    grid    => level%grid
    gridold => level%gridOld
    peul    => level%peul

! - get cell and node dimensions

    CALL rflo_getdimensdummy( region,ilev,idcbeg,idcend, &
                              jdcbeg,jdcend,kdcbeg,kdcend )
    CALL rflo_getcelloffset( region,ilev,icelloffset,ijcelloffset )
    ibc = indijk(idcbeg,jdcbeg,kdcbeg,icelloffset,ijcelloffset)
    iec = indijk(idcend,jdcend,kdcend,icelloffset,ijcelloffset)

    CALL rflo_getdimensdummynodes( region,ilev,idnbeg,idnend, &
                                   jdnbeg,jdnend,kdnbeg,kdnend )
    CALL rflo_getnodeoffset( region,ilev,inodeoffset,ijnodeoffset )
    ibn = indijk(idnbeg,jdnbeg,kdnbeg,inodeoffset,ijnodeoffset)
    ien = indijk(idnend,jdnend,kdnend,inodeoffset,ijnodeoffset)

! - spectral radii

    ALLOCATE( peul%srad(3,ibc:iec),stat=errorflag )
    global%error = errorflag
    IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )

! - coefficients of implicit residual smoothing

    IF (global%flowType==flow_steady .AND. &
        region%peulInput%smoocf>0._rfreal) THEN
      ALLOCATE( peul%epsIrs(3,ibc:iec), stat=errorflag )
      global%error = errorflag
      IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )
    ELSE
      nullify( peul%epsIrs )
    ENDIF

! - Eulerian particle variables

    ALLOCATE( peul%cv   (peul%nCv,ibc:iec),stat=errorflag )
    global%error = errorflag
    IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )

    ALLOCATE( peul%cvOld(peul%nCv,ibc:iec),stat=errorflag )
    global%error = errorflag
    IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )

    ALLOCATE( peul%rhs  (peul%nCv,ibc:iec),stat=errorflag )
    global%error = errorflag
    IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )

    ALLOCATE( peul%diss (peul%nCv,ibc:iec),stat=errorflag )
    global%error = errorflag
    IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )

    IF (peul%nDv > 0) THEN
      ALLOCATE( peul%dv(peul%nDv,ibc:iec),stat=errorflag )
      global%error = errorflag
      IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )
    ELSE
      nullify( peul%dv )
    ENDIF

    IF (peul%nTv > 0) THEN
      ALLOCATE( peul%tv(peul%nTv,ibc:iec),stat=errorflag )
      global%error = errorflag
      IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )
    ELSE
      nullify( peul%tv )
    ENDIF

    IF (ilev>1 .AND. global%cycleType/=mgcycle_no) THEN
      ALLOCATE( peul%fterm(peul%nCv,ibc:iec),stat=errorflag )
      global%error = errorflag
      IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )
    ELSE
      nullify( peul%fterm )
    ENDIF

    IF (global%flowType == flow_unsteady) THEN
      ALLOCATE( peul%rhsSum(peul%nCv,ibc:iec),stat=errorflag )
      global%error = errorflag
      IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )
    ELSE
      nullify( peul%rhsSum )
    ENDIF

  ENDDO   ! iLev

! finalize --------------------------------------------------------------------

  CALL deregisterfunction( global )

END SUBROUTINE peul_allocatememory

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PEUL_AllocateMemory.F90,v $
! Revision 1.3  2008/12/06 08:44:38  mtcampbe
! Updated license.
!
! Revision 1.2  2008/11/19 22:17:51  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.1  2004/12/01 21:09:13  haselbac
! Initial revision after changing case
!
! Revision 1.5  2004/03/05 22:09:04  jferry
! created global variables for peul, plag, and inrt use
!
! Revision 1.4  2003/05/15 02:57:05  jblazek
! Inlined index function.
!
! Revision 1.3  2003/04/07 18:29:01  jferry
! added inflow boundary condition and initialization to a constant
!
! Revision 1.2  2003/02/12 23:34:48  jferry
! Replaced [io]stat=global%error with local errorFlag
!
! Revision 1.1  2003/02/11 22:52:50  jferry
! Initial import of Rocsmoke
!
!******************************************************************************