RFLU_InitGlobal.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: Initialize global information.
!
! Description: None.
!
! Input:
!   casename            Case name
!   verbLevel           Verbosity level
!   communicator        Communicator
!   global              Pointer to type global
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************
!
! $Id: RFLU_InitGlobal.F90,v 1.52 2008/12/06 08:44:12 mtcampbe Exp $
!
! Copyright: (c) 2002-2006 by the University of Illinois
!
! ******************************************************************************

SUBROUTINE rflu_initglobal(casename,verbLevel,communicator,global)

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

  IMPLICIT NONE

! ******************************************************************************
! Declarations and definitions
! ******************************************************************************

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

  CHARACTER(*), INTENT(IN) :: casename
  INTEGER, INTENT(IN) :: communicator,verblevel
  TYPE(t_global), POINTER :: global

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

  CHARACTER(CHRLEN) :: rcsidentstring

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

  rcsidentstring = '$RCSfile: RFLU_InitGlobal.F90,v $ $Revision: 1.52 $'

! ******************************************************************************
! Initialize global variables
! ******************************************************************************

! ==============================================================================
! Main variables
! ==============================================================================

  global%nFunTree = 0

  global%casename = casename

  global%verbLevel = verblevel
#ifdef GENX
  global%verbLevelCOM = 0
#endif

  global%checkLevel = check_high ! Default

  global%nLevels  = 1
  global%nRegions = 1

  global%nRegionsLocal = 1
  global%nRegionsProc  = 1

! ==============================================================================
! Grid and solution file formats
! ==============================================================================

  global%gridFormat  = format_ascii
  global%solutFormat = format_ascii

! ==============================================================================
! Parallel stuff
! ==============================================================================

  global%nProcAlloc = 1
  global%myProcid   = masterproc ! Default process number (if not MPI)
  global%mpiComm    = communicator
  global%mpierr     = err_none

! ==============================================================================
! Time stepping
! ==============================================================================

  global%flowType   = flow_steady
  global%solverType = solv_explicit

  global%currentIter      = 0
  global%iterSinceRestart = 0
  global%maxIter          = 10000
  global%printIter        = 1
  global%restartIter      = 0
  global%resTol           = 1.0e-5_rfreal
  global%writeIter        = 1000  

  global%currentTime      = 0.0_rfreal ! No physical time set
  global%currentTimeRK    = 0.0_rfreal
  global%dtImposed        = 1.0e-5_rfreal
  global%dtMinLimit       = 1.0e-10_rfreal
  global%maxTime          = 1.0e-4_rfreal
  global%printTime        = 1.0e-12_rfreal
  global%restartTime      = 0.0_rfreal
  global%timeSinceRestart = 0.0_rfreal
  global%timeSincePrint   = 0.0_rfreal
  global%timeSinceProbe   = 0.0_rfreal
  global%timeSinceWrite   = 0.0_rfreal
  global%writeTime        = 5.0e-5_rfreal  

  global%rkScheme = rk_scheme_4_classical

#ifndef GENX
  global%timeStamp = 0.0e+0_rfreal
#endif

  global%restartFromScratch = .false.

  global%dualTstSource = .false.

! ==============================================================================
! Optimal LES stuff
! ==============================================================================

  global%dissOLES = 0.0_rfreal
  global%enerOLES = 0.0_rfreal

  global%progressCounter = 1

#ifdef STATS
! ==============================================================================
! Time averaged statistics
! ==============================================================================

  global%doStat     = 0
  global%reStat     = 0
  global%mixtNStat  = 0
  global%turbNStat  = 0
  global%integrTime = 0.0_rfreal
#endif

! ==============================================================================
! Error variable
! ==============================================================================

  global%error = err_none

! ==============================================================================
! Mathematical constants (these should really be parameters...)
! ==============================================================================

  global%pi      = 4.0_rfreal*atan(1.0_rfreal)
  global%rad2deg = 180.0_rfreal/global%pi
  global%deg2rad = 1.0_rfreal/global%rad2deg
  global%rad     = global%deg2rad ! Should not be used in Rocflu

! ==============================================================================
! Multigrid
! ==============================================================================

  global%startLevel = 1
  global%cycleType  = mgcycle_no
  global%refineIter = 9999999

! ==============================================================================
! Reference values
! ==============================================================================

  global%refVelocity = 100.0_rfreal
  global%refPressure = 1.0e+5_rfreal
  global%refDensity  = 1.2_rfreal
  global%refCp       = 1004.5_rfreal
  global%refGamma    = 1.4_rfreal
  global%refLength   = 1.0_rfreal
  global%refREnum    = 100.0_rfreal
  global%prLam       = 0.72_rfreal
  global%prTurb      = 0.9_rfreal
  global%scnLam      = 0.22_rfreal
  global%scnTurb     = 0.9_rfreal

! ------------------------------------------------------------------------------
! Reference values specific to gas-liquid mixture computations
! ------------------------------------------------------------------------------
  
  global%refBetaPLiq    =  4.5e-7_rfreal  
  global%refBetaTLiq    = -4.5e-7_rfreal 
  global%refCvLiq       =  4179.0_rfreal
  global%refDensityLiq  =  1000.0_rfreal
  global%refPressLiq    =  1.0e+5_rfreal
  global%refTempLiq     =  273.0_rfreal

! ==============================================================================
! Geometric transformations
! ==============================================================================

  global%transformFlag = .false. ! No transformation
  global%distortFlag   = .false. ! No distortion
  global%enforceFlag   = .false.
  
  global%angleX   = 0.0_rfreal
  global%angleY   = 0.0_rfreal
  global%angleZ   = 0.0_rfreal
  global%scaleX   = 1.0_rfreal
  global%scaleY   = 1.0_rfreal
  global%scaleZ   = 1.0_rfreal
  global%distortX = 1.0_rfreal
  global%distortY = 1.0_rfreal
  global%distortZ = 1.0_rfreal  

! ==============================================================================
! Probe
! ==============================================================================

  global%nProbes = 0

  global%probeSaveIter = 1
  global%probeSaveTime = 0.0_rfreal

! ==============================================================================
! Forces and acceleration
! ==============================================================================

  global%accelOn        = .false.
  global%forceFlag      = .false.
  global%patchCoeffFlag = .true.
  
  global%forceWriteCntr  = 0
  global%thrustWriteCntr = 0

  global%accelX = 0.0_rfreal
  global%accelY = 0.0_rfreal
  global%accelZ = 0.0_rfreal    

  global%gravity = 9.81_rfreal    

  global%forceRefArea   = 1.0_rfreal
  global%forceRefLength = 1.0_rfreal
  global%forceRefXCoord = 0.0_rfreal
  global%forceRefYCoord = 0.0_rfreal
  global%forceRefZCoord = 0.0_rfreal    

! ==============================================================================
! Random number generator
! ==============================================================================

  global%randSeedOffset = 0
  global%randSeedType   = rand_seed_type_fixed

! ==============================================================================
! Multiphysics modules
! ==============================================================================

  global%inrtUsed = .false.
  global%peulUsed = .false.
  global%plagUsed = .false.
  global%specUsed = .false. 

  global%plagUsedSave = global%plagUsed

#ifdef SPEC
  global%nSpecies = 0
#endif

! ==============================================================================
! Miscellaneous
! ==============================================================================

  global%resInit = 0.0_rfreal

  global%warnCounter = 0
  
  global%moduleType = module_type_none 

  global%cnstrCaseRad = -1.0

! ==============================================================================
! Flow initialization
! ==============================================================================

  global%initFlowFlag = crazy_value_int ! To force setting of value
#ifdef PLAG
  global%initPlagFlag = crazy_value_int ! To force setting of value
#endif

! ==============================================================================
! Preprocessor
! ==============================================================================

  global%prepPartMode    = partition_mode_proper
  global%syPePatchesFlag = .false.

! ==============================================================================
! Postprocessor
! ==============================================================================

  global%postOutputFormat = post_output_format_tecplot

  global%postInterpOrder = 1
  global%postInterpType  = interp_type_proper
  global%postPlotType    = plot_grid_flow

  global%postCompErrFlag    = .false.
  global%postMergeFlag      = .true.
  global%postPlotPatchFlag  = .true.
  global%postPlotVolFlag    = .true.
  global%postWriteMergeFlag = .false.

  global%postDiscFlag     = .false.
  global%postExtractFlag  = .false.
  global%postLag2EulFlag  = .false.
  global%postSpecFlag     = .false.
  global%postVortFlag     = .false.
  global%postVortCoreFlag = .false.

  global%postSchType  =  0
  global%postSchExp   = 10.0_rfreal
  global%postNFringes = 32

  global%postNServers = 1

! ==============================================================================
! Picking
! ==============================================================================

  global%pickCoordFlag = .false.

  global%pickXCoordLow = -huge(1.0_rfreal)
  global%pickXCoordUpp =  huge(1.0_rfreal)
  global%pickYCoordLow = -huge(1.0_rfreal)
  global%pickYCoordUpp =  huge(1.0_rfreal)
  global%pickZCoordLow = -huge(1.0_rfreal)
  global%pickZCoordUpp =  huge(1.0_rfreal)

! ==============================================================================
! GENX; if GENX is defined, winName is set in rocflu_load_module.F90
! ==============================================================================

#ifndef GENX
  global%surfWinName      = ''
  global%surfWinNameInput = ''
  global%volWinName       = ''
  global%volWinNameInput  = ''
#endif

! The following will be overwritten by RFLU_ReadGENXControlFile

  global%inDir   = './'
  global%outDir  = './'

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

END SUBROUTINE rflu_initglobal

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: RFLU_InitGlobal.F90,v $
! Revision 1.52  2008/12/06 08:44:12  mtcampbe
! Updated license.
!
! Revision 1.51  2008/11/19 22:17:25  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.50  2006/10/20 21:23:29  mparmar
! Added initialization of gravity,thrustWriteCntr
!
! Revision 1.49  2006/08/04 03:03:23  haselbac
! Added init of grid distortion parameters, fixed typo
!
! Revision 1.48  2006/05/06 15:20:09  haselbac
! Bug fix: Missing ifdef PLAG
!
! Revision 1.47  2006/04/07 15:19:16  haselbac
! Removed tabs
!
! Revision 1.46  2006/03/26 20:21:35  haselbac
! Added ref values for GL model
!
! Revision 1.45  2006/03/25 21:42:47  haselbac
! Added init of syPePatchesFlag
!
! Revision 1.44  2006/02/06 23:56:37  haselbac
! Added communicator to arg list to fix bug in GENX init with Panda
!
! Revision 1.43  2005/12/10 23:28:05  haselbac
! Renamed geom post variables to pick variables
!
! Revision 1.42  2005/12/10 16:54:30  haselbac
! Added init for postLag2EulFlag
!
! Revision 1.41  2005/12/01 17:09:53  fnajjar
! Added appropriate initialization, checking and printing of random seed type
!
! Revision 1.40  2005/11/10 02:01:55  haselbac
! Added init of acceleration components
!
! Revision 1.39  2005/10/28 19:17:07  haselbac
! Added setting of postPlotPatchFlag
!
! Revision 1.38  2005/10/05 20:02:28  haselbac
! Added init for post output format and nservers
!
! Revision 1.37  2005/08/10 00:30:55  haselbac
! Added init of postVortCoreFlag
!
! Revision 1.36  2005/08/09 00:54:26  haselbac
! Added init of patchCoeffFlag, postCompErrFlag, postWriteMergeFlag
!
! Revision 1.35  2005/07/25 12:20:22  haselbac
! Added init of postVortFlag, changed postSchExp to float
!
! Revision 1.34  2005/07/05 19:26:38  haselbac
! Added init for postSchType and postSchExp
!
! Revision 1.33  2005/07/01 15:13:12  haselbac
! Added init of verbLevelCOM
!
! Revision 1.32  2005/05/01 14:18:28  haselbac
! Added init of postDiscFlag and postNFringes
!
! Revision 1.31  2005/04/15 15:06:17  haselbac
! Removed Charm/FEM routines, added init of mpiComm and plagUsedSave
!
! Revision 1.30  2005/03/31 16:49:55  haselbac
! Added initialization of currentTimeRK
!
! Revision 1.29  2004/11/17 16:27:54  haselbac
! Added setting of rkScheme
!
! Revision 1.28  2004/10/26 15:16:16  haselbac
! Added initialization of postExtractFlag
!
! Revision 1.27  2004/10/19 19:24:22  haselbac
! Added and removed several variables
!
! Revision 1.26  2004/10/09 16:36:15  fnajjar
! Initialized initPlagFlag
!
! Revision 1.25  2004/07/21 14:54:31  haselbac
! Added initialization of postInterpType
!
! Revision 1.24  2004/06/16 20:00:19  haselbac
! Added force variables, clean-up, cosmetics
!
! Revision 1.23  2004/03/15 21:02:57  haselbac
! Changed init value of checkLevel to use parameter
!
! Revision 1.22  2004/03/05 22:09:01  jferry
! created global variables for peul, plag, and inrt use
!
! Revision 1.21  2004/01/29 22:56:33  haselbac
! Added initialization of rad2deg and deg2rad
!
! Revision 1.20  2003/12/04 03:23:54  haselbac
! Collect initialization of ALL global variables, clean-up
!
! Revision 1.19  2003/11/25 21:02:47  haselbac
! Added initialization of initFlowFlag
!
! Revision 1.18  2003/10/29 21:38:14  haselbac
! Added init for new global variables
!
! Revision 1.17  2003/10/15 02:40:07  haselbac
! Added init for dtMinLimit
!
! Revision 1.16  2003/08/07 15:30:32  haselbac
! Added and changed var names
!
! Revision 1.15  2003/07/22 01:55:54  haselbac
! Added init of postInterpOrder and warnCounter
!
! Revision 1.14  2003/05/05 18:39:03  haselbac
! Added init of plotType
!
! Revision 1.13  2003/04/29 21:48:05  haselbac
! Added initialization of surfDiverFlag
!
! Revision 1.12  2003/04/28 22:40:01  haselbac
! Added init of post and prep vars, cosmetics
!
! Revision 1.11  2003/04/12 21:36:22  haselbac
! Added init of FEMRocfluGrid
!
! Revision 1.10  2003/04/07 14:21:07  haselbac
! Initialize new probe parameters, cosmetic changes
!
! Revision 1.9  2003/03/15 17:00:03  haselbac
! Removed splitFlag
!
! Revision 1.8  2003/02/01 00:27:17  haselbac
! Added initialization of transform variables and enforceFlag
!
! Revision 1.7  2002/10/27 18:52:16  haselbac
! Removed tabs
!
! Revision 1.6  2002/10/16 21:11:40  haselbac
! Added initialization of resInit
!
! Revision 1.5  2002/10/13 21:41:40  jiao
! Compiled Rocflu on IBM SP.
!
! Revision 1.4  2002/10/05 18:46:28  haselbac
! Integration into GENX, some clean-up
!
! Revision 1.3  2002/09/09 14:15:01  haselbac
! global now under regions
!
! Revision 1.2  2002/07/25 14:42:07  haselbac
! Added arguments, status of routine has changed, now called from main
!
! Revision 1.1  2002/06/14 20:05:48  haselbac
! Former RFLU_InitLocalGlobal.F90, renamed as ModLocal.F90 no longer used
!
! Revision 1.3  2002/05/28 13:49:10  haselbac
! Changed initial value for currentTime
!
! Revision 1.2  2002/05/07 18:51:01  haselbac
! Added initialization of transform flag
!
! Revision 1.1  2002/05/04 16:09:00  haselbac
! Initial revision
!
! ******************************************************************************