TURB_RFLU_ModGenxAdmin.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: Collection of routines related to GENX interaction.
!
! Description: None
!
! Notes: None.
!
! ******************************************************************************
!
! $Id: TURB_RFLU_ModRocstarAdmin.F90,v 1.7 2008/12/06 08:44:01 mtcampbe Exp $
!
! Copyright: (c) 2004-2005 by the University of Illinois
!
! ******************************************************************************

MODULE turb_rflu_modrocstaradmin

  USE moddatatypes
  USE modparameters
  USE moderror
  USE modglobal, ONLY: t_global
  USE modbndpatch, ONLY: t_patch
  USE moddatastruct, ONLY: t_region
  USE modgrid, ONLY: t_grid 
  USE modmpi 

  USE rflu_modrocstarutils

  IMPLICIT NONE

  include 'roccomf90.h'

  PRIVATE

  PUBLIC :: turb_rflu_genxcreateattr, &
            turb_rflu_genxregisterdata, &
            turb_rflu_genxgetdata

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

! ==============================================================================  
! Private
! ==============================================================================  

  CHARACTER(CHRLEN) :: & 
    RCSIdentString = '$RCSfile: TURB_RFLU_ModRocstarAdmin.F90,v $ $Revision: 1.7 $'       
  
! ==============================================================================  
! Public
! ==============================================================================  
  

! ******************************************************************************
! Contained routines
! ******************************************************************************

  CONTAINS 
  
  
  
! ******************************************************************************
!
! Purpose: Create new attributes for turbulence solution.
!
! Description: None.
!
! Input:
!   pRegion             Pointer to region
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE turb_rflu_genxcreateattr(pRegion)
  
    IMPLICIT NONE

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

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

    TYPE(t_region), POINTER :: pregion

! ==============================================================================  
!   Locals 
! ==============================================================================  
    
    CHARACTER(CHRLEN) :: winv
    TYPE(t_global), POINTER :: global
    
! ******************************************************************************
!   Start, set pointers
! ******************************************************************************
    
    global => pregion%global
  
! ******************************************************************************
!   End
! ******************************************************************************
  
  END SUBROUTINE turb_rflu_genxcreateattr
  
  
  
  
  


! ******************************************************************************
!
! Purpose: Register turbulence data.
!
! Description: None.
!
! Input:
!   pRegion             Pointer to region
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE turb_rflu_genxregisterdata(pRegion)

    USE turb_modparameters

    IMPLICIT NONE

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

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

    TYPE(t_region), POINTER :: pregion

! ==============================================================================  
!   Locals 
! ==============================================================================  
    
    CHARACTER(CHRLEN) :: winv
    INTEGER :: paneid, ilb, ndim, ntv, errorflag
    REAL(RFREAL), POINTER :: preal
    TYPE(t_grid), POINTER :: pgrid
    TYPE(t_global), POINTER :: global
    
! ******************************************************************************
!   Start, set pointers
! ******************************************************************************
    
    global => pregion%global

    pgrid  => pregion%grid

    IF ( global%myProcid == masterproc .AND. &
         global%verbLevel >= verbose_high ) THEN 
      WRITE(stdout,'(A,1X,A)') solver_name,'Registering turbulence data...'
    END IF ! global%verbLevel
    
! ******************************************************************************
!   Create new attributes
! ******************************************************************************

! ==============================================================================  
!   Volume
! ==============================================================================  

    winv = global%volWinName

! ------------------------------------------------------------------------------
!   Global
! ------------------------------------------------------------------------------
    CALL com_new_attribute(trim(winv)//'.esg1Sum','w',com_double,1,'J/(m^3s)')
    CALL com_new_attribute(trim(winv)//'.esg4Sum','w',com_double,1,'J/(m^3s)')
    CALL com_set_array( trim(winv)//'.esg1Sum' ,0, global%esg1Sum )
    CALL com_set_array( trim(winv)//'.esg4Sum' ,0, global%esg4Sum )

! ------------------------------------------------------------------------------
!   Model and instantaneous variables
! ------------------------------------------------------------------------------

    CALL com_new_attribute( trim(winv)//'.lens','e',com_double,1,'m' )
    CALL com_new_attribute( trim(winv)//'.mut' ,'e',com_double,1,'kg/(ms)' )
    CALL com_new_attribute( trim(winv)//'.vort','e',com_double,3,'1/s' )

    
! ******************************************************************************
!   Register data
! ******************************************************************************

! ==============================================================================  
!   Volume
! ==============================================================================  

    winv = global%volWinName       

    CALL rflu_genx_buildpaneid(pregion%iRegionGlobal,0,paneid) 

    IF ( global%myProcid == masterproc .AND. &
         global%verbLevel >= verbose_high) THEN 
      WRITE(stdout,'(A,3X,A,1X,A)') solver_name,'Window name:',trim(winv)
      WRITE(stdout,'(A,3X,A,1X,I5.5)') solver_name,'Pane id:', paneid           
    END IF ! global%verbLevel
   
! ------------------------------------------------------------------------------
!   Initialisation
! ------------------------------------------------------------------------------   
    IF (pregion%turbInput%modelClass /= model_rans) THEN
      ALLOCATE( pregion%turb%lens(pgrid%nCellsTot),stat=errorflag )
      global%error = errorflag
      IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )
    ENDIF
    IF (pregion%mixtInput%turbModel == turb_model_none) THEN
      ALLOCATE( pregion%turb%vort(3,pgrid%nCellsTot),stat=errorflag )
      global%error = errorflag
      IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )
    ENDIF

    pregion%mixt%tv   = 0._rfreal
    pregion%turb%lens = 0._rfreal
    pregion%turb%vort = 0._rfreal

! ------------------------------------------------------------------------------
!   Model and instantaneous variables
! ------------------------------------------------------------------------------
    ilb  = 1
    ndim = pgrid%nCellsTot
    ntv  = pregion%mixtInput%nTv 

    preal => pregion%turb%lens(1)
    CALL com_set_array( trim(winv)//'.lens' ,paneid, preal )

    preal => pregion%mixt%tv(tv_mixt_muet,ilb)
    CALL com_set_array( trim(winv)//'.mut',paneid, preal,ntv )

    preal => pregion%turb%vort(1,ilb)
    CALL com_set_array( trim(winv)//'.vort',paneid,preal )
   
! ******************************************************************************
!   End
! ******************************************************************************

    IF ( global%myProcid == masterproc .AND. &
         global%verbLevel >= verbose_high ) THEN 
      WRITE(stdout,'(A,1X,A)') solver_name,'Registering turbulence data done.'
    END IF ! global%verbLevel 
  
  END SUBROUTINE turb_rflu_genxregisterdata








! ******************************************************************************
!
! Purpose: Get turbulence data through Roccom.
!
! Description: None.
!
! Input:
!   pRegion             Pointer to region
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************

  SUBROUTINE turb_rflu_genxgetdata(pRegion)
  
    IMPLICIT NONE

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

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

    TYPE(t_region), POINTER :: pregion

! ==============================================================================  
!   Loop
! ==============================================================================  
    INTEGER :: istat

! ==============================================================================  
!   Locals 
! ==============================================================================  
    
    CHARACTER(CHRLEN) :: winname,winnamein
    CHARACTER(CHRLEN), POINTER :: statnm(:,:,:)
    INTEGER :: handlein,handleobtain,handleout
    TYPE(t_global), POINTER :: global
    TYPE(t_grid), POINTER :: pgrid
    
! ******************************************************************************
!   Start, set pointers and variables
! ******************************************************************************
    
    global => pregion%global

    winnamein = global%volWinNameInput
    winname   = global%volWinName  
    
! ******************************************************************************
!   First check if it is new or restart turbulence. If new, skip this routine.
! ******************************************************************************

    handlein = com_get_attribute_handle_const(trim(winnamein)//'.mut')
    IF (handlein <= 0) THEN
      IF ( global%myProcid == masterproc .AND. &
           global%verbLevel >= verbose_high ) THEN 
        WRITE(stdout,'(A,1X,A)') solver_name,'Starting new turbulence...'
      END IF ! global%verbLevel
      goto 999
    ENDIF

! ******************************************************************************
!   Get data
! ******************************************************************************

    handleobtain = global%handleObtain

    IF ( global%myProcid == masterproc .AND. &
         global%verbLevel >= verbose_high ) THEN 
      WRITE(stdout,'(A,1X,A)') solver_name,'Getting turbulence data...'
    END IF ! global%verbLevel 
        
    IF ( global%myProcid == masterproc .AND. & 
         global%verbLevel >= verbose_high) THEN 
      WRITE(stdout,'(A,3X,A,1X,I5.5)') solver_name,'Global region:', & 
                                       pregion%iRegionGlobal
    END IF ! global%myProcid
    
! ==============================================================================
!   Global
! ==============================================================================   
    
    handlein = com_get_attribute_handle_const(trim(winnamein)//'.esg1Sum')
    handleout = com_get_attribute_handle(trim(winname)//'.esg1Sum')
    CALL com_call_function(handleobtain,2,handlein,handleout)
    
    handlein = com_get_attribute_handle_const(trim(winnamein)//'.esg4Sum')
    handleout = com_get_attribute_handle(trim(winname)//'.esg4Sum')
    CALL com_call_function(handleobtain,2,handlein,handleout)
    
! ==============================================================================
!   Turbulence variables
! ==============================================================================   
    
    handlein = com_get_attribute_handle_const(trim(winnamein)//'.lens')
    handleout = com_get_attribute_handle(trim(winname)//'.lens')
    CALL com_call_function(handleobtain,2,handlein,handleout)

    handlein = com_get_attribute_handle_const(trim(winnamein)//'.mut')
    handleout = com_get_attribute_handle(trim(winname)//'.mut')
    CALL com_call_function(handleobtain,2,handlein,handleout)

    handlein  = com_get_attribute_handle_const(trim(winnamein)//'.vort')    
    handleout = com_get_attribute_handle(trim(winname)//'.vort')
    CALL com_call_function(handleobtain,2,handlein,handleout)


! ******************************************************************************
!   End
! ******************************************************************************
 
    IF ( global%myProcid == masterproc .AND. &
         global%verbLevel >= verbose_high ) THEN 
      WRITE(stdout,'(A,1X,A)') solver_name,'Getting turbulence data done.'
    END IF ! global%verbLevel

999 CONTINUE
  
  END SUBROUTINE turb_rflu_genxgetdata







! ******************************************************************************
! End Module
! ******************************************************************************




END MODULE turb_rflu_modrocstaradmin

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: TURB_RFLU_ModRocstarAdmin.F90,v $
! Revision 1.7  2008/12/06 08:44:01  mtcampbe
! Updated license.
!
! Revision 1.6  2008/11/19 22:17:15  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.5  2006/02/11 06:45:06  wasistho
! identify new or restart turbulence in genxGetData
!
! Revision 1.4  2006/01/10 05:00:05  wasistho
! added GenxGetData
!
! Revision 1.3  2006/01/04 20:06:02  wasistho
! modified data registration
!
! Revision 1.2  2006/01/03 09:51:35  wasistho
! get rid of ifdef rflu
!
! Revision 1.1  2006/01/03 06:34:41  wasistho
! initial import
!
!
! ******************************************************************************