des_bc_mod.f

Go to the documentation of this file.

!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv!
!                                                                      !
!  Module name: DES_INLET                                              !
!                                                                      !
!  Purpose: Common elements needed for the des mass inflow boundary    !
!  condition.                                                          !
!                                                                      !
!  Author: J.Musser                                   Date: 13-Jul-09  !
!                                                                      !
!  Comments:                                                           !
!                                                                      !
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^!

      MODULE des_bc

      USE param, only: dimension_bc, dim_m

      INTEGER :: dem_bcmi
      INTEGER :: dem_bcmo

      LOGICAL dem_mio  ! either inlet or outlet exists

! Map between DEM MI/MO IDs and the user input BC index.
      INTEGER :: dem_bcmi_map(dimension_bc)
      INTEGER :: dem_bcmo_map(dimension_bc)

! This array contains integers representing the mass/solid phase indices
! present at a specific boundary condtion in proportion to their
! respective number fraction at the inlet (i.e., it represents the
! particle number distribution of incoming solids at the inlet).  The
! array is scaled in size according to the parameter NUMFRAC_LIMIT.
      INTEGER, DIMENSION(:,:), ALLOCATABLE :: dem_bc_poly_layout

! Particle injection time scale; used when pi_factor > 1 to keep track
! of time needed for next injection
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE :: dem_mi_time

! Logical that can be flagged in the mfix.dat file to force the inlet
! to operate with an ordered boundary condition.  This may be useful
! during long simulations or if the inlet appears to be taking a long
! time to randomly place particles.
      LOGICAL :: force_ord_bc

! Particle injection factor; how many solid time steps (dtsolid) pass
! before the next injection of a particle. if pi_count is greater than
! 1, then pi_factor is set to 1 (i.e. multiple particles enter every
! solids time step).
      INTEGER, DIMENSION(:), ALLOCATABLE :: pi_factor   !(DES_BCMI)

! Particle injection count (injection number); how many particles are
! injected in one solids time step. pi_count is set to one if
! less than 1 particle enters per solids time step.
      INTEGER, DIMENSION(:), ALLOCATABLE :: pi_count   !(DES_BCMI)


! Limit on the total number of divisions (fineness) used to represent
! the particle number distribution at an inlet.
      INTEGER, PARAMETER :: numfrac_limit = 10000


! the dimension of this variable is equal to the number of grid
! cells in the inlet edge/face
      TYPE dem_mi_
! Array position of next seed location.
         INTEGER :: vacancy
! Number of positions in the layout grid.
         INTEGER :: occupants
! Flag for polydisperse inlets.
         LOGICAL :: polydisperse
! Uniform grid dimension (width and height).
         DOUBLE PRECISION :: window
! Offset for placing particles in ghost cell.
         DOUBLE PRECISION :: offset
! Fluid cell index associated with each grid. (I/J/K like)
         INTEGER :: l
         INTEGER, ALLOCATABLE :: w(:)
         INTEGER, ALLOCATABLE :: h(:)
! Spatial location of each grid cell's lower, bottom corder.
         DOUBLE PRECISION, ALLOCATABLE :: p(:)
         DOUBLE PRECISION, ALLOCATABLE :: q(:)
! The rank of the owning process owning the indexed grid cell.
         INTEGER, ALLOCATABLE :: owner(:)
      END TYPE dem_mi_

! Construct an array of integers in values from 1 to a calculated factor
! in a random order, which is used when placing new particles.
!      TYPE(DEM_MI_DATA), DIMENSION(:), ALLOCATABLE :: MI_ORDER

! Array linking all of the reaction data.
      TYPE(dem_mi_), DIMENSION(:), TARGET, ALLOCATABLE :: dem_mi

      INTEGER, ALLOCATABLE :: dem_bcmo_ijkstart(:)
      INTEGER, ALLOCATABLE :: dem_bcmo_ijkend(:)

      INTEGER, ALLOCATABLE :: dem_bcmo_ijk(:)


      INTEGER, ALLOCATABLE :: dem_bcmi_ijkstart(:)
      INTEGER, ALLOCATABLE :: dem_bcmi_ijkend(:)

      INTEGER, ALLOCATABLE :: dem_bcmi_ijk(:)


!----------------------------------------------------------------------!


! DES specification for solids phase velocity for WALL boundary
! conditions. The current setup is fairly limited. The specified
! boundary velocities are assigned to the indicated wall where a wall
! corresponds to one of the six planes in a cubic domain. Each wall
! corresponds to a number as follows west=1, east=2, bottom=3, top=4,
! south=5, north=6. See cfwallposvel for details. To specify a y or z
! velocity to the west wall set des_bc_vw_s(1,M) or des_bc_ww_s(1,M),
! respectively (note an x velocity is not valid for a west or east wall).
! Since these are user input, they are allocated here with a constant
! preset size, but their actual size is represented by &
! (nwalls, des_mmax)
      DOUBLE PRECISION des_bc_uw_s(dimension_bc, dim_m)
      DOUBLE PRECISION des_bc_vw_s(dimension_bc, dim_m)
      DOUBLE PRECISION des_bc_ww_s(dimension_bc, dim_m)

      CONTAINS
!----------------------------------------------------------------------!
!  Function to exclude cells from DEM mass inlet.                      !
!----------------------------------------------------------------------!
      LOGICAL FUNCTION exclude_dem_mi_cell(lI, lJ, lK)

      use functions, only: funijk
      use functions, only: fluid_at
      use functions, only: is_on_mype_plus2layers

      use compar, only: dead_cell_at

! Indicies of cell to check
      INTEGER, INTENT(IN) :: lI, lJ, lK
! Local value for IJK
      INTEGER :: IJK

      exclude_dem_mi_cell = .true.

      IF(.NOT.is_on_mype_plus2layers(li,lj,lk)) RETURN
      IF(dead_cell_at(li,lj,lk)) RETURN
      ijk = funijk(li,lj,lk)
      IF(.NOT.fluid_at(ijk)) RETURN

      exclude_dem_mi_cell = .false.
      RETURN
      END FUNCTION exclude_dem_mi_cell

      END MODULE des_bc