residual_mod.f

Go to the documentation of this file.

! -*- f90 -*-
MODULE residual

      Use param, only: dim_n, dim_m

!     residual.inc

      INTEGER, PARAMETER :: max_resid_index = 8    !for printing; don't change this

      INTEGER, PARAMETER :: resid_p  = 1     !pressure
      INTEGER, PARAMETER :: resid_ro = 2     !density, volume fraction
      INTEGER, PARAMETER :: resid_u  = 3     !u-velocity
      INTEGER, PARAMETER :: resid_v  = 4     !v-velocity
      INTEGER, PARAMETER :: resid_w  = 5     !w-velocity
      INTEGER, PARAMETER :: resid_t  = 6     !temperature
      INTEGER, PARAMETER :: resid_th = 7     !granular temperature
      INTEGER, PARAMETER :: resid_sc = 8     !user-defined scalar
      INTEGER, PARAMETER :: nresid   = 8 + dim_n
      INTEGER, PARAMETER :: resid_ke = 9     !k-epsilon equations
      INTEGER, PARAMETER :: resid_x  = 10    !mass fraction (keep this the last)
      INTEGER, PARAMETER :: nprefix  = 10
!
!    Group Resisuals by equation
      INTEGER, PARAMETER :: hydro_grp   = 1     !hydrodynamics
      INTEGER, PARAMETER :: theta_grp   = 2     !Granular Energy
      INTEGER, PARAMETER :: energy_grp  = 3     !Energy
      INTEGER, PARAMETER :: species_grp = 4     !Species
      INTEGER, PARAMETER :: scalar_grp  = 5     !Scalars
      INTEGER, PARAMETER :: ke_grp      = 6     !K-Epsilon

!                      prefix of Residuals string
      CHARACTER, PARAMETER, DIMENSION(NPREFIX) :: resid_prefix = &
        (/ 'P', 'R', 'U', 'V', 'W', 'T', 'G', 'S', 'K', 'X' /)

!
!                      Average residual
      DOUBLE PRECISION, DIMENSION(:,:), ALLOCATABLE :: resid
!
!                      Maximum residual
      DOUBLE PRECISION, DIMENSION(:,:), ALLOCATABLE ::  max_resid
!
!                      sum of residuals every 5 iterations
      DOUBLE PRECISION sum5_resid
!
!                      IJK location of maximum residual
      INTEGER, DIMENSION(:,:), ALLOCATABLE :: ijk_resid

!                      Residual Numerator
      DOUBLE PRECISION, DIMENSION(:,:), ALLOCATABLE :: num_resid
!
!                      Residual Denominator
      DOUBLE PRECISION, DIMENSION(:,:), ALLOCATABLE :: den_resid
!
!                      Residual Packing for Global Operations
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: resid_pack
!
!                      Residual sum within a group of equations
      LOGICAL          :: group_resid
      DOUBLE PRECISION :: resid_grp(6)
!
!                      Residuals to be printed out
      CHARACTER(LEN=4)      resid_string(max_resid_index)
      CHARACTER(LEN=8)      resid_grp_string(6)
!
!                      Indices of residuals to be printed out
      INTEGER          resid_index(max_resid_index, 2)
!

!                        fluid and solids accumulation, for checking the over-all fluid mass balance
      DOUBLE PRECISION accum_resid_g, accum_resid_s(dim_m)

   CONTAINS

      FUNCTION get_resid_string(INDEX)
         IMPLICIT NONE
         CHARACTER(LEN=4) :: GET_RESID_STRING
         INTEGER, INTENT(IN) :: INDEX

         get_resid_string = resid_string(index)

      END FUNCTION get_resid_string

      FUNCTION get_resid_grp_string(INDEX)
         IMPLICIT NONE
         CHARACTER(LEN=8) :: GET_RESID_GRP_STRING
         INTEGER, INTENT(IN) :: INDEX

         get_resid_grp_string = resid_grp_string(index)

      END FUNCTION get_resid_grp_string

      FUNCTION get_resid(INDEX)
         IMPLICIT NONE
         DOUBLE PRECISION :: GET_RESID
         INTEGER, INTENT(IN) :: INDEX
         INTEGER :: RI, RI2

         IF (index > SIZE(resid_index,1)) THEN
            ! PRINT *,__FILE__," INVALID VALUE FOR INDEX ",INDEX
            get_resid = 0.0
            RETURN
         ENDIF
         ri = resid_index(index,1)
         ri2 = resid_index(index,2)
         IF (ri > SIZE(resid,1)) THEN
            ! PRINT *,__FILE__," INVALID VALUE FOR RESID_INDEX 1 ",RI
            get_resid = 0.0
            RETURN
         ENDIF
         IF (ri2 > SIZE(resid,1)) THEN
            ! PRINT *,__FILE__," INVALID VALUE FOR RESID_INDEX 2 ",RI2
            get_resid = 0.0
            RETURN
         ENDIF
         get_resid = resid(ri,ri2)

      END FUNCTION get_resid

      FUNCTION get_resid_grp(INDEX)
         IMPLICIT NONE
         DOUBLE PRECISION :: GET_RESID_GRP
         INTEGER, INTENT(IN) :: INDEX

          get_resid_grp = resid_grp(index)

      END FUNCTION get_resid_grp

      END MODULE residual