RFLU_GetUserInput.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 and process user input for the core solver and all physical
!   modules.
!
! Description: None.
!
! Input: None.
!
! Output: None.
!
! Notes:
!   1. timeStampPrep is written into timeStamp and currentTime only if this
!      routine is called from the preprocessor. This is indicated by the
!      optional argument isPrep. This construct is required because the
!      routine reading the timeStamp from the input file only sets timeStamp
!      and currentTime if not compiled within GENX. This is done because
!      RFLU_InitFlowSolver gets the actual time passed in as an argument when
!      running within GENX, and hence it should not be overwritten. For this
!      to work with the preprocessor, the little detour has to be taken...
!
!******************************************************************************
!
! $Id: RFLU_GetUserInput.F90,v 1.14 2008/12/06 08:44:12 mtcampbe Exp $
!
! Copyright: (c) 2002,2003 by the University of Illinois
!
!******************************************************************************

SUBROUTINE rflu_getuserinput(regions,inPrep)

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

  USE modinterfaces, ONLY: rflu_checkderiveduserinput, &
                           rflu_printuserinput, &
                           rflu_setderiveduserinput, &
                           rflu_userinput

#ifdef PLAG
  USE modinterfaceslagrangian, ONLY: plag_userinput
#endif

#ifdef PERI
  USE modinterfacesperiodic, ONLY: peri_userinput
#endif

#ifdef SPEC
  USE modinterfacesspecies, ONLY: spec_userinput
#endif

#ifdef TURB
  USE modinterfacesturbulence, ONLY: turb_userinput
#endif

#ifdef INRT
  USE modinterfacesinteract, ONLY: inrt_userinput
#endif

  IMPLICIT NONE

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

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

  LOGICAL, OPTIONAL :: inprep
  TYPE(t_region), DIMENSION(:), POINTER :: regions

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

  CHARACTER(CHRLEN) :: rcsidentstring
  TYPE(t_global), POINTER :: global

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

  rcsidentstring = '$RCSfile: RFLU_GetUserInput.F90,v $ $Revision: 1.14 $'

  global => regions(1)%global

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

  IF ( global%myProcid == masterproc .AND. &
       global%verbLevel >= verbose_low ) THEN
    WRITE(stdout,'(A,1X,A)') solver_name,'Reading user input file...'
  END IF ! global%verbLevel

! ******************************************************************************
! Input for mixture & base solver
! ******************************************************************************

  CALL rflu_userinput(regions)

#ifdef GENX
! write timeStampPrep into time variables: See note above

  IF ( present(inprep) ) THEN
    IF ( inprep .EQV. .true. ) THEN
      global%timeStamp   = global%timeStampPrep
      global%currentTime = global%timeStampPrep
    END IF ! inPrep
  END IF ! PRESENT
#endif

! ******************************************************************************
! Input for physical modules
! ******************************************************************************

#ifdef PLAG
  CALL plag_userinput(regions)
#endif

#ifdef PERI
  CALL peri_userinput(regions)
#endif

#ifdef RADI
  CALL radi_userinput(regions)
#endif

#ifdef SPEC
  CALL spec_userinput(regions)
#endif

#ifdef TURB
  CALL turb_userinput(regions)
#endif

#ifdef INRT
  CALL inrt_userinput(regions) ! must follow all other *_UserInput routines
#endif

! ******************************************************************************
! Derived values which require knowledge of input to all MP modules
! ******************************************************************************

  CALL rflu_setderiveduserinput(regions)

! ******************************************************************************
! Checks which require knowledge of input to all MP modules
! ******************************************************************************

  CALL rflu_checkderiveduserinput(regions)

! ******************************************************************************
! Write out user input for base solver and physical modules
! ******************************************************************************

  IF ( (global%myProcid == masterproc) .AND. &
       (global%verbLevel >= verbose_med) ) THEN
    CALL rflu_printuserinput(regions)
  END IF ! global

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

  IF ( (global%myProcid == masterproc) .AND. &
       (global%verbLevel >= verbose_high) ) THEN
    WRITE(stdout,'(A,1X,A)') solver_name,'Reading user input files done.'
  END IF ! global%verbLevel

  CALL deregisterfunction(global)

END SUBROUTINE rflu_getuserinput

!******************************************************************************
!
! RCS Revision history:
!
! $Log: RFLU_GetUserInput.F90,v $
! Revision 1.14  2008/12/06 08:44:12  mtcampbe
! Updated license.
!
! Revision 1.13  2008/11/19 22:17:25  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.12  2008/05/23 21:31:41  mtcampbe
! Print user input if verbose is low
!
! Revision 1.11  2007/07/08 20:18:17  gzheng
! changed PRESENT for PGI compiler
!
! Revision 1.10  2004/07/30 22:47:35  jferry
! Implemented Equilibrium Eulerian method for Rocflu
!
! Revision 1.9  2004/07/23 22:43:15  jferry
! Integrated rocspecies into rocinteract
!
! Revision 1.8  2004/06/17 23:04:30  wasistho
! added PERI_UserInput
!
! Revision 1.7  2004/02/02 22:49:22  haselbac
! Added interface for PLAG_UserInput
!
! Revision 1.6  2004/01/29 22:56:31  haselbac
! Added call to RFLU_SetDerivedUserInput
!
! Revision 1.5  2003/11/25 21:02:46  haselbac
! Added SPEC support and made cosmetic changes
!
! Revision 1.4  2003/03/04 22:12:34  jferry
! Initial import of Rocinteract
!
! Revision 1.3  2003/02/02 21:15:36  haselbac
! Bug fix: Need to check for presence and value separately...
!
! Revision 1.2  2003/01/30 19:07:34  haselbac
! Added optional argument, rfluprep-GENX problem solved
!
! Revision 1.1  2003/01/28 15:53:32  haselbac
! Initial revision, moved from rocflu
!
! Revision 1.7  2002/09/17 22:51:23  jferry
! Removed Fast Eulerian particle type
!
! Revision 1.6  2002/09/09 15:50:47  haselbac
! global and mixtInput now under region
!
! Revision 1.5  2002/08/24 03:20:56  wasistho
! put safety within #ifdef TURB
!
! Revision 1.4  2002/07/25 14:27:55  haselbac
! Added MASTERPROC distinction for output
!
! Revision 1.3  2002/06/17 13:34:12  haselbac
! Prefixed SOLVER_NAME to all screen output
!
! Revision 1.2  2002/05/04 17:09:28  haselbac
! Cosmetic changes
!
! Revision 1.1  2002/03/26 19:24:07  haselbac
! Initial revision
!
!******************************************************************************