function3_mod.f

Go to the documentation of this file.

MODULE function3

  USE functions

  !^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^C
  !
  !                      Function for generating the LOCAL 3-D array index IJK
  !                      from the 1-D indices I, J, and K.
  !//FUNIJK is moved to compar for debugging purposes - Sreekanth-10/26/99
  !      INTEGER          FUNIJK3
  !                      Function for generating the LOCAL 3-D array index IJK
  !                      from the 1-D indices I, J, K and IPROC.
  !      INTEGER          FUNIJK3_PROC
  !                      Function for generating the GLOBAL 3-D array index IJK
  !                      from the 1-D indices I, J, and K.
  !      INTEGER          FUNIJK3_GL
  !
  !                      Function for calculating IMJK
  !      INTEGER          IM3_OF
  !
  !                      Function for calculating IPJK
  !      INTEGER          IP3_OF
  !
  !                      Function for calculating IJMK
  !      INTEGER          JM3_OF
  !
  !                      Function for calculating IJPK
  !      INTEGER          JP3_OF
  !
  !                      Function for calculating IJKM
  !      INTEGER          KM3_OF
  !
  !                      Function for calculating IJKP
  !      INTEGER          KP3_OF
  !
  !                      Logical function to identify a fluid cell
  !      LOGICAL          FLUID3_AT
  !
  !                      Logical function to identify a cyclic cell
  !      LOGICAL          CYCLIC3_AT
  !
  !                      DUMMY INDICES
  !      INTEGER          LI3, LJ3, LK3, LIPROC3, IJK3
  !

contains

  INTEGER FUNCTION funijk3(LI3,LJ3,LK3)
    USE compar
    IMPLICIT NONE
    INTEGER, INTENT(IN) :: LI3,LJ3,LK3
    funijk3 = lj3 + c0_3 + li3*c1_3 + lk3*c2_3
  END FUNCTION funijk3

  INTEGER FUNCTION funijk3_proc(LI3, LJ3, LK3, LIPROC3)
    USE compar
    IMPLICIT NONE
    INTEGER, INTENT(IN) :: LI3,LJ3,LK3,LIPROC3
    funijk3_proc = 1 + (lj3 - jstart4_all(liproc3))+ &
         (li3-istart4_all(liproc3))*(jend4_all(liproc3)-jstart4_all(liproc3)+1) &
         + (lk3-kstart4_all(liproc3))*(jend4_all(liproc3)-jstart4_all(liproc3)+1)* &
         (iend4_all(liproc3)-istart4_all(liproc3)+1)
  END FUNCTION funijk3_proc

  INTEGER FUNCTION funijk3_gl (LI3, LJ3, LK3)
    USE geometry
    IMPLICIT NONE
    INTEGER, INTENT(IN) :: LI3,LJ3,LK3
    funijk3_gl = 1 + (lj3 - jmin4) + (li3-imin4)*(jmax4-jmin4+1) &
         + (lk3-kmin4)*(jmax4-jmin4+1)*(imax4-imin4+1)
  END FUNCTION funijk3_gl

  INTEGER FUNCTION im3_of  (IJK3)
    USE indices
    IMPLICIT NONE
    INTEGER IJK3
    im3_of       = ijk3 + increment3_for_im(cell_class3(ijk3))
  END FUNCTION im3_of

  INTEGER FUNCTION ip3_of  (IJK3)
    USE indices
    IMPLICIT NONE
    INTEGER IJK3
    ip3_of       = ijk3 + increment3_for_ip(cell_class3(ijk3))
  END FUNCTION ip3_of

  INTEGER FUNCTION jm3_of (IJK3)
    USE indices
    IMPLICIT NONE
    INTEGER IJK3
    jm3_of       = ijk3 + increment3_for_jm(cell_class3(ijk3))
  END FUNCTION jm3_of

  INTEGER FUNCTION jp3_of (IJK3)
    USE indices
    IMPLICIT NONE
    INTEGER IJK3
    jp3_of       = ijk3 + increment3_for_jp(cell_class3(ijk3))
  END FUNCTION jp3_of

  INTEGER FUNCTION km3_of(IJK3)
    USE indices
    IMPLICIT NONE
    INTEGER IJK3
    km3_of       = ijk3 + increment3_for_km(cell_class3(ijk3))
  END FUNCTION km3_of

  INTEGER FUNCTION kp3_of   (IJK3)
    USE indices
    IMPLICIT NONE
    INTEGER IJK3
    kp3_of       = ijk3 + increment3_for_kp(cell_class3(ijk3))
  END FUNCTION kp3_of

  LOGICAL FUNCTION fluid3_at(IJK3)
    USE geometry
    IMPLICIT NONE
    INTEGER IJK3
    fluid3_at    = flag3(ijk3) .EQ. 1
  END FUNCTION fluid3_at

  LOGICAL FUNCTION cyclic3_at(IJK3)
    USE geometry
    IMPLICIT NONE
    INTEGER IJK3
    cyclic3_at   = flag3(ijk3) .EQ. 106 .OR. &
         flag3(ijk3) .EQ. 107
  END FUNCTION cyclic3_at

  INTEGER FUNCTION bound_funijk3(pLI, pLJ, pLK)
    USE compar, only: istart4, iend4, jstart4, jend4, kstart4, kend4
    IMPLICIT NONE
    INTEGER          pLI, pLJ, pLK
    bound_funijk3  = funijk3( min( iend4, max(istart4, pli) ),&
         min( jend4, max(jstart4, plj) ),&
         min( kend4, max(kstart4, plk) ) )
  END FUNCTION bound_funijk3

END MODULE function3