TURB_ModPostFlu.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: Suite for turbulence postprocessing routines.
!
! Description: None.
!
! Notes: None.
!
! ******************************************************************************
!
! $Id: TURB_ModPostFlu.F90,v 1.3 2008/12/06 08:44:42 mtcampbe Exp $
!
! Copyright: (c) 2004 by the University of Illinois
!
! ******************************************************************************

MODULE turb_modpostflu

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

  PRIVATE

  PUBLIC :: turb_rflu_allocmempost, &
            turb_rflu_allocmempostvert, &
            turb_rflu_deallocmempost, &
            turb_rflu_deallocmempostvert
        
! ******************************************************************************
! Declarations and definitions
! ****************************************************************************** 
   
  CHARACTER(CHRLEN) :: RCSIdentString = & 
    '$RCSfile: TURB_ModPostFlu.F90,v $ $Revision: 1.3 $'        
             
! ******************************************************************************
! Routines
! ******************************************************************************

  CONTAINS


! ******************************************************************************
!
! Purpose: Allocate memory of turbulence post quantities.
!
! Description: None.
!
! Input:
!   pRegion        Region pointer
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

SUBROUTINE turb_rflu_allocmempost(pRegion)

  IMPLICIT NONE

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

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

  TYPE(t_region), POINTER :: pregion

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

  CHARACTER(CHRLEN) :: rcsidentstring
  INTEGER :: npostv, ntv, nvars, errorflag
  TYPE(t_grid), POINTER :: pgrid
  TYPE(t_global), POINTER :: global

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

  global => pregion%global

  CALL registerfunction(global,'TURB_RFLU_AllocMemPost',&
  'TURB_ModPostFlu.F90')

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

  npostv =  1   ! for tv(TV_MIXT_MUET,:)
  ntv    =  pregion%mixtInput%nTv
  nvars  =  pregion%turbInput%nOutField
  pgrid  => pregion%grid

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

! ==============================================================================
! Turbulence variables
! ==============================================================================

  IF (nvars > 1) THEN
    ALLOCATE(pregion%turb%vort(1,pgrid%nCellsTot),stat=errorflag)
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop(global,err_allocate,__line__,'pRegion%turb%vort')
    END IF ! global%error
  ENDIF

  IF (nvars > 2) THEN
    ALLOCATE(pregion%turb%lens(pgrid%nCellsTot),stat=errorflag)
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop(global,err_allocate,__line__,'pRegion%turb%lens')
    END IF ! global%error

    npostv = npostv + 1
  ENDIF

! ==============================================================================
! Post quantities
! ==============================================================================

  pregion%turbInput%nPostv = npostv

  ALLOCATE(pregion%turb%postv(npostv,pgrid%nCellsTot),stat=errorflag)
  global%error = errorflag
  IF (global%error /= err_none) THEN
    CALL errorstop(global,err_allocate,__line__,'pRegion%turb%postv')
  END IF ! global%error

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

  CALL deregisterfunction(global)

END SUBROUTINE turb_rflu_allocmempost



! ******************************************************************************
!
! Purpose: Deallocate memory of turbulence post quantities.
!
! Description: None.
!
! Input:
!   pRegion        Region pointer
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

SUBROUTINE turb_rflu_deallocmempost(pRegion)

  IMPLICIT NONE

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

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

  TYPE(t_region), POINTER :: pregion

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

  CHARACTER(CHRLEN) :: rcsidentstring
  INTEGER :: nvars, errorflag
  TYPE(t_global), POINTER :: global

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

  global => pregion%global

  CALL registerfunction(global,'TURB_RFLU_DeallocMemPost',&
  'TURB_ModPostFlu.F90')

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

  nvars  =  pregion%turbInput%nOutField

! ******************************************************************************
! Deallocate memory
! ******************************************************************************

! ==============================================================================
! Turbulence variables
! ==============================================================================

  IF (nvars > 1) THEN
    DEALLOCATE(pregion%turb%vort,stat=errorflag)
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop(global,err_deallocate,__line__,'pRegion%turb%vort')
    END IF ! global%error
  ENDIF

  IF (nvars > 2) THEN
    DEALLOCATE(pregion%turb%lens,stat=errorflag)
    global%error = errorflag
    IF (global%error /= err_none) THEN
      CALL errorstop(global,err_deallocate,__line__,'pRegion%turb%lens')
    END IF ! global%error
  ENDIF

! ==============================================================================
! Post quantities
! ==============================================================================

  DEALLOCATE(pregion%turb%postv,stat=errorflag)
  global%error = errorflag
  IF (global%error /= err_none) THEN
    CALL errorstop(global,err_deallocate,__line__,'pRegion%turb%postv')
  END IF ! global%error

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

  CALL deregisterfunction(global)

END SUBROUTINE turb_rflu_deallocmempost



! ******************************************************************************
!
! Purpose: Allocate memory to store interpolated post quantities at vertices.
!
! Description: None.
!
! Input:
!   pRegion        Region pointer
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

SUBROUTINE turb_rflu_allocmempostvert(pRegion)

  IMPLICIT NONE

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

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

  TYPE(t_region), POINTER :: pregion

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

  CHARACTER(CHRLEN) :: rcsidentstring
  INTEGER :: npostv, errorflag
  TYPE(t_grid), POINTER :: pgrid
  TYPE(t_global), POINTER :: global

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

  global => pregion%global

  CALL registerfunction(global,'TURB_RFLU_AllocMemPostVert',&
  'TURB_ModPostFlu.F90')

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

  npostv =  pregion%turbInput%nPostv
  pgrid  => pregion%grid

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

! ==============================================================================
! Post quantities
! ==============================================================================

  ALLOCATE(pregion%turb%postvVert(npostv,pgrid%nVertTot),stat=errorflag)
  global%error = errorflag
  IF (global%error /= err_none) THEN
    CALL errorstop(global,err_allocate,__line__,'pRegion%turb%postvVert')
  END IF ! global%error

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

  CALL deregisterfunction(global)

END SUBROUTINE turb_rflu_allocmempostvert



! ******************************************************************************
!
! Purpose: Deallocate memory of post quantities at vertices.
!
! Description: None.
!
! Input:
!   pRegion        Region pointer
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

SUBROUTINE turb_rflu_deallocmempostvert(pRegion)

  IMPLICIT NONE

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

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

  TYPE(t_region), POINTER :: pregion

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

  CHARACTER(CHRLEN) :: rcsidentstring
  INTEGER :: errorflag
  TYPE(t_global), POINTER :: global

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

  global => pregion%global

  CALL registerfunction(global,'TURB_RFLU_DeallocMemPostVert',&
  'TURB_ModPostFlu.F90')

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

! ******************************************************************************
! Deallocate memory
! ******************************************************************************

! ==============================================================================
! Post quantities
! ==============================================================================

  DEALLOCATE(pregion%turb%postvVert,stat=errorflag)
  global%error = errorflag
  IF (global%error /= err_none) THEN
    CALL errorstop(global,err_deallocate,__line__,'pRegion%turb%postvVert')
  END IF ! global%error

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

  CALL deregisterfunction(global)

END SUBROUTINE turb_rflu_deallocmempostvert


! ******************************************************************************
! End
! ******************************************************************************
      
END MODULE turb_modpostflu

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: TURB_ModPostFlu.F90,v $
! Revision 1.3  2008/12/06 08:44:42  mtcampbe
! Updated license.
!
! Revision 1.2  2008/11/19 22:17:54  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.1  2006/01/12 09:51:15  wasistho
! initial import
!
!
!
! ******************************************************************************