SPEC_ReadSpecTypeSection.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 user input, store it in the data structure and check.
!
! Description: None.
!
! Input:
!   regions                Data associated with regions
!   iSpecType                Species type
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************
!
! $Id: SPEC_ReadSpecTypeSection.F90,v 1.10 2008/12/06 08:44:41 mtcampbe Exp $
!
! Copyright: (c) 2003-2005 by the University of Illinois
!
! ******************************************************************************

SUBROUTINE spec_readspectypesection(regions,iSpecType)

  USE modglobal, ONLY: t_global
  USE moddatatypes
  USE moddatastruct, ONLY: t_region
  USE moderror
  USE modparameters
  USE modspecies, ONLY: t_spec_type

#ifdef RFLU
  USE modinterfaces, ONLY: readbothsection, &
                           readsection
  USE modinterfacesinteract, ONLY: inrt_setmaterial
#endif

  IMPLICIT NONE

! ******************************************************************************
! Definitions and declarations
! ******************************************************************************

! ==============================================================================
! Arguments
! ==============================================================================

  INTEGER, INTENT(IN) :: ispectype
  TYPE(t_region), DIMENSION(:), POINTER :: regions

! ==============================================================================
! Locals
! ==============================================================================

  INTEGER, PARAMETER :: nkeys = 8, nstrkeys = 1

  CHARACTER(CHRLEN) :: keys(nkeys),strkeys(nstrkeys),strvals(nstrkeys)
  CHARACTER(CHRLEN) :: rcsidentstring
  LOGICAL :: defined(nkeys),strdefined(nstrkeys)
  REAL(RFREAL) :: vals(nkeys)
  TYPE(t_global), POINTER :: global
  TYPE(t_spec_type), POINTER :: pspectype

#ifdef RFLU
  INTEGER :: ireg
#endif

! ******************************************************************************
! Start
! ******************************************************************************

  rcsidentstring = '$RCSfile: SPEC_ReadSpecTypeSection.F90,v $ $Revision: 1.10 $'

  global => regions(1)%global

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

! ******************************************************************************
! Read user input for species
! ******************************************************************************

  keys(1) = 'FROZENFLAG'
  keys(2) = 'INITVAL'
  keys(3) = 'SOURCETYPE'
  keys(4) = 'SCHMIDTNO'
  keys(5) = 'DIAMETER'
  keys(6) = 'PUFFFACTOR'
  keys(7) = 'VELOCITYMETHOD'
  keys(8) = 'SETTLINGFLAG'

  strkeys(1) = 'MATERIAL'

#ifdef RFLU
! ==============================================================================
! Read SPEC_TYPE section
! ==============================================================================

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


! ==============================================================================
! Set variables
! ==============================================================================

! ------------------------------------------------------------------------------
! Frozen flag
! ------------------------------------------------------------------------------

  IF ( defined(1) .EQV. .true. ) THEN
    DO ireg = lbound(regions,1),ubound(regions,1)
      IF ( ispectype <= regions(ireg)%specInput%nSpecies ) THEN
        IF ( nint(vals(1)) == 0 ) THEN
          regions(ireg)%specInput%specType(ispectype)%frozenFlag = .false.
        ELSE
          regions(ireg)%specInput%specType(ispectype)%frozenFlag = .true.
        END IF ! NINT
      END IF ! iSpecType
    END DO ! iReg
  END IF ! defined

! ------------------------------------------------------------------------------
! Initial value
! ------------------------------------------------------------------------------

  IF ( defined(2) .EQV. .true. ) THEN
    DO ireg = lbound(regions,1),ubound(regions,1)
      IF ( ispectype <= regions(ireg)%specInput%nSpecies ) THEN
        regions(ireg)%specInput%specType(ispectype)%initVal = vals(2)
      END IF ! iSpecType
    END DO ! iReg
  END IF ! defined

! ------------------------------------------------------------------------------
! Source type
! ------------------------------------------------------------------------------

  IF ( defined(3) .EQV. .true. ) THEN
    DO ireg = lbound(regions,1),ubound(regions,1)
      IF ( ispectype <= regions(ireg)%specInput%nSpecies ) THEN
        regions(ireg)%specInput%specType(ispectype)%sourceType = nint(vals(3))
      END IF ! iSpecType
    END DO ! iReg
  END IF ! defined

! ------------------------------------------------------------------------------
! Schmidt number
! ------------------------------------------------------------------------------

  IF ( defined(4) .EQV. .true. ) THEN
    DO ireg = lbound(regions,1),ubound(regions,1)
      IF ( ispectype <= regions(ireg)%specInput%nSpecies ) THEN
        regions(ireg)%specInput%specType(ispectype)%schmidtNumber = vals(4)
      END IF ! iSpecType
    END DO ! iReg
  END IF ! defined

! ------------------------------------------------------------------------------
! Diameter
! ------------------------------------------------------------------------------

  IF ( defined(5) .EQV. .true. ) THEN
    DO ireg = lbound(regions,1),ubound(regions,1)
      IF ( ispectype <= regions(ireg)%specInput%nSpecies ) THEN
        regions(ireg)%specInput%specType(ispectype)%diameter = vals(5)
      END IF ! iSpecType
    END DO ! iReg
  END IF ! defined

! ------------------------------------------------------------------------------
! Puff factor
! ------------------------------------------------------------------------------

  IF ( defined(6) .EQV. .true. ) THEN
    DO ireg = lbound(regions,1),ubound(regions,1)
      IF ( ispectype <= regions(ireg)%specInput%nSpecies ) THEN
        regions(ireg)%specInput%specType(ispectype)%puffFactor = vals(6)
      END IF ! iSpecType
    END DO ! iReg
  END IF ! defined

! ------------------------------------------------------------------------------
! Velocity method
! ------------------------------------------------------------------------------

  IF ( defined(7) .EQV. .true. ) THEN
    DO ireg = lbound(regions,1),ubound(regions,1)
      IF ( ispectype <= regions(ireg)%specInput%nSpecies ) THEN
        regions(ireg)%specInput%specType(ispectype)%velocityMethod = &
          nint(vals(7))
      END IF ! iSpecType
    END DO ! iReg
  END IF ! defined
  
! ------------------------------------------------------------------------------
! Settling flag
! ------------------------------------------------------------------------------

  IF ( defined(8) .EQV. .true. ) THEN
    DO ireg = lbound(regions,1),ubound(regions,1)
      IF ( ispectype <= regions(ireg)%specInput%nSpecies ) THEN
        IF ( nint(vals(8)) == 0 ) THEN
          regions(ireg)%specInput%specType(ispectype)%settlingFlag = .false.
        ELSE
          regions(ireg)%specInput%specType(ispectype)%settlingFlag = .true.
        END IF ! NINT
      END IF ! iSpecType
    END DO ! iReg
  END IF ! defined 

! ------------------------------------------------------------------------------
! Set material
! ------------------------------------------------------------------------------

  IF ( strdefined(1) .EQV. .true. ) THEN
    DO ireg = lbound(regions,1),ubound(regions,1)
      IF ( ispectype <= regions(ireg)%specInput%nSpecies ) THEN
        pspectype => regions(ireg)%specInput%specType(ispectype)

        CALL inrt_setmaterial(global,pspectype%pMaterial,strvals(1))
      END IF ! iSpecType
    END DO ! iReg
  END IF ! strDefined
#endif

! ******************************************************************************
! End
! ******************************************************************************

  CALL deregisterfunction(global)

END SUBROUTINE spec_readspectypesection

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: SPEC_ReadSpecTypeSection.F90,v $
! Revision 1.10  2008/12/06 08:44:41  mtcampbe
! Updated license.
!
! Revision 1.9  2008/11/19 22:17:53  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.8  2005/11/10 02:39:01  haselbac
! Added support for settling flag
!
! Revision 1.7  2004/07/30 22:47:37  jferry
! Implemented Equilibrium Eulerian method for Rocflu
!
! Revision 1.6  2004/07/28 15:31:34  jferry
! added USED field to SPECIES input section
!
! Revision 1.5  2004/07/23 22:43:17  jferry
! Integrated rocspecies into rocinteract
!
! Revision 1.4  2004/04/19 20:21:54  haselbac
! Added code to read source type
!
! Revision 1.3  2004/02/02 22:42:27  haselbac
! Added reading of material name and setting of material pointer
!
! Revision 1.2  2004/01/29 23:00:44  haselbac
! Added reading of Schmidt number
!
! Revision 1.1  2003/11/25 21:08:37  haselbac
! Initial revision
!
! ******************************************************************************