RungeKuttaMP.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: calculate solution at a new time level.
!
! Description: the governing equations are integrated in time using
!              the classical 4-stage Runge-Kutta method (4th-order in
!              time) in low-storage formulation.
!
! Input: regions = data of all regions.
!
! Output: regions%levels%mixt = new solution after one time step.
!
! Notes: none.
!
! ******************************************************************************
!
! $Id: RungeKuttaMP.F90,v 1.20 2008/12/06 08:44:10 mtcampbe Exp $
!
! Copyright: (c) 2003-2006 by the University of Illinois
!
! ******************************************************************************

SUBROUTINE rungekuttamp( regions )

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

#ifdef RFLU
  USE rflu_modboundxvutils
  USE rflu_modgridspeedutils, ONLY: rflu_descalegridspeeds, &
                                    rflu_scalegridspeeds, &
                                    rflu_setgridspeedscalefactor
  USE rflu_modtimezoom, ONLY: rflu_timezoomdriver
  USE rflu_modmpi
  USE rflu_modnscbc
  USE rflu_modrelatedpatches, ONLY: rflu_relp_transformwrapper
  USE rflu_modtime, ONLY: rflu_settimerk
#endif

  USE modinterfaces, ONLY : afterupdatemp, &
                            cellgradientsmp, convectivefluxesmp, &
                            globalcommunicationmp, initcommunicationmp, &
                            numericaldissipationmp, rkinitmp, rkupdatemp, &
                            sourcetermsmp, updateboundaryconditionsmp, &
                            updatedependentvarsmp, viscousfluxesmp, &
                            zerodummycellsmp, zeroresidualsmp
#ifdef RFLU
  USE modinterfaces, ONLY : rflu_equilibriumeulerian, &
                            rflu_setvarscontwrapper, &
                            rflu_setvarsdiscwrapper, & 
                            rflu_updateboundaryvalues
#ifdef GENX
  USE rflu_modrocstartools, ONLY: rflu_genx_initbflag
#endif

#ifdef PLAG
  USE plag_rflu_modcomm
#endif
#endif

  IMPLICIT NONE

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

! ... loop variables
  INTEGER :: ireg, ireglocal, istage

! ... local variables
  INTEGER :: flowmodel

  TYPE(t_global), POINTER :: global
  TYPE(t_region), POINTER :: pregion

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

  global => regions(1)%global

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

! loop over stages and regions ================================================
  

  DO istage=1,global%nrkSteps
#ifdef RFLO
    DO ireg=1,global%nRegions
      IF (regions(ireg)%procid==global%myProcid .AND. &   ! region active and
          regions(ireg)%active==active) THEN              ! on my processor
#endif
#ifdef RFLU
    DO ireglocal=1,global%nRegionsLocal
      ireg = ireglocal
#endif

! ----- set pointer and get models --------------------------------------------

        pregion => regions(ireg)

        flowmodel  = regions(ireg)%mixtInput%flowModel
        regions(ireg)%irkStep = istage

#ifdef RFLU
! ----- Set RK time -----------------------------------------------------------

        CALL rflu_settimerk(pregion,istage)

! ----- RFLU fill GENX incoming buffers ---------------------------------------

#ifdef GENX
        CALL rflu_genx_initbflag(pregion)
#endif
        CALL rflu_updateboundaryvalues(regions(ireg),istage)

! ----- Scale grid speeds -----------------------------------------------------

        CALL rflu_setgridspeedscalefactor(pregion)
        CALL rflu_scalegridspeeds(pregion)
#endif

! ----- store previous solution; set dissipation to zero ----------------------

        CALL rkinitmp( regions(ireg),istage )

! ----- compute cell-gradients for higher-order scheme ------------------------

        CALL cellgradientsmp( regions(ireg) )

! ----- compute numerical dissipation -----------------------------------------

        CALL numericaldissipationmp( regions(ireg) )

! ----- compute viscous fluxes ------------------------------------------------

        IF ( flowmodel == flow_navst ) THEN
          CALL viscousfluxesmp( regions(ireg) )
        END IF ! flowModel

! ----- compute convective fluxes; form residual ------------------------------

        CALL convectivefluxesmp( regions(ireg) )

! ----- zero residuals --------------------------------------------------------

        CALL zeroresidualsmp(regions(ireg))

! ----- add source terms ------------------------------------------------------

        CALL sourcetermsmp( regions(ireg) )

#ifdef RFLU
! ----- add Equilibrium Eulerian corrections ----------------------------------

        CALL rflu_equilibriumeulerian( pregion )
#endif

! ----- zero out residuals in dummy cells -------------------------------------

        CALL zerodummycellsmp( regions(ireg) )
#ifdef RFLO
      ENDIF  ! region on this processor and active
#endif
#ifdef RFLU
! ----- Descale grid speeds -----------------------------------------------------
        CALL rflu_descalegridspeeds(pregion)
#endif
    ENDDO    ! iReg


#ifdef RFLU
    IF(global%zoomFactor > 1) THEN
       CALL rflu_timezoomdriver(regions)
    ENDIF ! global%zoomFactor
#endif
    

#ifdef RFLO
    DO ireg=1,global%nRegions
      IF (regions(ireg)%procid==global%myProcid .AND. &   ! region active and
          regions(ireg)%active==active) THEN              ! on my processor
#endif
#ifdef RFLU
    DO ireglocal=1,global%nRegionsLocal
      ireg = ireglocal
#endif

! ----- set Region pointer

        pregion => regions(ireg)

! ----- update solution; sum up residuals -------------------------------------

        CALL rkupdatemp( regions(ireg),ireg,istage )

#ifdef RFLU
        IF ( rflu_nscbc_decidehavenscbc(pregion) .EQV. .true. ) THEN
          CALL rflu_bxv_computevarscv(pregion)
        END IF ! RFLU_NSCBC_DecideHaveNSCBC
#endif

! ----- perform checks and enforce after-update conditions --------------------

        CALL afterupdatemp( pregion,istage )



#ifdef RFLO
! ----- initiate communication kernel -----------------------------------------

        CALL initcommunicationmp( regions,ireg,istage )
#endif

! ----- update dependent variables --------------------------------------------

#ifdef RFLU
        CALL rflu_mpi_isendwrapper(pregion)
        CALL rflu_setvarscontwrapper(pregion,1,pregion%grid%nCells)

! ----- update dependent variables on boundary faces --------------------------

        IF ( rflu_nscbc_decidehavenscbc(pregion) .EQV. .true. ) THEN
          CALL rflu_bxv_setdependentvars(pregion)
        END IF !

#endif
#ifdef RFLO
        CALL updatedependentvarsmp(regions(ireg))
#endif

#ifdef RFLO
      ENDIF  ! region on this processor and active
#endif
    ENDDO    ! iReg

#ifdef RFLO
! - facilitate global non-dummy communication ---------------------------------

    CALL globalcommunicationmp( regions )

! - update boundary conditions ------------------------------------------------

    CALL updateboundaryconditionsmp( regions,istage )
#endif

#ifdef RFLU
    CALL rflu_mpi_copywrapper(regions)

    DO ireg = 1,global%nRegionsLocal
      pregion => regions(ireg)

      CALL rflu_mpi_recvwrapper(pregion)
      CALL rflu_setvarscontwrapper(pregion,pregion%grid%nCells+1, & 
                                   pregion%grid%nCellsTot)
      CALL rflu_relp_transformwrapper(pregion)                                   
    END DO ! iReg

    DO ireg = 1,global%nRegionsLocal
      pregion => regions(ireg)

      CALL rflu_mpi_clearrequestwrapper(pregion)
    END DO ! iReg

#ifdef PLAG
    IF ( global%plagUsed .EQV. .true. ) THEN
      CALL plag_rflu_commdriver(regions)

      DO ireg = 1,global%nRegionsLocal
        pregion => regions(ireg)

        CALL rflu_setvarsdiscwrapper(pregion)
      END DO ! iReg
    END IF ! global%plagUsed 
#endif
#endif
  END DO ! istage

! finalize ====================================================================

  CALL deregisterfunction( global )

END SUBROUTINE rungekuttamp

! ******************************************************************************
!
! RCS Revision history:
!
! $Log: RungeKuttaMP.F90,v $
! Revision 1.20  2008/12/06 08:44:10  mtcampbe
! Updated license.
!
! Revision 1.19  2008/11/19 22:17:23  mtcampbe
! Added Illinois Open Source License/Copyright
!
! Revision 1.18  2007/04/20 16:07:48  mtcampbe
! Updating for burnout support function RFLU_GENX_InitBFLAG
!
! Revision 1.17  2007/04/14 14:23:24  mtcampbe
! Updated for TZ
!
! Revision 1.16  2007/03/27 00:39:50  haselbac
! Removed call to PLAG_CalcnPclsTotGlobal, now in RFLU_TimeStepping
!
! Revision 1.15  2007/03/20 22:02:29  fnajjar
! Included call to PLAG_CalcnPclsTotGlobal
!
! Revision 1.14  2006/08/21 16:10:01  haselbac
! Adapted to name change
!
! Revision 1.13  2006/08/19 15:48:25  mparmar
! Added computations of boundary Cv and Dv for NSCBC implementation
!
! Revision 1.12  2006/08/18 21:09:27  fnajjar
! Removed IF around PLAG_RFLU_CommDriver for serial periodic cases
!
! Revision 1.11  2006/03/25 21:40:03  haselbac
! Added call to transforming data on related patches, cosmetics
!
! Revision 1.10  2005/12/03 19:44:54  haselbac
! Apparent bug fix: Separated call to RFLU_MPI_ClearRequestWrapper into separate loop
!
! Revision 1.9  2005/12/01 21:52:14  fnajjar
! Added IF statement around PLAG_RFLU_CommDriver, only active for more than one nRegions
!
! Revision 1.8  2005/11/10 22:21:07  fnajjar
! ACH: Proper fix for updating PLAG dv
!
! Revision 1.7  2005/11/10 16:51:28  fnajjar
! Added plagUsed IF statement around PLAG routines
!
! Revision 1.6  2005/11/02 14:53:24  haselbac
! Fady: Temporary fix so comm particles get non-cv vars updated properly
!
! Revision 1.5  2005/05/18 22:04:41  fnajjar
! Added PLAG communication routines; only initial implementation
!
! Revision 1.4  2005/04/29 00:06:09  haselbac
! Added routines to clear send requests
!
! Revision 1.3  2005/04/15 15:06:06  haselbac
! Converted to MPI
!
! Revision 1.2  2005/03/31 16:31:02  haselbac
! Added call to RFLU_SetTimeRK
!
! Revision 1.1  2004/12/01 16:51:13  haselbac
! Initial revision after changing case
!
! Revision 1.18  2004/11/14 19:36:23  haselbac
! Replaced call to UpdateDependentVarsMP by RFLU_SetVarsWrapper
!
! Revision 1.17  2004/07/30 22:47:33  jferry
! Implemented Equilibrium Eulerian method for Rocflu
!
! Revision 1.16  2004/04/14 02:07:02  haselbac
! Added grid-speed scaling calls for RFLU
!
! Revision 1.15  2004/03/25 21:14:20  jferry
! changed AfterUpdate to call most subroutines only after final RK stage
!
! Revision 1.14  2004/03/02 21:47:28  jferry
! Added After Update interactions
!
! Revision 1.13  2004/02/26 21:11:58  wasistho
! added globalCommunication
!
! Revision 1.12  2004/02/26 21:01:46  haselbac
! Enclosed updateBoundaryConditionsMP within ifdef RFLO
!
! Revision 1.11  2004/01/29 22:52:47  haselbac
! Added calls to RFLU_EnforceBoundsWrapper and updateDependentVarsMP
!
! Revision 1.10  2003/12/04 03:23:06  haselbac
! Added call to CellGradientsMP and validity check
!
! Revision 1.9  2003/11/25 21:01:45  haselbac
! Added calls to RFLU_UpdateDummyCells and ZeroResidualsMP
!
! Revision 1.8  2003/11/20 16:40:35  mdbrandy
! Backing out RocfluidMP changes from 11-17-03
!
! Revision 1.5  2003/10/03 20:42:07  haselbac
! Added Rocflu calls
!
! Revision 1.4  2003/10/01 23:52:09  jblazek
! Corrected bug in moving noslip wall BC and grid speeds.
!
! Revision 1.3  2003/05/15 02:57:02  jblazek
! Inlined index function.
!
! Revision 1.2  2003/04/10 01:22:41  jblazek
! Got rid of pRegion in ViscousFluxesMP.
!
! Revision 1.1  2003/03/28 19:42:55  fnajjar
! Initial import for RocfluidMP
!
! ******************************************************************************