RFLU_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: Flow solver of Rocflu, essentially wrapper around time-stepping
!   routine.
!
! Description: None.
!
! Input: None.
!
! Output: None.
!
! Notes: None.
!
! ******************************************************************************
!
! $Id: RFLU_FlowSolver.F90,v 1.24 2008/12/06 08:44:30 mtcampbe Exp $
!
! Copyright: (c) 2002-2004 by the University of Illinois
!
! ******************************************************************************

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

  USE moddatatypes
#ifdef GENX
  USE modrocstar, ONLY: t_globalgenx
#endif  
  USE moddatastruct, ONLY: t_level,t_region
  USE modglobal, ONLY: t_global
  USE moderror
  USE modmpi
  USE modparameters
  
#ifdef GENX
  USE rflu_modgeometry
  USE rflu_modrocstartools, ONLY: rflu_genx_initbflag
#endif   

#ifdef PETSC
  USE rflu_modnewtonkrylov, ONLY: rflu_nk_timestepping
#endif
  
  USE modinterfaces, ONLY: rflu_timestepping
#ifdef GENX
  USE modinterfaces, ONLY: rflu_getboundaryvalues,rflu_putboundaryvaluesalpha
#endif

  IMPLICIT NONE

! ******************************************************************************
! Arguments
! ******************************************************************************

#ifdef GENX
  INTEGER :: ditersystem
  INTEGER, INTENT(IN) :: genxhandlebc,genxhandlegm
  DOUBLE PRECISION, INTENT(IN) :: dtimesystem,timesystem
  TYPE(t_globalgenx), POINTER :: globalgenx
#else
  INTEGER, INTENT(IN) :: ditersystem
  REAL(RFREAL), INTENT(IN) :: dtimesystem
  TYPE(t_level), POINTER :: levels(:)  
#endif

! ******************************************************************************
! Locals
! ******************************************************************************

  CHARACTER(CHRLEN) :: rcsidentstring
#ifdef GENX  
  INTEGER :: ireg
  LOGICAL :: corrflag  
#endif
  TYPE(t_region), POINTER :: pregion,regions(:)
  TYPE(t_global), POINTER :: global

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

  rcsidentstring = '$RCSfile: RFLU_FlowSolver.F90,v $ $Revision: 1.24 $'

#ifdef GENX
  global  => globalgenx%global
  regions => globalgenx%levels(1)%regions

  IF ( (global%currentTime-timesystem) > 1.0e-10_rfreal ) THEN
    corrflag = .true.
  ELSE 
    corrflag = .false.    
  END IF ! global 

  global%currentTime  = timesystem
  global%timeStamp    = timesystem
  
  global%genxHandleBc = genxhandlebc
  global%genxHandleGm = genxhandlegm
  ditersystem         = 0
#else
  global  => levels(1)%regions(1)%global
  regions => levels(1)%regions  
#endif

  global%dTimeSystem = dtimesystem

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

#ifdef ROCPROF
  CALL fprofiler_begins("RFLU::FlowSolver")
#endif

! ******************************************************************************
! Start time stepping
! ******************************************************************************
                          
! ==============================================================================
! Write header for convergence history
! ==============================================================================

  IF ( global%myProcid==masterproc .AND. global%verbLevel/=verbose_none ) THEN
    WRITE(stdout,'(A)') solver_name
    IF ( global%flowType == flow_steady ) THEN 
      WRITE(stdout,1000) solver_name,solver_name
    ELSE IF ( global%flowType == flow_unsteady ) THEN 
      WRITE(stdout,1010) solver_name,solver_name
    END IF ! global%flowType
  END IF ! global%myProcid

#ifdef GENX
! ==============================================================================
! Get current boundary condition values for computing time steps
! ==============================================================================

  DO ireg = 1,global%nRegionsLocal
    pregion => regions(ireg)
    CALL com_call_function(global%genxHandleBc,2,0.0_rfreal,1)
    CALL rflu_putboundaryvaluesalpha(pregion)
    CALL com_call_function(global%genxHandleBc,2,0.0_rfreal,2)
    CALL rflu_genx_initbflag(pregion)
    CALL rflu_getboundaryvalues(pregion)
  END DO ! iReg 

! ==============================================================================
! Update geometry if starting corrector step
! ==============================================================================

  IF ( corrflag .EQV. .true. ) THEN  
    IF ( global%myProcid == masterproc .AND. & 
         global%verbLevel > verbose_none ) THEN 
      WRITE(stdout,'(A,1X,A)') solver_name,'Starting corrector step.'
    END IF ! global

    DO ireg = 1,global%nRegionsLocal
      pregion => regions(ireg)
      CALL rflu_buildgeometry(pregion)    
    END DO ! iReg 
  END IF ! corrFlag
#endif

! ******************************************************************************
! Call time-stepping routines
! ******************************************************************************

  IF (global%solverType == solv_explicit) THEN
    IF (global%cycleType == mgcycle_no) THEN
      CALL rflu_timestepping(dtimesystem,ditersystem,regions)
    ELSE 
      CALL errorstop(global,err_reached_default,__line__)
    END IF ! global%cycleType
  ELSE 
#ifdef PETSC
    CALL rflu_nk_timestepping(dtimesystem,ditersystem,regions)
#endif
  ENDIF ! global%solverType

! ******************************************************************************
! End
! ****************************************************************************** 
  
#ifdef ROCPROF
  CALL fprofiler_ends("RFLU::FlowSolver")
#endif
  
  CALL deregisterfunction(global)

1000 FORMAT(a,2x,' iter',4x,'res-norm',5x,'force-x',6x,'force-y',6x,'force-z', &
            6x,'mass-in',6x,'mass-out',/,a,1x,84('-'))
1010 FORMAT(a,2x,' time',10x,'delta-t',6x,'force-x',6x,'force-y',6x,'force-z', &
            6x,'mass-in',6x,'mass-out'/,a,1x,90('-'))

END SUBROUTINE rflu_flowsolver

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: RFLU_FlowSolver.F90,v $
! Revision 1.24  2008/12/06 08:44:30  mtcampbe
! Updated license.
!
! Revision 1.23  2008/11/19 22:17:42  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.22  2007/04/20 16:07:49  mtcampbe
! Updating for burnout support function RFLU_GENX_InitBFLAG
!
! Revision 1.21  2005/09/14 15:59:33  haselbac
! Minor clean-up
!
! Revision 1.20  2005/09/13 20:49:39  mtcampbe
! Added profiling calls
!
! Revision 1.19  2005/08/03 18:30:32  hdewey2
! Add IF for solverType
!
! Revision 1.18  2005/08/02 18:26:14  hdewey2
! Added NK capability
!
! Revision 1.17  2004/10/19 19:29:17  haselbac
! Cosmetics only
!
! Revision 1.16  2003/06/20 22:34:58  haselbac
! Cosmetic changes
!
! Revision 1.15  2003/05/09 17:01:03  jiao
! Renamed the COM_call_function_handlers to COM_call_function.
!
! Revision 1.14  2003/03/05 20:39:31  jiao
! ACH: Added calls to get correct data at every time step inside/outside of PC
!
! Revision 1.13  2003/02/24 18:05:38  haselbac
! Bug fix and clean-up
!
! Revision 1.12  2003/02/24 17:25:20  haselbac
! Add geometry computation for PC iterations within GENX
!
! Revision 1.11  2003/02/24 14:50:33  haselbac
! Bug fix: Added missing initialization of timeStamp
!
! Revision 1.10  2002/10/19 22:22:23  haselbac
! Removed RFLU_GetBValues - not needed here with proper calls
!
! Revision 1.9  2002/10/19 16:13:19  haselbac
! Removed include for Roccom, cosmetic changes to output
!
! Revision 1.8  2002/10/17 20:04:52  haselbac
! Added timeSystem to argument list (GENX)
!
! Revision 1.7  2002/10/17 14:12:59  haselbac
! Added RFLU_GetBValues for proper restart (discussion with Jim J.)
!
! Revision 1.6  2002/10/05 19:21:30  haselbac
! GENX integration, some cosmetics
!
! Revision 1.5  2002/09/09 15:49:58  haselbac
! global now under regions
!
! Revision 1.4  2002/06/17 13:34:12  haselbac
! Prefixed SOLVER_NAME to all screen output
!
! Revision 1.3  2002/05/04 17:09:00  haselbac
! Uncommented writing of convergence file
!
! Revision 1.2  2002/04/11 19:02:21  haselbac
! Cosmetic changes and some preparation work
!
! Revision 1.1  2002/03/14 19:12:00  haselbac
! Initial revision
!
! ******************************************************************************