TURB_StatMapping.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: mapping from TURB ID to statistics ID
!
! Description: mapping based on parameter turbStatId(:,:) input by user
!
! Input: global%turbStatId : TURB statistics ID from user input
!
! Output: global%turbStatCode : mapped TURB statistics ID
!
! Notes: none.
!
!******************************************************************************
!
! $Id: TURB_StatMapping.F90,v 1.5 2008/12/06 08:44:42 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************

SUBROUTINE turb_statmapping( global ) ! PUBLIC

  USE moddatatypes
  USE modglobal, ONLY : t_global
#ifdef GENX
  USE modinterfacesstatistics, ONLY : genxstatnaming
#endif
  USE moderror
  USE modparameters
  USE turb_modparameters
  IMPLICIT NONE

! ... parameters
  TYPE(t_global), POINTER :: global

! ... loop variables
  INTEGER  :: l, n

! ... local variables
  CHARACTER(CHRLEN) :: rcsidentstring
#ifdef GENX
  CHARACTER(CHRLEN), POINTER :: statname(:,:,:)
#endif
  INTEGER :: errorflag
  INTEGER, POINTER  :: statid(:,:), statcode(:,:,:)

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

  rcsidentstring = '$RCSfile: TURB_StatMapping.F90,v $'

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

! allocate TURB variables and set pointers ---------------------------------

  ALLOCATE( global%turbStatCode(2,2,global%turbNStat),stat=errorflag )
  global%error = errorflag
  IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )

  statid   => global%turbStatId
  statcode => global%turbStatCode

#ifdef GENX
  ALLOCATE( global%turbStatNm(2,2,global%turbNStat),stat=errorflag )
  global%error = errorflag
  IF (global%error /= 0) CALL errorstop( global,err_allocate,__line__ )

  statname => global%turbStatNm
#endif

! set TURB mapping ---------------------------------------------------------

  DO l=1,global%turbNStat
    DO n=1,2
      IF (statid(n,l)==0) THEN 
        statcode(n,:,l) = stat_none
      ELSE IF (statid(n,l)==1) THEN 
        statcode(n,1,l) = stat_tv
        statcode(n,2,l) = tv_mixt_muet
#ifdef GENX
        statname(n,1,l) = 'mut'
        statname(n,2,l) = 'kg/ms'
#endif
      ELSE IF (statid(n,l)==2) THEN 
        statcode(n,1,l) = stat_tv
        statcode(n,2,l) = tv_mixt_tcot
#ifdef GENX
        statname(n,1,l) = 'tcot'
        statname(n,2,l) = 'kg m/Ks^3'
#endif
      ELSE IF (statid(n,l)==3) THEN 
        statcode(n,1,l) = stat_dv
        statcode(n,2,l) = dv_turb_cdyn
#ifdef GENX
        statname(n,1,l) = 'Cd'
        statname(n,2,l) = ' '
#endif
      ELSE IF (statid(n,l)==4) THEN 
        statcode(n,1,l) = stat_st
        statcode(n,2,l) = st_turb_var1
#ifdef GENX
        statname(n,1,l) = 'alpha_1'
        statname(n,2,l) = 'Nm/s'
#endif
      ELSE IF (statid(n,l)==5) THEN 
        statcode(n,1,l) = stat_st
        statcode(n,2,l) = st_turb_var2
#ifdef GENX
        statname(n,1,l) = 'alpha_2+3'
        statname(n,2,l) = 'Nm/s'
#endif
      ELSE IF (statid(n,l)==6) THEN 
        statcode(n,1,l) = stat_st
        statcode(n,2,l) = st_turb_var3
#ifdef GENX
        statname(n,1,l) = 'alpha_4'
        statname(n,2,l) = 'Nm/s'
#endif
!      ELSE IF (statId(n,l)==4) THEN 
!        statCode(n,1,l) = STAT_SV
!        statCode(n,2,l) = E11
!#ifdef GENX
!        statName(n,1,l) = 'tau11'
!        statName(n,2,l) = 'N/m^2'
!#endif
!      ELSE IF (statId(n,l)==5) THEN 
!        statCode(n,1,l) = STAT_SV
!        statCode(n,2,l) = E22
!#ifdef GENX
!        statName(n,1,l) = 'tau22'
!        statName(n,2,l) = 'N/m^2'
!#endif
!      ELSE IF (statId(n,l)==6) THEN 
!        statCode(n,1,l) = STAT_SV
!        statCode(n,2,l) = E33
!#ifdef GENX
!        statName(n,1,l) = 'tau33'
!        statName(n,2,l) = 'N/m^2'
!#endif
      ELSE IF (statid(n,l)==7) THEN 
        statcode(n,1,l) = stat_sv
        statcode(n,2,l) = e12
#ifdef GENX
        statname(n,1,l) = 'tau12'
        statname(n,2,l) = 'N/m^2'
#endif
      ELSE IF (statid(n,l)==8) THEN 
        statcode(n,1,l) = stat_st
        statcode(n,2,l) = st_turb_var4
#ifdef GENX
        statname(n,1,l) = 'MMij'
        statname(n,2,l) = 'N^2/m^4'
#endif
      ELSE IF (statid(n,l)==9) THEN 
        statcode(n,1,l) = stat_st
        statcode(n,2,l) = st_turb_var5
#ifdef GENX
        statname(n,1,l) = 'MLij'
        statname(n,2,l) = 'N^2/m^4'
#endif
      ELSE
        CALL errorstop( global,err_stats_indexing,__line__, &
                        'TURB index is not defined.' ) 
      ENDIF
    ENDDO
  ENDDO

#ifdef GENX
! defined names and units of turbulence statistics

  CALL genxstatnaming( global, ftype_turb )
#endif

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

  CALL deregisterfunction( global )

END SUBROUTINE turb_statmapping

!******************************************************************************
!
! RCS Revision history:
!
! $Log: TURB_StatMapping.F90,v $
! Revision 1.5  2008/12/06 08:44:42  mtcampbe
! Updated license.
!
! Revision 1.4  2008/11/19 22:17:54  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.3  2004/10/22 23:33:29  wasistho
! added new turb.statistics ID, alpha1 to alpha4
!
! Revision 1.2  2004/06/07 23:10:21  wasistho
! provide Genx statistics names, units, and anytime-activation
!
! Revision 1.1  2004/03/05 04:37:00  wasistho
! changed nomenclature
!
! Revision 1.3  2003/10/09 23:49:07  wasistho
! added flag ! PUBLIC
!
! Revision 1.2  2003/05/24 02:07:49  wasistho
! turbulence statistics expanded
!
! Revision 1.1  2002/11/02 02:06:29  wasistho
! Added TURB statistics
!
!
!******************************************************************************