SPEC_ReadSpecSection.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 applicable to all species.
!
! Description: None.
!
! Input:
!   regions                Data associated with regions
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************
!
! $Id: SPEC_ReadSpecSection.F90,v 1.5 2008/12/06 08:44:41 mtcampbe Exp $
!
! Copyright: (c) 2003-2005 by the University of Illinois
!
! ******************************************************************************

SUBROUTINE spec_readspecsection(regions)

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

#ifdef RFLU
  USE modinterfaces, ONLY: readsection
#endif

  IMPLICIT NONE

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

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

  TYPE(t_region), DIMENSION(:), POINTER :: regions

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

  INTEGER, PARAMETER :: nkeys = 2

  CHARACTER(CHRLEN) :: keys(nkeys)
  CHARACTER(CHRLEN) :: rcsidentstring
  LOGICAL :: defined(nkeys),usedflag
  INTEGER :: errorflag
  REAL(RFREAL) :: vals(nkeys)
  TYPE(t_global), POINTER :: global

#ifdef RFLU
  INTEGER :: ireg
#endif

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

  rcsidentstring = '$RCSfile: SPEC_ReadSpecSection.F90,v $ $Revision: 1.5 $'

  global => regions(1)%global

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

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

  keys(1) = 'USED'
  keys(2) = 'NSPECIES'

#ifdef RFLU
  CALL readsection(regions(1)%global,if_input,nkeys,keys,vals,defined)

  IF ( defined(1) .EQV. .true. ) THEN
    usedflag = (nint(vals(1)) /= 0)   ! if keyword USED appears, evaluate
  ELSE
    usedflag = .true.                 ! if it does not appear, default = true
  END IF ! defined(1)

  DO ireg = lbound(regions,1),ubound(regions,1)
    regions(ireg)%specInput%usedFlag = usedflag
  END DO ! iReg

  IF ( (defined(2) .EQV. .true.) .AND. (usedflag .EQV. .true.) ) THEN
    DO ireg = lbound(regions,1),ubound(regions,1)
      regions(ireg)%specInput%nSpecies = nint(vals(2))
      regions(ireg)%global%nSpecies    = regions(ireg)%specInput%nSpecies
    END DO ! iReg
  END IF ! defined
#endif

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

  CALL deregisterfunction(global)

END SUBROUTINE spec_readspecsection

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: SPEC_ReadSpecSection.F90,v $
! Revision 1.5  2008/12/06 08:44:41  mtcampbe
! Updated license.
!
! Revision 1.4  2008/11/19 22:17:53  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.3  2005/10/05 20:10:38  haselbac
! Added setting of global%nSpecies
!
! Revision 1.2  2004/07/28 15:31:34  jferry
! added USED field to SPECIES input section
!
! Revision 1.1  2003/11/25 21:08:37  haselbac
! Initial revision
!
! ******************************************************************************