iteration.f90

Go to the documentation of this file.

module iteration
!
!       This module contains the iteration parameters mainly used in
!       solver.
!
    use constants, only: inttype, realtype, alwaysrealtype, maxitertypelen
    implicit none
 
    ! groundLevel:  Current ground level of the computation. Needed
    !               to determine what kind of action must be
    !               undertaken. E.G. On the coarse grids no solution
    !               will be written.
    ! currentLevel: MG level at which the compution currently resides.
    ! rkStage:      Current runge kutta stage. Needed to determine
    !               whether or not the artificial dissipation terms
    !               must be computed.
 
    integer(kind=intType) :: groundlevel, currentlevel
    integer(kind=intType) :: rkstage, subit
 
    ! nStepsCycling: Number of steps in the current cycling strategy
    ! cycling:       The corresponding array defining the multigrid
    !                cycling strategy.
 
    integer(kind=intType) :: nstepscycling
    integer(kind=intType), dimension(:), allocatable :: cycling
 
    ! iterTot: Total number of iterations on the current grid;
    !          a restart is not included in this count.
 
    integer(kind=intType) :: itertot
 
    ! rFil : coefficient to control the fraction of the dissipation
    !        residual of the previous runge-kutta stage.
 
    real(kind=realtype) :: rfil, rfilb
 
    ! t0Solver: Reference time for the solver.
 
    real(kind=realtype) :: t0solver
 
    ! converged:             Whether or not the solution has been
    !                        converged.
    ! exchangePressureEarly: Whether or not the pressure must be
    !                        exchanged early, i.e. before the
    !                        boundary conditions are applied.
    !                        This must be done for a correct treatment
    !                        of normal momentum boundary condition,
    !                        but it requires an extra call to the
    !                        halo routines.
 
    logical :: converged
    logical :: exchangepressureearly
 
    ! standAloneMode:   Whether or not an executable in stand alone
    !                   mode is built.
    ! changing_Grid:    Whether or not the grid changes in time.
    !                   In stand alone mode this only happens when
    !                   moving parts are present. In a
    !                   multi-disciplinary environment more options
    !                   are possible, i.e. deforming meshes.
    ! deforming_Grid:   Whether or not the grid deforms; this can
    !                   only happen for a multi-disciplinary,
    !                   usually aero-elastic problem.
    ! changingOverset:  Whether or not the overset connectivity needs
    !                   to be updated at each time step, due to
    !                   moving or deforming grids.
 
    logical :: standalonemode, changing_grid, deforming_grid
    logical :: changingoverset
 
    ! nOldSolAvail:     Number of available old solutions for
    !                   the time integration.
    ! nOldLevels:       Number of old levels needed in the time
    !                   integration scheme.
    ! coefTime(0:nOld): The coefficients in the time integrator
    !                   for unsteady applications.
 
    integer(kind=intType) :: noldsolavail, noldlevels
    real(kind=realtype), dimension(:), allocatable :: coeftime
 
    ! iterType: The type of iteration performed. Will be one of RK,
    ! DADI, ANK or NK ( or None on the 0th evaluation)
    character(len=maxIterTypelen) :: itertype
 
    ! approxTotalIts : A rough approximation of the total number of
    ! function evaluations. An RK or DADI multi grid iteration
    ! counts as 1.  ANK steps count as 1 + number of KSP
    ! iterations. NK steps count the total number of function
    ! evalautions either for mat-vecs or during a line search. It
    ! is this value that is checked again nCycles for doing too
    ! much work.
    integer(kind=intType) :: approxtotalits
 
    ! Variables for monitoring the current CFL and step depending
    ! on the type of iteration
    real(kind=realtype) :: cflmonitor = 0.0
    real(kind=alwaysrealtype) :: stepmonitor = 1.0
    real(kind=alwaysrealtype) :: linresmonitor = -1.0
 
    ! Added by HDN
    ! nALEMeshes:                Number of ALE levels for intermediate mesh
    !                            between two steps
    ! nALEsteps:                 Number of ALE steps at one time step
    ! coefTimeALE(nALEsteps):    The weighting coefficients to average the fluxes
    ! coefMeshALE(nALEmeshes,2): The coefficients to interpolate the mesh
    integer(kind=intType) :: nalemeshes, nalesteps
    real(kind=realtype), dimension(:), allocatable :: coeftimeale
    real(kind=realtype), dimension(:, :), allocatable :: coefmeshale
 
    ! timeSpectralGridsNotWritten: Whether or not grid files have
    !                              already been written in time
    !                              spectral mode. In this way
    !                              it is avoided that files are
    !                              written multiple times.
    ! oldSolWritten(nOldLevels-1): Logicals to indicate whether
    !                              or not old solution levels
    !                              have been written in
    !                              unsteady mode.
 
    logical :: timespectralgridsnotwritten
 
    logical, dimension(:), allocatable :: oldsolwritten
 
    ! Variables for monitoring the residuals
    real(kind=realtype) :: totalr0, totalrstart, totalrfinal, totalr
    real(kind=realtype) :: rhores0, rhoresstart, rhoresfinal, rhores
    real(kind=realtype) :: ordersconverged = 16.0_realtype
end module iteration