RFLO_FlowSolver.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: solve the discretized governing equations.
!
! Description: none.
!
! Input: dTimeSystem = time step to run the solver
!        dIterSystem = no. of iterations to run the solver
!        regions     = dimension, BC`s and flow variables of all regions.
!
! Output: accurate solution.
!
! Notes: none.
!
!******************************************************************************
!
! $Id: RFLO_FlowSolver.F90,v 1.5 2008/12/06 08:44:27 mtcampbe Exp $
!
! Copyright: (c) 2001 by the University of Illinois
!
!******************************************************************************

#ifdef GENX
SUBROUTINE rflo_flowsolver( globalGenx,timeSystem,dTimeSystem,genxHandleBc, &
                            genxhandlegm )
#else
SUBROUTINE rflo_flowsolver( dTimeSystem,dIterSystem,regions )
#endif

  USE moddatatypes
#ifdef GENX
  USE modrocstar, ONLY       : t_globalgenx
#endif
  USE moddatastruct, ONLY : t_region
  USE modglobal,     ONLY : t_global
  USE modinterfaces, ONLY : rflo_timestepping, rflo_multigrid, &
        rflo_getboundaryvalues, rflo_generatecoarsegrids, &
        rflo_copygeometrydummy, rflo_extrapolategeometry, &
        rflo_exchangegeometry, rflo_sendboundaryvalues, &
        rflo_dualtimestepping, rflo_dualmultigrid
  USE rflo_modgridmetrics, ONLY: rflo_calcgridmetrics
  USE moderror
  USE modmpi
  USE modparameters
  IMPLICIT NONE
#ifdef GENX
  include 'roccomf90.h'
#endif

! ... parameters
#ifdef GENX
  INTEGER, INTENT(in) :: genxhandlebc, genxhandlegm

  DOUBLE PRECISION, INTENT(in) :: timesystem, dtimesystem

  TYPE(t_globalgenx), POINTER :: globalgenx
#else
  REAL(RFREAL) :: dtimesystem
#endif

  INTEGER :: ditersystem

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

! ... loop variables
  INTEGER :: ireg

! ... local variables
  CHARACTER(CHRLEN) :: msg

  REAL(RFREAL) :: timerbeg, timerend, timerloc, timerglob

  TYPE(t_global), POINTER :: global

!******************************************************************************
! initialize some global variables

#ifdef GENX
  global  => globalgenx%global
  regions => globalgenx%regions

  global%genxHandleBc = genxhandlebc
  global%genxHandleGm = genxhandlegm
  ditersystem         = 0
  IF ((global%currentTime-timesystem) > 1.e-9_rfreal) THEN
    global%predCorrIter = .true.
  ELSE
    global%predCorrIter = .false.
  ENDIF
  global%currentTime = timesystem
  global%timeStamp   = timesystem
#else
  global => regions(1)%global
#endif

  global%dTimeSystem = dtimesystem

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

#ifdef GENX
! restore geometry if predictor-corrector iteration

  IF (global%predCorrIter) THEN
    IF (global%myProcid == masterproc) WRITE(stdout,'(A)')  &
      solver_name//' Restoring geometry (PC iteration) ...'
    DO ireg=1,global%nRegions
      IF (regions(ireg)%procid==global%myProcid .AND. &  ! region active and
          regions(ireg)%active==active) THEN             ! on my processor
        CALL rflo_generatecoarsegrids( regions(ireg) )   ! coarsen finest grid
        CALL rflo_copygeometrydummy( regions(ireg) )     ! copy to dummy nodes
        CALL rflo_extrapolategeometry( regions(ireg) )   ! extrapolate
      ENDIF     ! region on this processor and active
    ENDDO       ! iReg
    CALL rflo_exchangegeometry( regions )                ! exchange geometry
    CALL rflo_calcgridmetrics( regions )
  ENDIF         ! predCorrIter==true

! get BC data from GenX at time=0

  CALL com_call_function( genxhandlebc,2,0._rfreal,1 )
  DO ireg=1,global%nRegions
    IF (regions(ireg)%procid==global%myProcid .AND. &  ! region active and
        regions(ireg)%active==active) THEN             ! on my processor
      CALL rflo_sendboundaryvalues( regions(ireg),.false. )
    ENDIF     ! region on this processor and active
  ENDDO       ! iReg
  CALL com_call_function( genxhandlebc,2,0._rfreal,2 )

  DO ireg=1,global%nRegions
    IF (regions(ireg)%procid==global%myProcid .AND. &  ! region active and
        regions(ireg)%active==active          .AND. &  ! on my processor
        regions(ireg)%mixtInput%externalBc) THEN       ! external BC
      CALL rflo_getboundaryvalues( regions(ireg) )
    ENDIF
  ENDDO
#endif

! start time stepping

  IF (global%flowType == flow_unsteady) THEN
    IF (dtimesystem <= 0._rfreal) THEN
      WRITE(msg,1000) global%currentTime,global%maxTime
      CALL errorstop( global,err_dtime_negative,__line__,msg )
    ENDIF
  ELSE
    IF (ditersystem <= 0) THEN
      WRITE(msg,1005) global%currentIter,global%maxIter
      CALL errorstop( global,err_diter_negative,__line__,msg )
    ENDIF
  ENDIF

! call time-stepping routines

#ifndef GENX
#ifdef MPI
  CALL mpi_barrier( global%mpiComm,global%mpierr )
  IF (global%mpierr /=0 ) CALL errorstop( global,err_mpi_trouble,__line__ )
  timerbeg = mpi_wtime()
#endif
#endif

  IF (global%flowType == flow_unsteady) THEN
    IF (global%solverType == solv_explicit) THEN
      CALL rflo_timestepping( dtimesystem,ditersystem,regions )
    ELSE
      IF (global%cycleType == mgcycle_no) THEN
        CALL rflo_dualtimestepping( dtimesystem,regions )
      ELSE
        CALL rflo_dualmultigrid( dtimesystem,regions )
      ENDIF
    ENDIF
  ELSE
    IF (global%cycleType == mgcycle_no) THEN
      CALL rflo_timestepping( dtimesystem,ditersystem,regions )
    ELSE
      CALL rflo_multigrid( ditersystem,regions )
    ENDIF
  ENDIF

#ifndef GENX
#ifdef MPI
  timerend = mpi_wtime()
  timerloc = timerend - timerbeg
  CALL mpi_reduce( timerloc,timerglob,1,mpi_rfreal,mpi_sum,masterproc, &
                   global%mpiComm,global%mpierr )
  IF (global%mpierr /=0 ) CALL errorstop( global,err_mpi_trouble,__line__ )

  IF (global%myProcid == masterproc) &
    WRITE(stdout,1020) solver_name,timerglob/REAL(global%nProcAlloc), &
                       global%nprocalloc
#endif
#endif

! finalize

  CALL deregisterfunction( global )

! formats

1000 FORMAT('Current time is= ',1pe12.5,' but max. time is= ',e12.5)
1005 FORMAT('Current iteration is= ',i6,' but max. iteration is= ',i6)
1020 FORMAT(/,a,' Elapsed time for this run: ',1pe12.5,' sec. (average over ', &
            i5,' processors)')

END SUBROUTINE rflo_flowsolver

!******************************************************************************
!
! RCS Revision history:
!
! $Log: RFLO_FlowSolver.F90,v $
! Revision 1.5  2008/12/06 08:44:27  mtcampbe
! Updated license.
!
! Revision 1.4  2008/11/19 22:17:38  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.3  2006/03/04 04:29:14  wasistho
! moved calcGridMetrics to a rocflo module
!
! Revision 1.2  2005/06/03 13:10:09  rfiedler
! Reduce "Restoring geometry" messages.  Use MASTERPROC.
!
! Revision 1.1  2004/11/29 20:51:39  wasistho
! lower to upper case
!
! Revision 1.47  2003/11/20 16:40:39  mdbrandy
! Backing out RocfluidMP changes from 11-17-03
!
! Revision 1.43  2003/07/03 21:48:45  jblazek
! Implemented dual-time stepping.
!
! Revision 1.42  2003/05/15 02:57:04  jblazek
! Inlined index function.
!
! Revision 1.41  2003/05/09 17:01:03  jiao
! Renamed the COM_call_function_handlers to COM_call_function.
!
! Revision 1.40  2003/04/04 21:05:00  jblazek
! Corrected bug in dumping out the solution.
!
! Revision 1.39  2003/03/06 18:29:24  jiao
! Jiri: Another silly change for GenX.
!
! Revision 1.38  2003/03/04 21:56:47  jblazek
! Corrected bug for predictor-corrector iterations.
!
! Revision 1.37  2003/02/21 22:43:00  jblazek
! Corrected timeStamp for GenX.
!
! Revision 1.36  2003/02/07 00:07:03  jblazek
! Slight change of the predictor-corrector check.
!
! Revision 1.35  2003/02/06 23:55:22  jblazek
! Added check for predictor-corrector iterations in GenX.
!
! Revision 1.34  2002/10/25 18:36:47  jblazek
! Replaced [io]stat=global%error with local errorFlag for Rocflo.
!
! Revision 1.33  2002/10/19 00:40:30  jblazek
! Added utility (rflosurf) to write out surface grids for GenX.
!
! Revision 1.32  2002/10/18 16:49:20  jblazek
! Changed parameter lists to some GenX routines.
!
! Revision 1.31  2002/10/17 06:48:37  jiao
! Added call to Rocman at time 0..
!
! Revision 1.30  2002/10/16 18:56:14  jblazek
! Within GenX, BC data at t>0 are obtained in GetFlowSolution.
!
! Revision 1.29  2002/10/16 18:30:38  jblazek
! Within GenX, BC data at t=0 are updated in FlowSolver before calling
! the time-stepping routine.
!
! Revision 1.28  2002/09/20 22:22:36  jblazek
! Finalized integration into GenX.
!
! Revision 1.27  2002/09/05 17:40:21  jblazek
! Variable global moved into regions().
!
! Revision 1.26  2002/07/16 21:34:37  jblazek
! Prefixed screen output with SOLVER_NAME.
!
! Revision 1.25  2002/04/17 22:45:20  jblazek
! Pressure forces calculated also for injection boundaries.
!
! Revision 1.24  2002/04/12 17:36:23  jblazek
! Added timer.
!
! Revision 1.23  2002/04/04 19:41:09  jblazek
! Moved dTime and dIter test from main to flowSolver.
!
! Revision 1.22  2002/02/25 22:36:52  jblazek
! Simplified solver initialization routine.
!
! Revision 1.21  2002/02/21 23:25:06  jblazek
! Blocks renamed as regions.
!
! Revision 1.20  2002/02/16 07:16:00  jblazek
! Added implicit residual smoothing.
!
! Revision 1.19  2002/02/09 01:47:01  jblazek
! Added multi-probe option, residual smoothing, physical time step.
!
! Revision 1.18  2002/02/04 15:30:25  jblazek
! Added injection boundary condition.
!
! Revision 1.17  2002/02/01 22:17:38  jblazek
! Change addressing of face vectors at block boundaries.
!
! Revision 1.16  2002/02/01 00:00:24  jblazek
! Edge and corner cells defined for each level.
!
! Revision 1.15  2002/01/31 20:56:30  jblazek
! Added basic boundary conditions.
!
! Revision 1.14  2002/01/28 23:55:22  jblazek
! Added flux computation (central scheme).
!
! Revision 1.13  2002/01/23 03:51:25  jblazek
! Added low-level time-stepping routines.
!
! Revision 1.12  2002/01/16 22:03:35  jblazek
! Added time-stepping routines.
!
! Revision 1.11  2002/01/12 00:02:49  jblazek
! Added postprocessor.
!
! Revision 1.10  2002/01/11 17:20:19  jblazek
! Added time stamp or iteration number to file names.
!
! Revision 1.9  2002/01/10 18:21:29  jblazek
! Added iteration number and initial residual to solution file.
!
! Revision 1.8  2002/01/10 00:02:07  jblazek
! Added calculation of mixture properties.
!
! Revision 1.7  2002/01/08 22:09:17  jblazek
! Added calculation of face vectors and volumes.
!
! Revision 1.6  2002/01/02 16:04:20  jblazek
! Added routines to generate geometry for dummy cells.
!
! Revision 1.5  2001/12/22 00:09:39  jblazek
! Added routines to store grid and solution.
!
! Revision 1.4  2001/12/19 23:09:22  jblazek
! Added routines to read grid and solution.
!
! Revision 1.3  2001/12/11 21:59:29  jblazek
! memory allocation added.
!
! Revision 1.2  2001/12/08 00:18:42  jblazek
! Added routines to read BC input file.
!
! Revision 1.1.1.1  2001/12/03 21:44:04  jblazek
! Import of RocfluidMP
!
!******************************************************************************