RADI_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 RADI user input and parameters derived from it for
!          checking purposes.
!
! Description: none.
!
! Input: region = user input in current region.
!
! Output: to standard output (monitor).
!
! Notes: none.
!
!******************************************************************************
!
! $Id: RADI_PrintUserInput.F90,v 1.4 2008/12/06 08:44:37 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************

#ifdef RFLO
SUBROUTINE radi_printuserinput( region )
#endif
#ifdef RFLU
SUBROUTINE radi_printuserinput
#endif

  USE moddatatypes
  USE modglobal, ONLY     : t_global
#ifdef RFLO
  USE moddatastruct, ONLY : t_region
#endif
  USE modradiation
  USE moderror
  USE modparameters
  USE radi_modparameters
  IMPLICIT NONE

! ... parameters
#ifdef RFLO
  TYPE(t_region) :: region
#endif

! ... loop variables
  INTEGER :: n

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

  INTEGER :: radimodel, media, solmethod, npol, nazi, nang
  INTEGER :: fluxlim, discrtype, discrorder
  REAL(RFREAL) :: extcoef, smoocf, k2, ook4
  REAL(RFREAL), POINTER :: angles(:,:), optconst(:,:)

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

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

! input parameters ------------------------------------------------------------

#ifdef RFLO
  radimodel =  region%radiInput%radiModel
  media     =  region%radiInput%media
  fluxlim   =  region%radiInput%fluxLim
  smoocf    =  region%radiInput%smoocf
  discrtype =  region%radiInput%spaceDiscr
  k2        =  region%radiInput%vis2
  ook4      =  1._rfreal/region%radiInput%vis4
  discrorder=  region%radiInput%spaceOrder
  solmethod =  region%radiInput%solMethod
  npol      =  region%radiInput%nPol
  nazi      =  region%radiInput%nAzi
  nang      =  region%radiInput%nAng
  angles    => region%radiInput%angles
  optconst  => region%radiInput%optConst
#endif
#ifdef RFLU
  radimodel =  radiinput%radiModel
  media     =  radiinput%media
  fluxlim   =  radiinput%fluxLim
  smoocf    =  radiinput%smoocf
  discrtype =  radiinput%spaceDiscr
  k2        =  radiinput%vis2
  ook4      =  1._rfreal/radiinput%vis4
  discrorder=  radiinput%spaceOrder
  solmethod =  radiinput%solMethod
  npol      =  radiinput%nPol
  nazi      =  radiinput%nAzi
  nang      =  radiinput%nAng
  angles    => radiinput%angles
  optconst  => radiinput%optConst
#endif

! output selected general parameters to monitor

  WRITE(stdout,1005) solver_name//' Radiation:'

  IF (radimodel == radi_model_ross) THEN
    WRITE(stdout,1030) solver_name//' radiation model = Rosseland Diff. approx.'
  ELSEIF (radimodel == radi_model_fldsrc) THEN
    WRITE(stdout,1030) solver_name//' radiation model = simple Limited Flux Diff.'
  ELSEIF (radimodel == radi_model_fldtran) THEN
    WRITE(stdout,1030) solver_name//' radiation model = full Limited Flux Diff.'
  ELSEIF (radimodel == radi_model_rtegray) THEN
    WRITE(stdout,1030) solver_name//' radiation model = RTE gray gas'
  ELSEIF (radimodel == radi_model_rteband) THEN
    WRITE(stdout,1030) solver_name//' radiation model = RTE non-gray gas'
  ENDIF

  IF (media == radi_media_artif) THEN
    WRITE(stdout,1030) solver_name//' radiative media = artificial multi-phase'
  ELSEIF (media == radi_media_real) THEN
    WRITE(stdout,1030) solver_name//' radiative media = real multi-phase'
  ENDIF

  WRITE(stdout,1030) solver_name//' relevant input-data based on above model:'

! optical constants and extinction coefficients

  IF (media == radi_media_artif) THEN
    IF (optconst(phase_prop_v,radi_phase_gas) > radi_real_small) THEN
      WRITE(stdout,1030) solver_name//' media phase     = gas'
      WRITE(stdout,1010) solver_name//'   vol.fraction  =', &
                         optconst(phase_prop_v,radi_phase_gas)
      WRITE(stdout,1010) solver_name//'   Q-extinction  =', &
                         optconst(phase_prop_q,radi_phase_gas)
      WRITE(stdout,1010) solver_name//'   molecule diam.=', &
                         optconst(phase_prop_d,radi_phase_gas)
    ENDIF
    IF (optconst(phase_prop_v,radi_phase_conpart) > radi_real_small) THEN
      WRITE(stdout,1030) solver_name//' media phase     = continuum particles'
      WRITE(stdout,1010) solver_name//'   vol.fraction  =', &
                         optconst(phase_prop_v,radi_phase_conpart)
      WRITE(stdout,1010) solver_name//'   Q-extinction  =', &
                         optconst(phase_prop_q,radi_phase_conpart)
      WRITE(stdout,1010) solver_name//'   particle diam.=', &
                         optconst(phase_prop_d,radi_phase_conpart)
    ENDIF
    IF (optconst(phase_prop_v,radi_phase_dispart) > radi_real_small) THEN
      WRITE(stdout,1030) solver_name//' media phase     = discrete particles'
      WRITE(stdout,1010) solver_name//'   vol.fraction  =', &
                         optconst(phase_prop_v,radi_phase_dispart)
      WRITE(stdout,1010) solver_name//'   Q-extinction .=', &
                         optconst(phase_prop_q,radi_phase_dispart)
      WRITE(stdout,1010) solver_name//'   particle diam.=', &
                         optconst(phase_prop_d,radi_phase_dispart)
    ENDIF

    extcoef = 0._rfreal
    DO n = 1,nphase
      extcoef = extcoef + optconst(phase_prop_v,n)* &
                optconst(phase_prop_q,n)/optconst(phase_prop_d,n)
    ENDDO
    extcoef = 1.5_rfreal*extcoef
    WRITE(stdout,1010) solver_name//' artif. ext.coef.=', extcoef
    WRITE(stdout,1010) solver_name//' trshld ext.coef.=', radi_real_ecmin
    IF (extcoef < radi_real_ecmin ) &
    WRITE(stdout,1030) solver_name//' radiation computation has no effect'

  ELSEIF (media == radi_media_real) THEN
    IF (optconst(phase_prop_v,radi_phase_gas) > radi_real_small) THEN
      WRITE(stdout,1030) solver_name//' media phase   = gas'
      WRITE(stdout,1010) solver_name//'   Q-extinction .=', &
                         optconst(phase_prop_q,radi_phase_gas)
    ENDIF
    IF (optconst(phase_prop_v,radi_phase_conpart) > radi_real_small) THEN
      WRITE(stdout,1030) solver_name//' media phase   = continuum particles'
      WRITE(stdout,1010) solver_name//'   Q-extinction .=', &
                         optconst(phase_prop_q,radi_phase_conpart)
    ENDIF
    IF (optconst(phase_prop_v,radi_phase_dispart) > radi_real_small) THEN
      WRITE(stdout,1030) solver_name//' media phase   = discrete particles'
      WRITE(stdout,1010) solver_name//'   Q-extinction .=', &
                         optconst(phase_prop_q,radi_phase_dispart)
    ENDIF ! media phase

    WRITE(stdout,1010) solver_name//' trshld ext.coef.=', radi_real_ecmin
  ENDIF   ! radiation media

! output selected parameters pertinent to RTE (general) method to monitor

  IF ((radimodel == radi_model_fldsrc) .OR. &
      (radimodel == radi_model_fldtran)) THEN

    IF (fluxlim == fld_lim_none) THEN
      WRITE(stdout,1030) solver_name//' flux limiter    = none'
    ELSEIF (fluxlim == fld_lim_lp) THEN
      WRITE(stdout,1030) solver_name//' flux limiter    = Levermore-Pomraning'
    ENDIF

    IF (radimodel == radi_model_fldtran) THEN
      WRITE(stdout,1030) solver_name//' FLDTRAN Numeric :'
      WRITE(stdout,1020) solver_name//' FLD smoocf      =',smoocf
      IF (discrtype == fld_discr_cen) THEN
        IF (discrorder == fld_discr_ord1) &
        WRITE(stdout,1030) solver_name//' FLD spc discr.  = 1st order central'
        IF (discrorder == fld_discr_ord2) &
        WRITE(stdout,1030) solver_name//' FLD spc discr.  = 2nd order central'
        WRITE(stdout,1020) solver_name//' FLD k2          =',k2
        WRITE(stdout,1020) solver_name//' FLD 1/k4        =',ook4
      ELSEIF (discrtype == fld_discr_upw) THEN
        IF (discrorder == fld_discr_ord1) &
        WRITE(stdout,1030) solver_name//' FLD spc discr.  = 1st order upwind'
        IF (discrorder == fld_discr_ord2) &
        WRITE(stdout,1030) solver_name//' FLD spc discr.  = 2nd order upwind'
      ENDIF
    ENDIF

  ELSEIF ((radimodel == radi_model_rtegray) .OR. &
          (radimodel == radi_model_rteband)) THEN

    IF (solmethod == radi_num_dom4) THEN
      WRITE(stdout,1030) solver_name//' solution method = discrete ordinate S4'
    ELSEIF (solmethod == radi_num_dom8) THEN
      WRITE(stdout,1030) solver_name//' solution method = discrete ordinate S8'
    ELSEIF (solmethod == radi_num_dom16) THEN
      WRITE(stdout,1030) solver_name//' solution method = discrete ordinate S16'
    ELSEIF (solmethod == radi_num_fvm) THEN
      WRITE(stdout,1030) solver_name//' solution method = finite volume method'
    ENDIF

    IF (solmethod == radi_num_fvm) THEN
      WRITE(stdout,1020) solver_name//' N polar angles  =', npol
      WRITE(stdout,1020) solver_name//' N azimuthal     =', nazi
    ENDIF ! solMethod
  ENDIF   ! radiModel

! general derived parameters

  WRITE(stdout,1020)   solver_name//' N intens.angles =', npol
  WRITE(stdout,  * )   solver_name//'      polar angles    =', &
                                      angles(:,radi_angle_polar)
  WRITE(stdout,  * )   solver_name//'      polar angles    =', &
                                      angles(:,radi_angle_azimu)

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

  CALL deregisterfunction( global )

1005 FORMAT(/,4x,a)
1010 FORMAT(6x,a,e12.5)
1020 FORMAT(6x,a,i4)
1030 FORMAT(6x,a)

END SUBROUTINE radi_printuserinput

!******************************************************************************
!
! RCS Revision history:
!
! $Log: RADI_PrintUserInput.F90,v $
! Revision 1.4  2008/12/06 08:44:37  mtcampbe
! Updated license.
!
! Revision 1.3  2008/11/19 22:17:50  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.2  2004/09/30 17:11:15  wasistho
! prepared for full FLD radiation model
!
! Revision 1.1  2004/09/22 02:35:49  wasistho
! changed file nomenclature from lower to upper case
!
! Revision 1.7  2004/09/22 01:31:35  wasistho
! switch LFD to FLD for flux limited diffusion
!
! Revision 1.6  2004/09/18 17:41:27  wasistho
! install Limited Flux Diffusion radiation
!
! Revision 1.5  2004/03/05 22:09:04  jferry
! created global variables for peul, plag, and inrt use
!
! Revision 1.4  2003/07/30 22:23:41  wasistho
! enter part and smoke data into radiation
!
! Revision 1.3  2003/07/23 03:13:58  wasistho
! cured baby illness
!
! Revision 1.2  2003/07/18 01:39:08  wasistho
! removed bcModel from input data structure
!
! Revision 1.1  2003/07/17 01:16:59  wasistho
! initial activation rocrad
!
!
!
!******************************************************************************