PEUL_ReadConPartPtypeSection.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: read in user input related to individual Eulerian particle type
!
! Description: none.
!
! Input: user input file.
!
! Output: regions = PEUL information
!
! Notes: none.
!
!******************************************************************************
!
! $Id: PEUL_ReadConPartPtypeSection.F90,v 1.3 2008/12/06 08:44:39 mtcampbe Exp $
!
! Copyright: (c) 2002 by the University of Illinois
!
!******************************************************************************

SUBROUTINE peul_readconpartptypesection( regions,brbeg,brend,iPtype )

  USE moddatatypes
  USE moddatastruct, ONLY : t_region
  USE modglobal,     ONLY : t_global
  USE modparteul,    ONLY : t_peul_input, t_peul_ptype
  USE moderror
  USE modparameters
  USE peul_modparameters

  USE modinterfaces, ONLY : readbothsection
  USE modinterfacesinteract, ONLY : inrt_setmaterial
  IMPLICIT NONE

! ... parameters
  TYPE(t_region), POINTER :: regions(:)
  INTEGER, INTENT(IN)     :: brbeg,brend,iptype

! ... loop  variables
  INTEGER :: ireg

! ... local variables
  INTEGER, PARAMETER :: nstrkeys_max = 5
  INTEGER, PARAMETER :: nkeys_max = 20

  CHARACTER(CHRLEN) :: rcsidentstring
  CHARACTER(20)     :: strkeys(nstrkeys_max),keys(nkeys_max)
  CHARACTER(CHRLEN) :: strvals(nstrkeys_max)

  INTEGER :: nkeys,nstrkeys,nptypesused,errorflag
  INTEGER :: istrkeymaterial
  INTEGER :: ikeyused,ikeydiam,ikeypuff,ikeyinitc
  INTEGER :: ikeyschm,ikeyk2,ikeyinvk4,ikeysmoocf
  INTEGER :: ikeynegreport,ikeyclipmodel,ikeymethodv

  LOGICAL :: strdefined(nstrkeys_max),defined(nkeys_max)

  REAL(RFREAL) :: vals(nkeys_max)

  TYPE(t_global),     POINTER :: global
  TYPE(t_peul_ptype), POINTER :: ptype

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

  rcsidentstring = &
    '$RCSfile: PEUL_ReadConPartPtypeSection.F90,v $ $Revision: 1.3 $'

  global => regions(1)%global

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

! begin -----------------------------------------------------------------------

! define string keys

  istrkeymaterial = 1
  nstrkeys = 1

  IF (nstrkeys > nstrkeys_max) &
    CALL errorstop( global,err_exceeds_decl_mem,__line__ )

  strkeys(istrkeymaterial) = 'MATERIAL'

! define real keys

  ikeyused      =  1
  ikeydiam      =  2
  ikeypuff      =  3
  ikeyinitc     =  4
  ikeyschm      =  5
  ikeyk2        =  6
  ikeyinvk4     =  7
  ikeysmoocf    =  8
  ikeynegreport =  9
  ikeyclipmodel = 10
  ikeymethodv   = 11
  nkeys         = 11

  IF (nkeys > nkeys_max) CALL errorstop( global,err_exceeds_decl_mem,__line__ )

  keys(ikeyused)   = 'USED'
  keys(ikeydiam)   = 'DIAM'
  keys(ikeypuff)   = 'PUFF'
  keys(ikeyinitc)  = 'INITC'
  keys(ikeyschm)   = 'SCHM'
  keys(ikeyk2)     = 'K2'
  keys(ikeyinvk4)  = '1/K4'
  keys(ikeysmoocf) = 'SMOOCF'
  keys(ikeynegreport) = 'NEGREPORT'
  keys(ikeyclipmodel) = 'CLIPMODEL'
  keys(ikeymethodv)   = 'METH_VEL'

  IF (iptype > 0) THEN

! - read smoke particle type section from input file

    CALL readbothsection( global,if_input,nkeys,nstrkeys,keys,strkeys, &
                          vals,strvals,defined,strdefined )

! - print warnings for keys that have no meaning

    IF (defined(ikeyused)) &
      WRITE(stdout,*) '### WARNING: key meaningful only for CONPART input, ', &
        'not CONPART_PTYPE: ', keys(ikeyused)

    IF (defined(ikeysmoocf)) &
      WRITE(stdout,*) '### WARNING: key meaningful only for CONPART input, ', &
        'not CONPART_PTYPE: ', keys(ikeysmoocf)

    DO ireg = brbeg,brend

      IF (regions(ireg)%peulInput%readStatus == -1) THEN
        CALL errorstop( global,err_peul_ptype,__line__ )
      ENDIF ! readStatus

      IF (regions(ireg)%peulInput%readStatus == 0) cycle

! --- fill in input data

      ptype => regions(ireg)%peulInput%ptypes(iptype)

      IF (strdefined(istrkeymaterial)) &
        CALL inrt_setmaterial(global,ptype%material,strvals(istrkeymaterial))

      IF (defined(ikeydiam))  ptype%diam    = vals(ikeydiam)
      IF (defined(ikeypuff))  ptype%puff    = vals(ikeypuff)
      IF (defined(ikeyinitc)) ptype%initc   = vals(ikeyinitc)
      IF (defined(ikeyschm))  ptype%Sc      = vals(ikeyschm)
      IF (defined(ikeyk2))    ptype%vis2    = vals(ikeyk2)
      IF (defined(ikeyinvk4)) ptype%vis4    = vals(ikeyinvk4) ! reciprocal
                                        ! taken in PEUL_DerivedInputValues
      IF (defined(ikeynegreport)) ptype%negReport = nint(vals(ikeynegreport))
      IF (defined(ikeyclipmodel)) ptype%clipModel = nint(vals(ikeyclipmodel))

      IF (defined(ikeynegreport)) THEN
        SELECT CASE (nint(vals(ikeynegreport)))
        CASE (0)
          ptype%negReport = peul_neg_report_none
        CASE (1)
          ptype%negReport = peul_neg_report_used
        CASE default
          CALL errorstop( global,err_peul_badval,__line__ )
        END SELECT ! vals(iKeyNegReport)
      END IF ! defined(iKeyNegReport)

      IF (defined(ikeyclipmodel)) THEN
        SELECT CASE (nint(vals(ikeyclipmodel)))
        CASE (0)
          ptype%clipModel = peul_clip_model_none
        CASE (1)
          ptype%clipModel = peul_clip_model_used
        CASE default
          CALL errorstop( global,err_peul_badval,__line__ )
        END SELECT ! vals(iKeyClipModel)
      END IF ! defined(iKeyClipModel)

      IF (defined(ikeymethodv)) THEN
        SELECT CASE (nint(vals(ikeymethodv)))
        CASE (0)
          ptype%methodV = peul_methv_fluidvel
        CASE (1)
          ptype%methodV = peul_methv_eqeul
        CASE default
          CALL errorstop( global,err_peul_badval,__line__ )
        END SELECT ! vals(iKeyMethodV)
      END IF ! defined(iKeyMethodV)

    END DO ! iReg

  END IF ! iPtype

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

  CALL deregisterfunction( global )

END SUBROUTINE peul_readconpartptypesection

!******************************************************************************
!
! RCS Revision history:
!
! $Log: PEUL_ReadConPartPtypeSection.F90,v $
! Revision 1.3  2008/12/06 08:44:39  mtcampbe
! Updated license.
!
! Revision 1.2  2008/11/19 22:17:51  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.1  2004/12/01 21:09:44  haselbac
! Initial revision after changing case
!
! Revision 1.10  2004/05/03 15:09:42  jferry
! added equilibrium Eulerian capability for smoke
!
! Revision 1.9  2004/03/05 22:09:04  jferry
! created global variables for peul, plag, and inrt use
!
! Revision 1.8  2004/03/02 21:44:52  jferry
! Added clipping options
!
! Revision 1.7  2003/09/26 21:49:06  fnajjar
! Changed interface call for INRT_SetMaterial to ModInterfacesInteract
!
! Revision 1.6  2003/04/07 18:29:01  jferry
! added inflow boundary condition and initialization to a constant
!
! Revision 1.5  2003/03/24 23:30:53  jferry
! overhauled rocinteract to allow interaction design to use user input
!
! Revision 1.4  2003/03/12 17:00:35  jferry
! Added missing USE statement
!
! Revision 1.3  2003/03/11 16:04:57  jferry
! Created data type for material properties
!
! Revision 1.2  2003/03/04 19:26:47  jferry
! Cleaned up routines that read sections of input files
!
! Revision 1.1  2003/02/11 22:52:51  jferry
! Initial import of Rocsmoke
!
!******************************************************************************