TURB_InitGenxInterface.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: register turbulence variables with GenX.
!
! Description: none.
!
! Input: regions = patches and region (volume) variables
!
! Output: to Roccom via RFLO_initGenxInterface.
!
! Notes: none.
!
!******************************************************************************
!
! $Id: TURB_InitGenxInterface.F90,v 1.7 2008/12/06 08:44:01 mtcampbe Exp $
!
! Copyright: (c) 2002 by the University of Illinois
!
!******************************************************************************

SUBROUTINE turb_initgenxinterface( regions,wins,winv )

  USE moddatatypes
  USE modglobal, ONLY     : t_global
#ifdef RFLO
  USE moddatastruct, ONLY : t_region
  USE modinterfaces, ONLY : rflo_getdimensdummy, rflo_getcelloffset
#include "Indexing.h"
#endif
  USE moderror
  USE modparameters
  USE turb_modparameters
  IMPLICIT NONE
  include 'roccomf90.h'

! ... parameters
  CHARACTER(CHRLEN) :: wins, winv
  TYPE(t_region), POINTER :: regions(:)

! ... loop variables
  INTEGER :: ireg

! ... local variables
#ifdef STATS
  CHARACTER(CHRLEN), POINTER :: statnm(:,:,:)
  INTEGER :: istat
#endif
  INTEGER :: ilev, ibc, iec, pid, errorflag, ilb
  INTEGER :: icoff, ijcoff, idcbeg, idcend, jdcbeg, jdcend, kdcbeg, kdcend

  TYPE(t_global), POINTER :: global

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

  global => regions(1)%global

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

! input data (currently none) -------------------------------------------------

! output global data

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

! output surface data (currently none)
 
! output volume (for visualization) and restart data 

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

! statistics

#ifdef STATS
  IF ((global%flowType == flow_unsteady) .AND. (global%doStat == active)) THEN
    IF (global%turbNStat > 0) THEN
      statnm => global%turbStatNm
      DO istat=1,global%turbNStat

        CALL com_new_attribute( trim(winv)//'.'//trim(statnm(1,1,istat)),'e', &
                                com_double,1,trim(statnm(1,2,istat)) )
      ENDDO
    ENDIF
  ENDIF
#endif

! store pointers to variables, loop over all regions --------------------------

! global data

  CALL com_set_array( trim(winv)//'.esg1Sum' ,0, global%esg1Sum )
  CALL com_set_array( trim(winv)//'.esg4Sum' ,0, global%esg4Sum )

  DO ireg=1,global%nRegions
    IF (regions(ireg)%procid==global%myProcid .AND. &   ! region active and
        regions(ireg)%active==active) THEN              ! on my processor

      ilev = regions(ireg)%currLevel

! --- volume data

      pid = ireg*regoff
      
      CALL rflo_getdimensdummy( regions(ireg),ilev,idcbeg,idcend, &
                                jdcbeg,jdcend,kdcbeg,kdcend )
      CALL rflo_getcelloffset( regions(ireg),ilev,icoff,ijcoff )
      ibc = indijk(idcbeg,jdcbeg,kdcbeg,icoff,ijcoff)
      iec = indijk(idcend,jdcend,kdcend,icoff,ijcoff)

      IF (regions(ireg)%turbInput%modelClass /= model_rans) THEN
        ALLOCATE( regions(ireg)%levels(ilev)%turb%lens(ibc:iec), &
                  stat=errorflag )
        global%error = errorflag
        IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )
      ENDIF
      IF (regions(ireg)%mixtInput%turbModel == turb_model_none) THEN
        ALLOCATE( regions(ireg)%levels(ilev)%turb%vort(3,ibc:iec), &
                  stat=errorflag )
        global%error = errorflag
        IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )
      ENDIF

      regions(ireg)%levels(ilev)%mixt%tv   = 0._rfreal
      regions(ireg)%levels(ilev)%turb%lens = 0._rfreal
      regions(ireg)%levels(ilev)%turb%vort = 0._rfreal

      ilb = lbound(regions(ireg)%levels(ilev)%mixt%tv,2)

      CALL com_set_array( trim(winv)//'.lens' ,pid, &
           regions(ireg)%levels(ilev)%turb%lens )

      CALL com_set_array( trim(winv)//'.mut',pid, &
           regions(ireg)%levels(ilev)%mixt%tv(3,ilb),4)

      CALL com_set_array( trim(winv)//'.vort',pid, &
           regions(ireg)%levels(ilev)%turb%vort(1,ilb))

! --- statistics

#ifdef STATS
      IF ((global%flowType==flow_unsteady) .AND. (global%doStat==active)) THEN
        IF (global%turbNStat > 0) THEN
          DO istat=1,global%turbNStat
            CALL com_set_array( trim(winv)//'.'//trim(statnm(1,1,istat)), pid, &
              regions(ireg)%levels(ilev)%turb%tav(istat,ilb), global%turbNStat)
          ENDDO
        ENDIF
      ENDIF
#endif

    ENDIF      ! region on this processor and active
  ENDDO        ! iReg

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

  CALL deregisterfunction( global )

END SUBROUTINE turb_initgenxinterface

!******************************************************************************
!
! RCS Revision history:
!
! $Log: TURB_InitGenxInterface.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  2005/12/07 20:03:43  wasistho
! removed attemp to store actual tav i.o. accumulated
!
! Revision 1.4  2005/12/07 04:44:06  wasistho
! modified statistics treatment
!
! Revision 1.3  2005/12/07 02:23:50  wasistho
! added integrTime with eps
!
! Revision 1.2  2005/12/06 21:53:05  wasistho
! devided and multiply tav with integrTime
!
! Revision 1.1  2004/12/01 21:24:00  haselbac
! Initial revision after changing case
!
! Revision 1.13  2004/06/30 04:06:22  wasistho
! moved Genx related parameter REGOFF to ModParameters
!
! Revision 1.12  2004/06/29 23:53:08  wasistho
! migrated to Roccom-3
!
! Revision 1.11  2004/06/07 23:05:36  wasistho
! provide Genx statistics names, units, and anytime-activation
!
! Revision 1.10  2004/05/12 20:05:36  wasistho
! added USE TURB_ModParameters
!
! Revision 1.9  2004/05/04 20:39:41  wasistho
! added RaNS/DES length scale variables: lens
!
! Revision 1.8  2004/03/02 00:07:51  wasistho
! added global variables esg1Sum and esg4Sum for turb.(exact) restart
!
! Revision 1.7  2003/11/20 16:40:34  mdbrandy
! Backing out RocfluidMP changes from 11-17-03
!
! Revision 1.4  2003/09/16 01:00:23  wasistho
! composed vorticities to a 3-components vector
!
! Revision 1.3  2003/09/10 21:11:37  jblazek
! Setting variables to zero.
!
! Revision 1.2  2003/08/14 20:06:58  jblazek
! Corrected bug associated with radiation flux qr.
!
! Revision 1.1  2003/08/09 02:09:26  wasistho
! added TURB and RADI_initGenxInterface
!
!******************************************************************************