geometry_mod.f

Go to the documentation of this file.

!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvC
!                                                                      C
!  Module name: geometry                                               C
!  Purpose: Common block containing geometry and discretization data   C
!                                                                      C
!  Author: M. Syamlal                                 Date: dd-mmm-yy  C
!                                                                      C
!                                                                      C
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^C

      MODULE geometry

      Use param, only: dim_i, dim_j, dim_k


! Coordinates: CARTESIAN, CYLINDRICAL
      CHARACTER(LEN=16)     coordinates

! Indicates whether x or r direction is not considered
      LOGICAL :: no_i
! Indicates whether x or r direction is considered
      LOGICAL :: do_i
! Indicates whether y direction is not considered
      LOGICAL :: no_j
! Indicates whether y direction is considered
      LOGICAL :: do_j
! Indicates whether z or theta direction is not considered
      LOGICAL :: no_k
! Indicates whether z or theta direction is considered
      LOGICAL :: do_k

! Reactor length in the x or r direction
      DOUBLE PRECISION :: xlength
! Reactor length in the y direction
      DOUBLE PRECISION :: ylength
! Reactor length in the z or theta direction
      DOUBLE PRECISION :: zlength

! Starting index in the x or r direction
      INTEGER :: imin1
! Starting index in the y direction
      INTEGER :: jmin1
! Starting index in the z or theta direction
      INTEGER :: kmin1

! Number of cells in the x or r direction
      INTEGER :: imax
! Number of cells in the y direction
      INTEGER :: jmax
! Number of cells in the z or theta direction
      INTEGER :: kmax

! Number of cells in the x or r direction + 1
      INTEGER :: imax1
! Number of cells in the y direction + 1
      INTEGER :: jmax1
! Number of cells in the z or theta direction + 1
      INTEGER :: kmax1

! Number of cells in the x or r direction + 2
      INTEGER :: imax2
! Number of cells in the y direction + 2
      INTEGER :: jmax2
! Number of cells in the z or theta direction + 2
      INTEGER :: kmax2

! Cell sizes in the x or r direction
      DOUBLE PRECISION :: dx (0:dim_i)
! Cell sizes in the y direction
      DOUBLE PRECISION :: dy (0:dim_j)
! Cell sizes in the z or theta direction
      DOUBLE PRECISION :: dz (0:dim_k)
! Starting value of X.  This quantity is useful for
! simulating an annular cylindrical region.
      DOUBLE PRECISION :: xmin

! IMAX2 * JMAX2
      INTEGER :: ijmax2
! IMAX2 * JMAX2 * KMAX2
      INTEGER :: ijkmax2
! IMAX2 * JMAX2 * KMAX2
      INTEGER :: ijkmax3
! IJMAX2 + 1
      INTEGER :: ijkmin1
! IJKMAX2 - IJMAX2
      INTEGER :: ijkmax1

! For discretization in parallel
      INTEGER :: imin2, jmin2, kmin2
      INTEGER :: imin3, jmin3, kmin3
      INTEGER :: imax3, jmax3, kmax3

! For 4th order discretization in parallel
      INTEGER :: imin4, jmin4, kmin4
      INTEGER :: imax4, jmax4, kmax4
      INTEGER :: ijkmax4, ijkmin4

! Cell flags.
      INTEGER, DIMENSION(:), ALLOCATABLE :: flag
! Cell flags with 3rd layer.
      INTEGER, DIMENSION(:), ALLOCATABLE :: flag3
! Flag for the East surface
      INTEGER, DIMENSION(:), ALLOCATABLE :: flag_e
! Flag for North surface
      INTEGER, DIMENSION(:), ALLOCATABLE :: flag_n
! Flag for Top surface
      INTEGER, DIMENSION(:), ALLOCATABLE :: flag_t
! Cell flags (bc/ic conditions)
! Allocatable type causes PG internal error, Ed's soln: pointers
!      CHARACTER(LEN=3), DIMENSION(:), ALLOCATABLE :: ICBC_FLAG
      character(LEN=3),  dimension(:), pointer :: icbc_flag

! 1 / dx_i
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: odx
! 1 / dy_j
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: ody
! 1 / dz_k
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: odz

! 1 / dx_i+1/2
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: odx_e
! 1 / dy_j+1/2
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: ody_n
! 1 / dz_k+1/2
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: odz_t

! Radial location at cell center (x_i).
! X = 1 in Cartesian coordinates.
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: x
! Azimuthal location at cell center (z_k).
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: z
! Radial location at East face (x_i+1/2).
! X_E = 1 in Cartesian coordinates.
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  x_e
!  Azimuthal location at top face (z_k+1/2).
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: z_t

! Reciprocal of radial location at cell center (1/x_i).
! oX = 1 in Cartesian coordinates.
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  ox
! Reciprocal of radial location at East face (1/x_i+1/2).
! oX_E = 1 in Cartesian coordinates.
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  ox_e


!  one or more periodic boundary condition is used
      LOGICAL :: cyclic
! Variable to flag periodic boundary condition in X
      LOGICAL :: cyclic_x
! Variable to flag periodic boundary condition in Y
      LOGICAL :: cyclic_y
! Variable to flag periodic boundary condition in Z
      LOGICAL :: cyclic_z
! Variable to flag periodic bc with pressure drop in X
      LOGICAL :: cyclic_x_pd
! Variable to flag periodic bc with pressure drop in Y
      LOGICAL :: cyclic_y_pd
! Variable to flag periodic bc with pressure drop in Z
      LOGICAL :: cyclic_z_pd
! Variable to flag periodic bc with mass flux in X
      LOGICAL :: cyclic_x_mf
! Variable to flag periodic bc with mass flux in Y
      LOGICAL :: cyclic_y_mf
! Variable to flag periodic bc with mass flux in Z
      LOGICAL :: cyclic_z_mf

! Variable to flag cylindrical coordinates
      LOGICAL :: cylindrical

! Variables for cylindrical_2d simulation
!------------------------------------------------------------>>>
! Turn on the cylindrical_2d simulation
      logical :: cylindrical_2d
! Variables for cylindrical_2d simulation
! Half width of the plate in term of cell count
      integer :: i_cyl_num
! Variables for cylindrical_2d simulation
! Cell number used to smooth the transition from plate to wedge
      integer :: i_cyl_transition
! For cylindrical_2d simulation
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: cyl_x
! For cylindrical_2d simulation
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: cyl_x_e
!------------------------------------------------------------<<<

! Factor for x direction averaging of U velocity: FX_i
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: fx
! 1 - FX_i
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: fx_bar
! Factor for x direction averaging of scalars: FX_i+1/2
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: fx_e
! 1 - FX_i+1/2
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: fx_e_bar

! Factor for y direction averaging of scalars: FY_j+1/2
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: fy_n
! 1 - FY_j+1/2
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: fy_n_bar

! Factor for z direction averaging of scalars: FZ_k+1/2
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: fz_t
! 1 - FZ_k+1/2
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: fz_t_bar

! East face area - scalar cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: ayz
! North face area - scalar cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: axz
! Top face area - scalar cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: axy
! Cell volume - scalar cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: vol

! Total volume of cell's DES stencil neighbors
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: vol_surr

! East face area - U cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: ayz_u
! North face area - U cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: axz_u
! Top face area - U cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: axy_u
! Cell volume - U cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: vol_u

! East face area - V cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: ayz_v
! North face area - V cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: axz_v
! Top face area - V cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: axy_v
! Cell volume - V cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: vol_v

! East face area - W cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: ayz_w
! North face area - W cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: axz_w
! Top face area - W cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: axy_w
! Cell volume - W cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: vol_w

! Indicates whether to use loop over "core" cells (with same
! CELL_CLASS) in LEQSOL_MOD for vectorization/performance
      LOGICAL :: use_corecell_loop

      INTEGER :: core_istart, core_iend
      INTEGER :: core_jstart, core_jend
      INTEGER :: core_kstart, core_kend

      END MODULE geometry