INRT_ReadInputFile.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 for INRT information (done on all processors).
!
! Description: none.
!
! Input: user input file.
!
! Output: regions = INRT information
!
! Notes: none.
!
!******************************************************************************
!
! $Id: INRT_ReadInputFile.F90,v 1.3 2008/12/06 08:44:32 mtcampbe Exp $
!
! Copyright: (c) 2003 by the University of Illinois
!
!******************************************************************************

SUBROUTINE inrt_readinputfile( regions )

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

  USE inrt_modinterfaces, ONLY : inrt_readdefaultsection,inrt_readdrag, &
    inrt_readheattransfernonburn,inrt_readscouring, inrt_readburning,   &
    inrt_readboilingregulation
  IMPLICIT NONE

! ... parameters
  TYPE(t_region), POINTER :: regions(:)

! ... loop variables
  INTEGER :: iread,ireg

! ... local variables
  CHARACTER(CHRLEN)   :: rcsidentstring
  CHARACTER(CHRLEN+4) :: fname
  CHARACTER(256)      :: line

  LOGICAL :: usedsomewhere, unusedsomewhere

  INTEGER :: errorflag

  TYPE(t_global), POINTER :: global

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

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

  global => regions(1)%global

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

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

  fname = trim(global%inDir)//trim(global%casename)//'.inp'

  DO iread = 1,2

! - open file

    OPEN(if_input,file=fname,form='formatted',status='old',iostat=errorflag)
    global%error = errorflag
    IF (global%error /= 0) &
      CALL errorstop( global,err_file_open,__line__,'File: '//trim(fname) )

! - read file looking for keywords

    SELECT CASE (iread)

    CASE (1) ! on first pass, look for INRT_DEFAULT sections

      DO
        READ(if_input,'(A256)',err=10,end=86) line

        SELECT CASE(trim(line))

        CASE ('# INRT_DEFAULT')
          CALL inrt_readdefaultsection( regions )

        END SELECT ! line
      END DO

86    CONTINUE

    CASE (2) ! on second pass, look for all other INRT sections

      DO
        READ(if_input,'(A256)',err=10,end=87) line

        SELECT CASE(trim(line))

        CASE ('# INRT_DRAG')
          CALL inrt_readdrag( regions )

        CASE ('# INRT_HEAT_TRANSFER_NONBURN')
          CALL inrt_readheattransfernonburn( regions )

        CASE ('# INRT_SCOURING')
          CALL inrt_readscouring( regions )

        CASE ('# INRT_BURNING')
          CALL inrt_readburning( regions )

        CASE ('# INRT_BOILING_REGULATION')
          CALL inrt_readboilingregulation( regions )

        END SELECT ! line
      END DO

87    CONTINUE

    CASE default
      CALL errorstop( global,err_reached_default,__line__ )

    END SELECT ! iRead

! - close file ----------------------------------------------------------------

    CLOSE(if_input,iostat=errorflag)
    global%error = errorflag
    IF (global%error /= 0) &
      CALL errorstop( global,err_file_close,__line__,'File: '//trim(fname) )

  END DO ! iRead

! set global%inrtUsed -------------------------------------------------------

  usedsomewhere   = .false.
  unusedsomewhere = .false.

  DO ireg = lbound(regions,1),ubound(regions,1)
    usedsomewhere   = usedsomewhere   .OR. &
                             regions(ireg)%inrtInput%defaultRead
    unusedsomewhere = unusedsomewhere .OR. &
                        .NOT.regions(ireg)%inrtInput%defaultRead
  END DO ! iReg

  IF (usedsomewhere.AND.unusedsomewhere) THEN
    CALL errorstop( global,err_mp_allornone,__line__ )
  END IF ! usedSomewhere.AND.unusedSomewhere

  global%inrtUsed = usedsomewhere

! finalization & error handling -----------------------------------------------

  CALL deregisterfunction( global )
  goto 999

10   CONTINUE
  CALL errorstop( global,err_file_read,__line__,'File: '//trim(fname) )

999  CONTINUE

END SUBROUTINE inrt_readinputfile

!******************************************************************************
!
! RCS Revision history:
!
! $Log: INRT_ReadInputFile.F90,v $
! Revision 1.3  2008/12/06 08:44:32  mtcampbe
! Updated license.
!
! Revision 1.2  2008/11/19 22:17:44  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.1  2004/12/01 21:56:37  fnajjar
! Initial revision after changing case
!
! Revision 1.9  2004/07/28 15:42:13  jferry
! deleted defunct constructs: useDetangle, useSmokeDrag, useSmokeHeatTransfer
!
! Revision 1.8  2004/07/23 22:43:17  jferry
! Integrated rocspecies into rocinteract
!
! Revision 1.7  2004/04/15 16:04:21  jferry
! minor formatting (removed trailing spaces)
!
! Revision 1.6  2004/03/02 21:48:09  jferry
! First phase of replacing Detangle interaction
!
! Revision 1.5  2003/09/25 15:48:43  jferry
! implemented Boiling Regulation interaction
!
! Revision 1.4  2003/04/02 22:32:04  jferry
! codified Activeness and Permission structures for rocinteract
!
! Revision 1.3  2003/03/24 23:30:52  jferry
! overhauled rocinteract to allow interaction design to use user input
!
! Revision 1.2  2003/03/11 16:09:39  jferry
! Added comments
!
! Revision 1.1  2003/03/04 22:12:35  jferry
! Initial import of Rocinteract
!
!******************************************************************************