bc_mod.f

Go to the documentation of this file.

!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvC
!                                                                      C
!  Module name: bc.inc                                                 C
!  Purpose: Common block containing boundary conditions data           C
!                                                                      C
!  Author: M. Syamlal                                 Date: dd-mmm-yy  C
!  Reviewer:                                          Date: dd-mmm-yy  C
!                                                                      C
!  Revision Number:                                                    C
!  Purpose:                                                            C
!  Author:                                            Date: dd-mmm-yy  C
!  Reviewer:                                          Date: dd-mmm-yy  C
!                                                                      C
!  Literature/Document References: None                                C
!                                                                      C
!  Variables referenced: None                                          C
!  Variables modified: None                                            C
!                                                                      C
!  Local variables: None                                               C
!                                                                      C
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^C

      MODULE bc

      Use param, only: dimension_bc, dim_scalar, dim_m, dim_n_g, dim_n_s

!
!                      x coordinate of the west face of a region where
!                      boundary conditions are specified
      DOUBLE PRECISION bc_x_w (dimension_bc)
!
!                      x coordinate of the east face of a region where
!                      boundary conditions are specified
      DOUBLE PRECISION bc_x_e (dimension_bc)
!
!                      y coordinate of the south face of a region where
!                      boundary conditions are specified
      DOUBLE PRECISION bc_y_s (dimension_bc)
!
!                      y coordinate of the north face of a region where
!                      boundary conditions are specified
      DOUBLE PRECISION bc_y_n (dimension_bc)
!
!                      z coordinate of the bottom face of a region where
!                      boundary conditions are specified
      DOUBLE PRECISION bc_z_b (dimension_bc)
!
!                      z coordinate of the top face of a region where
!                      boundary conditions are specified
      DOUBLE PRECISION bc_z_t (dimension_bc)
!
!                      i index of the west face of a region where
!                      boundary conditions are specified
      INTEGER          bc_i_w (dimension_bc)
!
!                      i index of the east face of a region where
!                      boundary conditions are specified
      INTEGER          bc_i_e (dimension_bc)
!
!                      j index of the south face of a region where
!                      boundary conditions are specified
      INTEGER          bc_j_s (dimension_bc)
!
!                      j index of the north face of a region where
!                      boundary conditions are specified
      INTEGER          bc_j_n (dimension_bc)
!
!                      k index of the bottom face of a region where
!                      boundary conditions are specified
      INTEGER          bc_k_b (dimension_bc)
!
!                      k index of the top face of a region where
!                      boundary conditions are specified
      INTEGER          bc_k_t (dimension_bc)
!
!                      Void fraction in a specified boundary region
      DOUBLE PRECISION bc_ep_g (dimension_bc)
!
!                      Gas pressure in a specified boundary region
      DOUBLE PRECISION bc_p_g (dimension_bc)
!
!                      Microscopic density of gas in a specified
!                      boundary region
      DOUBLE PRECISION bc_ro_g (dimension_bc)
!
!                      Macroscopic density of gas in a specified
!                      boundary region
      DOUBLE PRECISION bc_rop_g (dimension_bc)
!
!                      Macroscopic density of solids phases in a
!                      specified boundary region
      DOUBLE PRECISION bc_rop_s (dimension_bc, dim_m)
      DOUBLE PRECISION bc_ep_s (dimension_bc, dim_m)
!
!                      Gas phase temperature in a specified boundary
!                      region
      DOUBLE PRECISION bc_t_g (dimension_bc)
!
!                      Solids phase temperature in a specified
!                      boundary region
      DOUBLE PRECISION bc_t_s (dimension_bc, dim_m)
!
!                      Solids phase granular temperature in a specified
!                      boundary region
      DOUBLE PRECISION bc_theta_m (dimension_bc, dim_m)
!
!                      x-component of gas velocity in a specified
!                      boundary region
      DOUBLE PRECISION bc_u_g (dimension_bc)
!
!                      x-component of solids phase velocity in a
!                      specified boundary region
      DOUBLE PRECISION bc_u_s (dimension_bc, dim_m)
!
!                      y-component of gas velocity in a specified
!                      boundary region
      DOUBLE PRECISION bc_v_g (dimension_bc)
!
!                      y-component of solids phase velocity in a
!                      specified boundary region
      DOUBLE PRECISION bc_v_s (dimension_bc, dim_m)
!
!                      z-component of gas velocity in a specified
!                      boundary region
      DOUBLE PRECISION bc_w_g (dimension_bc)
!
!                      z-component of solids phase velocity in a
!                      specified boundary region
      DOUBLE PRECISION bc_w_s (dimension_bc, dim_m)
!
! JFD: For cut cells, define the magnitude of velocity that will be enforced
!      perpendicular to the cut face, for CG_MI boundary condition
!
!                      magnitude of gas velocity in a specified
!                      boundary region
      DOUBLE PRECISION bc_velmag_g (dimension_bc)
!
!                      magnitude of solids phase velocity in a
!                      specified boundary region
      DOUBLE PRECISION bc_velmag_s (dimension_bc, dim_m)

!
!                      Type of boundary: MASS_INFLOW, MASS_OUTFLOW,
!                      P_INFLOW, P_OUTFLOW, FREE_SLIP_WALL, NO_SLIP_WALL
      CHARACTER(LEN=16)  ::   bc_type (dimension_bc)
      INTEGER ::     bc_type_enum (dimension_bc)

      enum, bind(c)
         enumerator :: cg_nsw, cg_fsw, cg_psw, cg_mi, none
         enumerator :: no_slip_wall, free_slip_wall, par_slip_wall, nsw, fsw, psw
         enumerator :: p_outflow, mass_outflow, outflow
         enumerator :: p_inflow, mass_inflow
         enumerator :: cg_po, cg_mo
         enumerator :: blank
         enumerator :: dummy
      END enum

      ! Total number of valid BC types
      INTEGER, PARAMETER :: dim_bctype = 21
      ! Valid boundary condition types
      CHARACTER(LEN=16), DIMENSION(1:DIM_BCTYPE) ::valid_bc_type = (/&
           'MASS_INFLOW     ', 'MI              ',&
           'MASS_OUTFLOW    ', 'MO              ',&
           'P_INFLOW        ', 'PI              ',&
           'P_OUTFLOW       ', 'PO              ',&
           'FREE_SLIP_WALL  ', 'FSW             ',&
           'NO_SLIP_WALL    ', 'NSW             ',&
           'PAR_SLIP_WALL   ', 'PSW             ',&
           'OUTFLOW         ', 'OF              ',&
           'CG_NSW          ', 'CG_FSW          ',&
           'CG_PSW          ', 'CG_MI           ',&
           'CG_PO           '/)

      INTEGER, DIMENSION(1:DIM_BCTYPE) ::valid_bc_type_enum = (/&
           mass_inflow     , mass_inflow      ,&
           mass_outflow    , mass_outflow      ,&
           p_inflow        , p_inflow      ,&
           p_outflow       , p_outflow      ,&
           free_slip_wall  , fsw     ,&
           no_slip_wall    , nsw     ,&
           par_slip_wall   , psw     ,&
           outflow         , outflow      ,&
           cg_nsw          , cg_fsw  ,&
           cg_psw          , cg_mi   ,&
           cg_po           /)


!                      FLAG to specify if this PO BC applies to solid phase
!                      in discrete implementation or not. For example, setting
!                      Pressure outflow only for gas-phase.

      LOGICAL          bc_po_apply_to_des (dimension_bc)

!                      Gas volumetric flow rate through the boundary
      DOUBLE PRECISION bc_volflow_g (dimension_bc)
!
!                      Solids volumetric flow rate through the boundary
      DOUBLE PRECISION bc_volflow_s (dimension_bc, dim_m)
!
!                      Gas mass flow rate through the boundary
      DOUBLE PRECISION bc_massflow_g (dimension_bc)
!
!                      Solids mass flow rate through the boundary
      DOUBLE PRECISION bc_massflow_s (dimension_bc, dim_m)
!
!                      Logical variable to determine whether a bc is defined
       LOGICAL         bc_defined (dimension_bc)
!start kapil&anuj 01/19/98
!
!                      Logical variable to determine whether the partial
!                      slip bc of Johnson and Jackson is used
       INTEGER         bc_jj_ps (dimension_bc)
!end   kapil&anuj 01/19/98
!
!                      Character variable with values W, E, S, N, B, and T
!                      to determine the flow plane of a flow cell
       CHARACTER       bc_plane (dimension_bc)
!
!                      The interval at the beginning when normal vel. is equal to
!                      BC_Jet_g0
      DOUBLE PRECISION bc_dt_0 (dimension_bc)
!
!                      Stored value of normal velocity
      DOUBLE PRECISION bc_jet_g (dimension_bc)
!
!                      Value of normal vel. during the initial interval BC_DT_0
      DOUBLE PRECISION bc_jet_g0 (dimension_bc)
!
!                      The interval when normal vel. is equal to BC_Jet_gh
      DOUBLE PRECISION bc_dt_h (dimension_bc)
!
!                      Value of normal vel. during the initial interval BC_DT_h
      DOUBLE PRECISION bc_jet_gh (dimension_bc)
!
!                      The interval when normal vel. is equal to BC_Jet_gl
      DOUBLE PRECISION bc_dt_l (dimension_bc)
!
!                      Value of normal vel. during the initial interval BC_DT_l
      DOUBLE PRECISION bc_jet_gl (dimension_bc)
!
!                      Time to update a transient boundary condition
      DOUBLE PRECISION bc_time (dimension_bc)
!
!                      Area of boundary surfaces
      DOUBLE PRECISION bc_area (dimension_bc)
!
!                      Volume of boundary cells
      DOUBLE PRECISION bc_vol (dimension_bc)
!
!                      Gas species mass fractions in a boundary region
      DOUBLE PRECISION bc_x_g (dimension_bc, dim_n_g)
!
!                      Solids species mass fractions in a boundary region
      DOUBLE PRECISION bc_x_s (dimension_bc, dim_m, dim_n_s)
!
!                      Accumulated or average mass outflow rate of gas
      DOUBLE PRECISION bc_mout_g(dimension_bc)
!
!                      Accumulated or average mass outflow rate of solids
      DOUBLE PRECISION bc_mout_s(dimension_bc, dim_m)
!
!                      Accumulated or average volumetric outflow rate of gas
      DOUBLE PRECISION bc_vout_g(dimension_bc)
!
!                      Accumulated or average volumetric outflow rate of solids
      DOUBLE PRECISION bc_vout_s(dimension_bc, dim_m)
!
!                      Number of outflow rate values accumulated
      INTEGER          bc_out_n (dimension_bc)
!
!                      Pressure drop specified for cyclic b.c. in X
      DOUBLE PRECISION delp_x
!
!                      Pressure drop specified for cyclic b.c. in Y
      DOUBLE PRECISION delp_y
!
!                      Pressure drop specified for cyclic b.c. in Z
      DOUBLE PRECISION delp_z
!
!                      Specified mass flux (e.g., g/cm^2.s) in the cyclic
!                      direction with specified pressure drop (only one
!                      direction is allowed).
      DOUBLE PRECISION flux_g
!
!                      Average gas velocity in X direction (for cyclic bc)
      DOUBLE PRECISION u_g0
!
!                      Average gas velocity in Y direction (for cyclic bc)
      DOUBLE PRECISION v_g0
!
!                      Average gas velocity in Z direction (for cyclic bc)
      DOUBLE PRECISION w_g0
!
!                      Average solids velocity in X direction (for cyclic bc)
      DOUBLE PRECISION u_s0 (dim_m)
!
!                      Average solids velocity in Y direction (for cyclic bc)
      DOUBLE PRECISION v_s0 (dim_m)
!
!                      Average solids velocity in Z direction (for cyclic bc)
      DOUBLE PRECISION w_s0 (dim_m)
!
!                      IJK location where P_g is fixed for cyclic b.c's
      INTEGER          ijk_p_g
!
!                      Coefficient in partial slip condition -- gas
      DOUBLE PRECISION bc_hw_g (dimension_bc)
!
!                      Coefficient in partial slip condition -- solids
      DOUBLE PRECISION bc_hw_s (dimension_bc, dim_m)
!
!                      Wall velocity for partial slip condition -- gas
      DOUBLE PRECISION bc_uw_g (dimension_bc)
!
!                      Wall velocity for partial slip condition -- gas
      DOUBLE PRECISION bc_vw_g (dimension_bc)
!
!                      Wall velocity for partial slip condition -- gas
      DOUBLE PRECISION bc_ww_g (dimension_bc)
!
!                      Wall velocity for partial slip condition -- solids
      DOUBLE PRECISION bc_uw_s (dimension_bc, dim_m)
!
!                      Wall velocity for partial slip condition -- solids
      DOUBLE PRECISION bc_vw_s (dimension_bc, dim_m)
!
!                      Wall velocity for partial slip condition -- solids
      DOUBLE PRECISION bc_ww_s (dimension_bc, dim_m)

!
!                      Coefficient in heat transfer boundary condition -- gas
      DOUBLE PRECISION bc_hw_t_g (dimension_bc)
!
!                      Coefficient in heat transfer boundary condition -- solids
      DOUBLE PRECISION bc_hw_t_s (dimension_bc, dim_m)
!
!                      Wall temperature in heat transfer boundary  condition -- gas
      DOUBLE PRECISION bc_tw_g (dimension_bc)
!
!                      Wall temperature in heat transfer boundary condition -- solids
      DOUBLE PRECISION bc_tw_s (dimension_bc, dim_m)
!
!                      Coefficient in heat transfer boundary condition -- gas
      DOUBLE PRECISION bc_c_t_g (dimension_bc)
!
!                      Coefficient in heat transfer boundary condition -- solids
      DOUBLE PRECISION bc_c_t_s (dimension_bc, dim_m)


!
!                      Coefficient in granular temp boundary condition -- solids
      DOUBLE PRECISION bc_hw_theta_m (dimension_bc, dim_m)
!
!                      Wall granular temperature -- solids
      DOUBLE PRECISION bc_thetaw_m (dimension_bc, dim_m)
!
!                      Coefficient in granualr tempearure boundary condition -- solids
      DOUBLE PRECISION bc_c_theta_m (dimension_bc, dim_m)

!
!                      Coefficient in mass transfer boundary condition -- gas
      DOUBLE PRECISION bc_hw_x_g (dimension_bc, dim_n_g)
!
!                      Coefficient in mass transfer boundary condition -- solids
      DOUBLE PRECISION bc_hw_x_s (dimension_bc, dim_m, dim_n_s)
!
!                      Wall value in mass  transfer boundary  condition -- gas
      DOUBLE PRECISION bc_xw_g (dimension_bc, dim_n_g)
!
!                      Wall value in mass transfer boundary condition -- solids
      DOUBLE PRECISION bc_xw_s (dimension_bc, dim_m, dim_n_s)
!
!                      Coefficient in mass transfer boundary condition -- gas
      DOUBLE PRECISION bc_c_x_g (dimension_bc, dim_n_g)
!
!                      Coefficient in mass transfer boundary condition -- solids
      DOUBLE PRECISION bc_c_x_s (dimension_bc, dim_m, dim_n_s)
!
!
!   User-defined Scalars
!
!
!                      scalar value in a boundary region
      DOUBLE PRECISION bc_scalar (dimension_bc, dim_scalar)

!
!                      Coefficient in boundary condition
      DOUBLE PRECISION bc_hw_scalar (dimension_bc, dim_scalar)

!
!                      Coefficient in boundary condition
      DOUBLE PRECISION bc_c_scalar (dimension_bc, dim_scalar)

!
!                      Wall value in boundary  condition
      DOUBLE PRECISION bc_scalarw (dimension_bc, dim_scalar)
!
!
!   K and Epsilon for Gas turbulence
!
!
!                      K & Epsilon values in a boundary region
      DOUBLE PRECISION bc_k_turb_g (dimension_bc)
      DOUBLE PRECISION bc_e_turb_g (dimension_bc)

      LOGICAL:: cg_mi_converted_to_ps(dimension_bc)


! Flag to specify the constant number of particles per cell
! for the PIC solids
! Statistical weight of parcels will be calculated by the code
      INTEGER :: bc_pic_mi_const_npc(dimension_bc, dim_m)

! Flag to specify the constant statistical weight.
! for the PIC solids
! Number of computational particles/parcels will be calculated by the code
      DOUBLE PRECISION :: bc_pic_mi_const_statwt(dimension_bc, dim_m)

    CONTAINS

      LOGICAL FUNCTION is_cg(boundary_condition)
        implicit none
        INTEGER, intent(in) :: boundary_condition
        is_cg = ((boundary_condition .eq. cg_po) &
             .or. (boundary_condition .eq. cg_mo) &
             .or. (boundary_condition .eq. cg_nsw) &
             .or. (boundary_condition .eq. cg_fsw) &
             .or. (boundary_condition .eq. cg_psw) &
             .or. (boundary_condition .eq. cg_mi) &
             )
      END FUNCTION is_cg

      LOGICAL FUNCTION is_nsw(boundary_condition)
        implicit none
        INTEGER, intent(in) :: boundary_condition
        is_nsw = ((boundary_condition .eq. cg_nsw) &
             )
      END FUNCTION is_nsw

      LOGICAL FUNCTION is_fsw(boundary_condition)
        implicit none
        INTEGER, intent(in) :: boundary_condition
        is_fsw = ((boundary_condition .eq. cg_fsw) &
             )
      END FUNCTION is_fsw

      LOGICAL FUNCTION is_psw(boundary_condition)
        implicit none
        INTEGER, intent(in) :: boundary_condition
        is_psw = ((boundary_condition .eq. cg_psw) &
             )
      END FUNCTION is_psw

      END MODULE bc