ic_mod.f

Go to the documentation of this file.

!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv!
!                                                                      !
!  Module: ic                                                          !
!  Author: M. Syamlal                                 Date: dd-mmm-yy  !
!                                                                      !
!  Purpose: Global initial conditions variables.                       !
!                                                                      !
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^!
      MODULE ic

! Maximum number of IC regions.
      use param, only: dimension_ic
! Maximum number of solids phases.
      use param, only: dim_m
! Maximum number of gas phase species
      use param, only: dim_n_g
! Maximum number of solids phase species
      use param, only: dim_n_s
! Maximum number of scalar equations
      use param, only: dim_scalar

! IC region West face, X-coordinate
      DOUBLE PRECISION :: ic_x_w (dimension_ic)

! IC region East face, X-coordinate
      DOUBLE PRECISION :: ic_x_e (dimension_ic)

! IC region South face, Y-coordinate
      DOUBLE PRECISION :: ic_y_s (dimension_ic)

! IC region North face, Y-coordinate
      DOUBLE PRECISION :: ic_y_n (dimension_ic)

! IC region Bottom face, Z-coordinate
      DOUBLE PRECISION :: ic_z_b (dimension_ic)

! IC region Top face, Z-coordinate
      DOUBLE PRECISION :: ic_z_t (dimension_ic)

! IC region, West face, I Index
      INTEGER :: ic_i_w (dimension_ic)

! IC region, East face, I Index
      INTEGER :: ic_i_e (dimension_ic)

! IC region, South face, J Index
      INTEGER :: ic_j_s (dimension_ic)

! IC region, North face, J Index
      INTEGER :: ic_j_n (dimension_ic)

! IC region, Bottom face, K Index
      INTEGER :: ic_k_b (dimension_ic)

! IC region, Top face, K Index
      INTEGER :: ic_k_t (dimension_ic)

! Type of initial condition: PATCH
      CHARACTER(LEN=16) :: ic_type(dimension_ic)

! Initial gas phase volume fraction
      DOUBLE PRECISION :: ic_ep_g (dimension_ic)

! Initial gas pressure
      DOUBLE PRECISION :: ic_p_g (dimension_ic)

! Initial gas pressure
      DOUBLE PRECISION :: ic_p_star(dimension_ic)

! Initial turbulence length scale
      DOUBLE PRECISION :: ic_l_scale(dimension_ic)

! Initial macroscopic density of solids phases
      DOUBLE PRECISION :: ic_rop_s(dimension_ic, dim_m)

! Initial solids phase volume fraction
      DOUBLE PRECISION :: ic_ep_s (dimension_ic, dim_m)

! Initial gas phase temperature
      DOUBLE PRECISION :: ic_t_g(dimension_ic)

! Initial solids phase temperature
      DOUBLE PRECISION :: ic_t_s(dimension_ic, dim_m)

! Initial granular temperature
      DOUBLE PRECISION :: ic_theta_m(dimension_ic, dim_m)

! Initial x-component of gas velocity
      DOUBLE PRECISION :: ic_u_g(dimension_ic)

! Initial x-component of solids phase velocity
      DOUBLE PRECISION :: ic_u_s(dimension_ic, dim_m)

! Initial y-component of gas velocity
      DOUBLE PRECISION :: ic_v_g(dimension_ic)

! Initial y-component of solids phase velocity
      DOUBLE PRECISION :: ic_v_s(dimension_ic, dim_m)

! Initial z-component of gas velocity
      DOUBLE PRECISION :: ic_w_g(dimension_ic)

! Initial z-component of solids phase velocity
      DOUBLE PRECISION :: ic_w_s(dimension_ic, dim_m)

! Logical variable to determine whether an ic is defined
      LOGICAL :: ic_defined (dimension_ic)

! Initial gas species mass fractions
      DOUBLE PRECISION :: ic_x_g(dimension_ic, dim_n_g)

! Initial solids species mass fractions
      DOUBLE PRECISION :: ic_x_s(dimension_ic, dim_m, dim_n_s)

! Gas phase radiation coefficient
      DOUBLE PRECISION :: ic_gama_rg (dimension_ic)

! Gas phase radiation temperature
      DOUBLE PRECISION :: ic_t_rg(dimension_ic)

! Solids phase-1 radiation coefficient
      DOUBLE PRECISION :: ic_gama_rs(dimension_ic, dim_m)

! Solids phase-1 radiation temperature
      DOUBLE PRECISION :: ic_t_rs(dimension_ic, dim_m)

! Initial scalar value in a region
      DOUBLE PRECISION :: ic_scalar(dimension_ic, dim_scalar)

! Initial K & Epsilon values in a region
      DOUBLE PRECISION :: ic_k_turb_g(dimension_ic)
      DOUBLE PRECISION :: ic_e_turb_g(dimension_ic)

! Initial conditions for DES cases (such as, DEM, MPPIC, hybrid)

! Flag to extend the lattice distribution in a given IC to available area
      LOGICAL :: ic_des_fit_to_region (dimension_ic)

! Flag to specify the initial constant number of particles per cell
! for the MPPIC method initialization.
! Statistical weight of parcels will be calculated by the code
      INTEGER :: ic_pic_const_npc(dimension_ic, dim_m)

! Flag to specify the initial constant statistical weight.
! for the MPPIC method initialization.
! Number of computational particles/parcels will be calculated by the code
      DOUBLE PRECISION :: ic_pic_const_statwt(dimension_ic, dim_m)


      END MODULE ic