TURB_PrintUserInput.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: Write out TURB user input for checking purposes.
!
! Description: none.
!
! Input: region = user input in current region.
!
! Output: to standard output (monitor).
!
! Notes: none.
!
!******************************************************************************
!
! $Id: TURB_PrintUserInput.F90,v 1.9 2008/12/06 08:44:42 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************

SUBROUTINE turb_printuserinput( region ) ! PUBLIC

  USE moddatatypes
  USE moddatastruct, ONLY : t_region
  USE modglobal, ONLY     : t_global
  USE moderror
  USE modparameters
  USE turb_modparameters
  IMPLICIT NONE

! ... parameters
  TYPE(t_region) :: region

! ... loop variables

! ... local variables
  CHARACTER(CHRLEN)       :: rcsidentstring
  TYPE(t_global), POINTER :: global

  INTEGER       :: turbmodel, modelclass
  INTEGER       :: calcvort

! ... WLM variables
  INTEGER       :: wallmodel, wlmrefpoint
  REAL(RFREAL)  :: wallrough

! ... LES variables
  INTEGER       :: engmodel, filterwidth(diri:dirk)
  REAL(RFREAL)  :: csmag, xyzsmag(xcoord:zcoord)
#ifdef RFLO
  INTEGER       :: filtertype, deltatype, homdir(diri:dirk)
#endif

! ... RaNS/DES variables
  INTEGER       :: wdistmeth, functv1, discrtype, discrorder
  REAL(RFREAL)  :: cb1, cb2, cw2, cw3, cv1, rsigma, rkappa, cw1, cdes
  REAL(RFREAL)  :: smoocf, k2, ook4

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

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

  global => region%global
  CALL registerfunction( global,'TURB_PrintUserInput',&
  'TURB_PrintUserInput.F90' )

! get pointers ---------------------------------------------------------------

  turbmodel      = region%mixtInput%turbModel
  calcvort       = region%turbInput%calcVort

! WLM
  wallmodel      = region%turbInput%wallModel
  wlmrefpoint    = region%turbInput%wlmRefPoint
  wallrough      = region%turbInput%wallRough

! LES
  csmag          = region%turbInput%cSmag
  xyzsmag(:)     = region%turbInput%xyzSmag(:)
  modelclass     = region%turbInput%modelClass
  filterwidth(:) = region%turbInput%filterWidth(:)
  engmodel       = region%turbInput%engModel
#ifdef RFLO
  filtertype     = region%turbInput%filterType
  deltatype      = region%turbInput%deltaType
  homdir(:)      = region%turbInput%homDir(:)
#endif

! RaNS/DES
  IF ((turbmodel==turb_model_sa).OR.(turbmodel==turb_model_dessa).OR. &
      (turbmodel==turb_model_hdessa)) THEN
    cb1          = region%turbInput%const(mc_sa_cb1)
    cb2          = region%turbInput%const(mc_sa_cb2)
    cw2          = region%turbInput%const(mc_sa_cw2)
    cw3          = region%turbInput%const(mc_sa_cw3)
    cv1          = region%turbInput%const(mc_sa_cv1)
    rsigma       = region%turbInput%const(mc_sa_rsig)
    rkappa       = region%turbInput%const(mc_sa_rkap)
    cw1          = region%turbInput%const(mc_sa_cw1)
    cdes         = region%turbInput%cdes
  ENDIF
  wdistmeth      = region%turbInput%wDistMethod
  functv1        = region%turbInput%functV1
  smoocf         = region%turbInput%smoocf
  discrtype      = region%turbInput%spaceDiscr
  k2             = region%turbInput%vis2
  ook4           = 1._rfreal/region%turbInput%vis4
  discrorder     = region%turbInput%spaceOrder

! turbulence model selection

  IF (turbmodel==turb_model_fixsmag) THEN
    WRITE(stdout,1005) solver_name//'     turbulence model = basic Smagorinsky'
  ELSEIF (turbmodel==turb_model_scalsim) THEN
    WRITE(stdout,1005) solver_name//'     turbulence model = scale similarity'
  ELSEIF (turbmodel==turb_model_dynsmag) THEN
    WRITE(stdout,1005) solver_name//'     turbulence model = dynamic Smagorinsky'
  ELSEIF (turbmodel==turb_model_dynmixd) THEN
    WRITE(stdout,1005) solver_name//'     turbulence model = dynamic mixed'
  ELSEIF (turbmodel==turb_model_sa) THEN
    WRITE(stdout,1005) solver_name//'     turbulence model = Spalart-Allmaras'
  ELSEIF (turbmodel==turb_model_dessa) THEN
    WRITE(stdout,1005) solver_name//'     turbulence model = DES-SA'
  ELSEIF (turbmodel==turb_model_hdessa) THEN
    WRITE(stdout,1005) solver_name//'     turbulence model = Hybrid DES-SA'
  ENDIF
  WRITE(stdout,1030) solver_name//'     relevant input-data based on above model:'

! model parameters selection

  IF (modelclass==model_les) THEN

! - LES part 

    WRITE(stdout,1030) solver_name//'     class of model   = LES'
    IF (engmodel==active) THEN
      WRITE(stdout,1030) solver_name//'     energy SGS model = active'
    ELSE
      WRITE(stdout,1030) solver_name//'     energy SGS model = off'
    ENDIF

    IF (turbmodel==turb_model_fixsmag) THEN
      WRITE(stdout,1020) solver_name//'     C-Smagorinsky    =',csmag
    ENDIF
    IF (turbmodel==turb_model_fixsmag .OR. &
        turbmodel==turb_model_dynsmag .OR. &
        turbmodel==turb_model_dynmixd) THEN
      IF (xyzsmag(xcoord) > -huge(1._rfreal )/1000._rfreal) THEN
        WRITE(stdout,1020) solver_name//'     x-tripping       =',xyzsmag(xcoord)
      ENDIF
      IF (xyzsmag(ycoord) > -huge(1._rfreal )/1000._rfreal) THEN
        WRITE(stdout,1020) solver_name//'     y-tripping       =',xyzsmag(ycoord)
      ENDIF
      IF (xyzsmag(zcoord) > -huge(1._rfreal )/1000._rfreal) THEN
        WRITE(stdout,1020) solver_name//'     z-tripping       =',xyzsmag(zcoord)
      ENDIF
    ENDIF
    IF (turbmodel/=turb_model_fixsmag) THEN
#ifdef RFLO
      IF (filtertype==filtype_uniform) THEN
        WRITE(stdout,1030) solver_name//'     filter type      = uniform'
      ELSE
        WRITE(stdout,1030) solver_name//'     filter type      = non-uniform'
      ENDIF
      IF (deltatype==deltype_cbrt) THEN
        WRITE(stdout,1030) solver_name//'     delta type       = cuberoot formula'
      ELSE
        WRITE(stdout,1030) solver_name//'     delta type       = sqrroot formula'
      ENDIF

      WRITE(stdout,1010) solver_name//'     ijk-filter width =', &
      filterwidth(diri), filterwidth(dirj), &
      filterwidth(dirk),' grid-spacing'

      WRITE(stdout,1010) solver_name//'     ijk-homogen dir. =', &
      homdir(diri),homdir(dirj),homdir(dirk), &
      ' (1 = homogeneous, 0 = non-homogeneous)'
#endif
#ifdef RFLU
      WRITE(stdout,1008) solver_name//'     filter width     =', &
      filterwidth(diri),' grid-spacing'
#endif
    ENDIF ! turbModel
  ELSE

! - RANS/DES part 

    WRITE(stdout,1030) solver_name//'     class of model   = RANS or DES'
    IF ((turbmodel==turb_model_sa).OR.(turbmodel==turb_model_dessa).OR. &
        (turbmodel==turb_model_hdessa)) THEN
      WRITE(stdout,1020) solver_name//'     model const. cb1 =',cb1
      WRITE(stdout,1020) solver_name//'     model const. cb2 =',cb2
      WRITE(stdout,1020) solver_name//'     model const. cw2 =',cw2
      WRITE(stdout,1020) solver_name//'     model const. cw3 =',cw3
      WRITE(stdout,1020) solver_name//'     model const. cv1 =',cv1
      WRITE(stdout,1020) solver_name//'     model const. SIG =',1._rfreal/rsigma
      WRITE(stdout,1020) solver_name//'     model const. KAP =',1._rfreal/rkappa
      WRITE(stdout,1020) solver_name//'     model const. cw1 =',cw1
      IF (turbmodel==turb_model_dessa .OR. turbmodel==turb_model_hdessa) &
      WRITE(stdout,1020) solver_name//'     DES spacing coef =',cdes
      IF (wdistmeth == wdist_direct) &
      WRITE(stdout,1030) solver_name//'     wall dist.method = direct'
      IF (wdistmeth == wdist_hierar) &
      WRITE(stdout,1030) solver_name//'     wall dist.method = hierarchical'
      IF (functv1 == sa_fv1_pow3) &
      WRITE(stdout,1030) solver_name//'     visc. funct. fv1 = power 3 formula'
      IF (functv1 == sa_fv1_pow2) &
      WRITE(stdout,1030) solver_name//'     visc. funct. fv1 = power 2 formula'
    ENDIF
    WRITE(stdout,1030) solver_name//'     RANS/DES Numeric :'
    WRITE(stdout,1020) solver_name//'     RANS smoocf      =',smoocf
    IF (discrtype == rans_discr_cen) THEN
      IF (discrorder == rans_discr_ord1) &
      WRITE(stdout,1030) solver_name//'     RANS spc discr.  = 1st order central'
      IF (discrorder == rans_discr_ord2) &
      WRITE(stdout,1030) solver_name//'     RANS spc discr.  = 2nd order central'
      WRITE(stdout,1020) solver_name//'     RANS k2          =',k2
      WRITE(stdout,1020) solver_name//'     RANS 1/k4        =',ook4
    ELSEIF (discrtype == rans_discr_upw) THEN
      IF (discrorder == rans_discr_ord1) &
      WRITE(stdout,1030) solver_name//'     RANS spc discr.  = 1st order upwind'
      IF (discrorder == rans_discr_ord2) &
      WRITE(stdout,1030) solver_name//'     RANS spc discr.  = 2nd order upwind'
    ENDIF
  ENDIF

! vorticity components

  IF (calcvort == calcvort_fdt) THEN
    WRITE(stdout,1030) solver_name//'     vorticity sample : per fluid dt'
  ELSEIF (calcvort == calcvort_sdt) THEN
    WRITE(stdout,1030) solver_name//'     vorticity sample : per system dt (Genx)'
  ENDIF

! wall model selection

  IF (wallmodel==wlm_model_loglay) THEN
    WRITE(stdout,1030) solver_name//'     best wall model  = log layer model'
  ELSEIF (wallmodel==wlm_model_bndlay) THEN
    WRITE(stdout,1030) solver_name//'     best wall model  = boundary layer model'
  ELSEIF (wallmodel==wlm_model_extern) THEN
    WRITE(stdout,1030) solver_name//'     best wall model  = prescribed wall stress'
  ENDIF
  IF (wallmodel/=wlm_model_nomodel) THEN
    WRITE(stdout,1020) solver_name//'     max. ref. point  =', wlmrefpoint
    IF (wallrough > real_small) THEN
      WRITE(stdout,1020) solver_name//'     max. roughness   =', wallrough
    ENDIF
  ENDIF

! finish ----------------------------------------------------------------------

  CALL deregisterfunction( global )

1005 FORMAT(/,a)
1008 FORMAT(a,i8,a)
1010 FORMAT(a,3i4,a)
1015 FORMAT(a,3i4)
1020 FORMAT(a,e12.5)
1030 FORMAT(a)

END SUBROUTINE turb_printuserinput

!******************************************************************************
!
! RCS Revision history:
!
! $Log: TURB_PrintUserInput.F90,v $
! Revision 1.9  2008/12/06 08:44:42  mtcampbe
! Updated license.
!
! Revision 1.8  2008/11/19 22:17:54  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.7  2006/01/18 06:38:46  wasistho
! screen printed tripping locations for eddyvis LES
!
! Revision 1.6  2006/01/12 09:50:15  wasistho
! enabled tripping fixed Smagorinsky
!
! Revision 1.5  2005/03/09 06:35:10  wasistho
! incorporated HDESSA
!
! Revision 1.4  2004/04/08 03:18:03  wasistho
! left justification of screen output
!
! Revision 1.3  2004/03/27 02:16:42  wasistho
! compiled with Rocflu
!
! Revision 1.2  2004/03/19 02:47:33  wasistho
! prepared for RFLU
!
! Revision 1.1  2004/03/05 04:37:00  wasistho
! changed nomenclature
!
! Revision 1.12  2004/02/19 04:03:50  wasistho
! added new rans/SA parameter VISCFUNCTION
!
! Revision 1.11  2004/02/14 03:43:15  wasistho
! added new WLM parameter: reference point
!
! Revision 1.10  2003/10/27 23:13:19  wasistho
! bug fixed in the output of cDes
!
! Revision 1.9  2003/10/26 00:56:24  wasistho
! bug fixed
!
! Revision 1.8  2003/10/26 00:08:55  wasistho
! added multiple discr.types and order
!
! Revision 1.7  2003/10/24 03:55:56  wasistho
! screen output RaNS dissipation coef k2
!
! Revision 1.6  2003/10/17 20:24:11  wasistho
! added IF statement for rans model constants
!
! Revision 1.5  2003/10/07 20:34:13  wasistho
! added screen print RaNS/DES numeric
!
! Revision 1.3  2003/08/06 15:57:43  wasistho
! added vorticities computation
!
! Revision 1.2  2003/05/31 01:47:00  wasistho
! installed turb. wall layer model
!
! Revision 1.1  2002/10/14 23:55:30  wasistho
! Install Rocturb
!
!
!******************************************************************************