allocate_arrays.f

Go to the documentation of this file.

! -*- f90 -*-
!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvC
!                                                                      C
!  Subroutinee: ALLOCATE_ARRAYS                                        C
!  Purpose: allocate arrays                                            C
!                                                                      C
!  Author: M. Syamlal                                Date: 17-DEC-98   C
!  Reviewer:                                                           C
!                                                                      C
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^C

      SUBROUTINE allocate_arrays

!-----------------------------------------------
! Modules
!-----------------------------------------------
      use ambm
      use cdist
      use cont
      use des_rxns
      use drag
      use energy
      use fldvar
      use generate_particles, only: particle_count
      use geometry
      use ghdtheory
      use indices
      use kintheory
      use mflux
      use param
      use param1
      use pgcor
      use physprop
      use pscor
      use residual
      use run
      use rxns
      use scalars
      use iterate, only: errorpercent
      use tau_g
      use tau_s
      use trace
      use turb
      use visc_g
      use visc_s
      use vshear

      IMPLICIT NONE

!-----------------------------------------------
! Variables
!-----------------------------------------------

!ambm
      Allocate( a_m(dimension_3, -3:3, 0:dimension_m) )
      Allocate( b_m(dimension_3, 0:dimension_m) )

!cont
      Allocate( do_cont(0:dimension_m) )

!drag
      Allocate(  f_gs(dimension_3, dimension_m) )
      Allocate(  f_ss(dimension_3, 0:dimension_lm) )

!Off diagonal friction coefficient in HYS drag relation
      IF(drag_type_enum.EQ.hys) &
         Allocate(  beta_ij(dimension_3, 0:dimension_m, 0:dimension_m) )

!energy
      Allocate(  hor_g(dimension_3) )
      Allocate(  hor_s(dimension_3, dimension_m) )
      Allocate(  gama_gs(dimension_3, dimension_m) )
      Allocate(  gama_rg(dimension_3) )
      Allocate(  gama_rs(dimension_3, dimension_m) )
      Allocate(  t_rg(dimension_3) )
      Allocate(  t_rs(dimension_3, dimension_m) )

!fldvar
      Allocate(  ep_g(dimension_3) )
      Allocate(  epg_jfac(dimension_3p) )
      Allocate(  epg_ifac(dimension_3p) )
      Allocate(  eps_ifac(dimension_3p, dimension_m) )
      Allocate(  ep_go(dimension_3p) )
      Allocate(  p_g(dimension_3) )
      Allocate(  p_go(dimension_3p) )
      Allocate(  ro_g(dimension_3) )
      Allocate(  ro_go(dimension_3p) )
      Allocate(  rop_g(dimension_3) )
      Allocate(  rop_go(dimension_3p) )
      Allocate(  ro_s(dimension_3, dimension_m) )
      Allocate(  ro_so(dimension_3p, dimension_m) )
      Allocate(  rop_s(dimension_3, dimension_m) )
      Allocate(  rop_so(dimension_3p, dimension_m) )

      Allocate(  ep_ss(dimension_3,dimension_m,dimension_n_s) )
      Allocate(  err_array(dimension_3,dimension_m) )

      Allocate(  t_g(dimension_3) )
      Allocate(  t_s(dimension_3, dimension_m) )
      Allocate(  t_go(dimension_3p) )
      Allocate(  t_so(dimension_3p, dimension_m) )
      Allocate(  x_g(dimension_3, dimension_n_g) )
      Allocate(  x_s(dimension_3, dimension_m, dimension_n_s) )
      Allocate(  x_go(dimension_3p, dimension_n_g) )
      Allocate(  x_so(dimension_3p, dimension_m, dimension_n_s) )
      Allocate(  u_g(dimension_3) )
      Allocate(  u_go(dimension_3p) )
      Allocate(  u_s(dimension_3, dimension_m) )
      Allocate(  u_so(dimension_3p, dimension_m) )
      Allocate(  v_g(dimension_3) )
      Allocate(  v_go(dimension_3p) )
      Allocate(  v_s(dimension_3, dimension_m) )
      Allocate(  v_so(dimension_3p, dimension_m) )
      Allocate(  w_g(dimension_3) )
      Allocate(  w_go(dimension_3p) )
      Allocate(  w_s(dimension_3, dimension_m) )
      Allocate(  w_so(dimension_3p, dimension_m) )
      Allocate(  p_s(dimension_3, dimension_m) )
      Allocate(  p_s_c(dimension_3, dimension_m) )
      Allocate(  p_s_v(dimension_3) )
      Allocate(  p_s_f(dimension_3) )
      Allocate(  p_s_p(dimension_3) )
      Allocate(  p_star(dimension_3) )
      Allocate(  p_staro(dimension_3p) )
      Allocate(  theta_m(dimension_3, dimension_m) )
      Allocate(  theta_mo(dimension_3p, dimension_m) )

      IF(k_epsilon)THEN
        Allocate(  k_turb_g(dimension_3) )
        Allocate(  k_turb_go(dimension_3p) )
        Allocate(  e_turb_g(dimension_3) )
        Allocate(  e_turb_go(dimension_3p) )
      ENDIF

      IF(dimension_scalar /= 0) THEN
        Allocate(  scalar(dimension_3,  dimension_scalar) )
        Allocate(  scalaro(dimension_3p, dimension_scalar) )
      ENDIF


!pgcor
      Allocate(  d_e(dimension_3p, 0:dimension_m) )
      Allocate(  d_n(dimension_3p, 0:dimension_m) )
      Allocate(  d_t(dimension_3p, 0:dimension_m) )
      Allocate(  pp_g(dimension_3p) )
      Allocate(  phase_4_p_g(dimension_3p) )

!physprop
      Allocate(  mu_g(dimension_3) )
      Allocate(  c_pg(dimension_3) )
      Allocate(  c_ps(dimension_3, dimension_m) )
      Allocate(  k_g(dimension_3) )
      Allocate(  k_s(dimension_3, dimension_m) )
      Allocate(  kth_s(dimension_3, dimension_m) )
      Allocate(  kphi_s(dimension_3, dimension_m) )
      Allocate(  dif_g(dimension_3p, dimension_n_g) )
      Allocate(  dif_s(dimension_3p, dimension_m, dimension_n_s) )
      Allocate(  mw_mix_g(dimension_3) )

!pscor
      Allocate(  e_e(dimension_3p) )
      Allocate(  e_n(dimension_3p) )
      Allocate(  e_t(dimension_3p) )
      Allocate(  k_cp(dimension_3p) )
      Allocate(  epp(dimension_3p) )
      Allocate(  phase_4_p_s(dimension_3p) )

!residual
      Allocate( resid(nresid, 0:dimension_m) )
      Allocate( max_resid(nresid, 0:dimension_m) )
      Allocate( ijk_resid(nresid, 0:dimension_m) )
      Allocate( num_resid(nresid, 0:dimension_m) )
      Allocate( den_resid(nresid, 0:dimension_m) )
      Allocate( resid_pack(nresid*2*(dimension_m+1)))

!rxns
      if (nrr .gt. 0) Allocate( reactionrates(dimension_3,nrr) )
      Allocate(  r_gp(dimension_3p, dimension_n_g) )
      Allocate(  r_sp(dimension_3p, dimension_m, dimension_n_s) )
      Allocate(  rox_gc(dimension_3p, dimension_n_g) )
      Allocate(  rox_sc(dimension_3p, dimension_m, dimension_n_s) )
      Allocate(  sum_r_g(dimension_3p) )
      Allocate(  sum_r_s(dimension_3p, dimension_m) )
      Allocate(  r_phase(dimension_3, dimension_lm+dimension_m-1) )

!scalars
      IF(dimension_scalar /= 0) then
        Allocate(  scalar_c(dimension_3p,  dimension_scalar) )
        Allocate(  scalar_p(dimension_3p,  dimension_scalar) )
        Allocate(  dif_scalar(dimension_3p, dimension_scalar) )
      ENDIF

! add by rong for dqmom
      Allocate(  d_p(dimension_3, dimension_m) )
      Allocate(  d_po(dimension_3, dimension_m) )
!      Allocate(  ome  (DIMENSION_3, DIMENSION_M) )
!      Allocate(  ome_o (DIMENSION_3, DIMENSION_M) )
      Allocate(  source_a(dimension_3, dimension_m) )
      Allocate(  s_bar( 0:dim_scalar2-1 ))
      Allocate(  matrix_a(dim_scalar2,dim_scalar2))
      Allocate(  matrix_b(dim_scalar2,dim_scalar2))
      Allocate(  matrix_c(dim_scalar2,dim_scalar2))
      Allocate(  inv_a(dim_scalar2,dim_scalar2))
      Allocate(  a( 1:dimension_scalar))
      Allocate(  omega(1:dimension_m))
      ALLocate(  beta_a( dim_scalar,dim_scalar))
      ALLocate(  ystart( 1:dim_scalar2))
!     ALLocate(  g_a( 1:DIMENSION_Scalar))

! K-Epsilon Turbulence model
      IF(k_epsilon) THEN
        Allocate(  k_turb_g_c  (dimension_3p) )
        Allocate(  k_turb_g_p  (dimension_3p) )
        Allocate(  dif_k_turb_g(dimension_3p) )
        Allocate(  e_turb_g_c  (dimension_3p) )
        Allocate(  e_turb_g_p  (dimension_3p) )
        Allocate(  dif_e_turb_g(dimension_3p) )
      ENDIF

! Simonin or Ahmadi model
      IF(kt_type_enum==simonin_1996 .OR.&
         kt_type_enum==ahmadi_1995) THEN
        Allocate(  k_12(dimension_3) )
        Allocate(  tau_12(dimension_3) )
        Allocate(  tau_1(dimension_3) )
      ENDIF

!tau_g
      Allocate(  tau_u_g(dimension_3p) )
      Allocate(  tau_v_g(dimension_3p) )
      Allocate(  tau_w_g(dimension_3p) )
      Allocate(  df_gu(dimension_3p, -3:3) )
      Allocate(  df_gv(dimension_3p, -3:3) )
      Allocate(  df_gw(dimension_3p, -3:3) )
      Allocate(  ctau_u_g(dimension_3p))
      Allocate(  ctau_v_g(dimension_3p))
      Allocate(  ctau_w_g(dimension_3p))

!tau_s
      Allocate(  tau_u_s(dimension_3p, dimension_m) )
      Allocate(  tau_v_s(dimension_3p, dimension_m) )
      Allocate(  tau_w_s(dimension_3p, dimension_m) )

! generate_particles / particle_count
      Allocate(  particle_count(dimension_3) )

!trace
      Allocate(  trd_s_c(dimension_3, dimension_m) )
      Allocate(  trd_s2(dimension_3, dimension_m) )
      Allocate(  trd_s_co(dimension_3, dimension_m) )
      Allocate(  trd_s_co2(dimension_3, dimension_m) )
!visc_g
      Allocate(  trd_g(dimension_3) )
      Allocate(  mu_gt(dimension_3) )
      Allocate(  epmu_gt(dimension_3p) )
      Allocate(  lambda_gt(dimension_3p) )
      Allocate(  eplambda_gt(dimension_3) )
      Allocate(  l_scale(dimension_3) )

!visc_s
      Allocate(  mu_s(dimension_3, dimension_m) )
      Allocate(  epmu_s(dimension_3p, dimension_m) )
      Allocate(  lambda_s(dimension_3, dimension_m) )
      Allocate(  eplambda_s(dimension_3p, dimension_m) )
      Allocate(  alpha_s(dimension_3, dimension_m) )
      Allocate(  mu_s_c(dimension_3, dimension_m) )
      Allocate(  lambda_s_c(dimension_3, dimension_m) )
      Allocate(  lambda_s_v(dimension_3) )
      Allocate(  lambda_s_f(dimension_3) )
      Allocate(  lambda_s_p(dimension_3) )
      Allocate(  mu_s_v(dimension_3) )
      Allocate(  mu_s_f(dimension_3) )
      Allocate(  mu_s_p(dimension_3) )
      Allocate(  mu_b_v(dimension_3) )
      Allocate(  ep_star_array(dimension_3) )
      Allocate(  ep_g_blend_start(dimension_3) )
      Allocate(  ep_g_blend_end(dimension_3) )
      Allocate(  trd_s(dimension_3, dimension_m) )
      Allocate(  i2_devd_s(dimension_3) )
      Allocate(  trm_s(dimension_3) )
      Allocate(  trdm_s(dimension_3) )

!shear quantities
      Allocate(  vsh(dimension_3) )
      Allocate(  vshe(dimension_3) )

!mflux
      Allocate( flux_ge(dimension_3p) )
      Allocate( flux_se(dimension_3p, dimension_m) )
      Allocate( flux_gn(dimension_3p) )
      Allocate( flux_sn(dimension_3p, dimension_m) )
      Allocate( flux_gt(dimension_3p) )
      Allocate( flux_st(dimension_3p, dimension_m) )
      IF(added_mass) THEN ! Fluxes calculated for just one 'bubble' species (M=M_AM)
         Allocate( flux_gse(dimension_3p) )
         Allocate( flux_sse(dimension_3p) )
         Allocate( flux_gsn(dimension_3p) )
         Allocate( flux_ssn(dimension_3p) )
         Allocate( flux_gst(dimension_3p) )
         Allocate( flux_sst(dimension_3p) )
      ENDIF
      Allocate( rop_ge(dimension_3p) )
      Allocate( rop_se(dimension_3p, dimension_m) )
      Allocate( rop_gn(dimension_3p) )
      Allocate( rop_sn(dimension_3p, dimension_m) )
      Allocate( rop_gt(dimension_3p) )
      Allocate( rop_st(dimension_3p, dimension_m) )

! allocate variables for GHD Theory
      IF (kt_type_enum == ghd_2007) THEN
        Allocate(  flux_ne(dimension_3p) )
        Allocate(  flux_nn(dimension_3p) )
        Allocate(  flux_nt(dimension_3p) )
        Allocate(  zeta0(dimension_3p) )   ! zeroth rate of cooling
        Allocate(  zetau(dimension_3p) )   ! 1st order cooling rate transport coefficient
        Allocate(  dit(dimension_3p, dimension_m) )   ! thermal diffusivity
        Allocate(  dijf(dimension_3p, dimension_m, dimension_m) )   ! mass mobility
        Allocate(  lij(dimension_3p, dimension_m, dimension_m) )   ! thermal mobility
        Allocate(  dij(dimension_3p, dimension_m, dimension_m) )   ! ordinary diffusion
        Allocate(  dijq(dimension_3p, dimension_m, dimension_m) )   ! Dufour coeff.
        Allocate(  joix(dimension_3p, dimension_m) )   ! X- species mass flux
        Allocate(  joiy(dimension_3p, dimension_m) )   ! Y- species mass flux
        Allocate(  joiz(dimension_3p, dimension_m) )   ! Z- species mass flux
        Allocate(  fix(dimension_3p, dimension_m) )   ! X- external force
        Allocate(  fiy(dimension_3p, dimension_m) )   ! Y- external force
        Allocate(  fiz(dimension_3p, dimension_m) )   ! Z- external force
        Allocate(  fixvel(dimension_3p, dimension_m) )   ! X- external force
        Allocate(  fiyvel(dimension_3p, dimension_m) )   ! Y- external force
        Allocate(  fizvel(dimension_3p, dimension_m) )   ! Z- external force
        Allocate(  deltau(dimension_3p, dimension_m) )
        Allocate(  deltav(dimension_3p, dimension_m) )
        Allocate(  deltaw(dimension_3p, dimension_m) )
        Allocate(  dragfx(dimension_3p, dimension_m) )   ! X- drag force
        Allocate(  dragfy(dimension_3p, dimension_m) )   ! Y- drag force
        Allocate(  dragfz(dimension_3p, dimension_m) )   ! Z- drag force
        Allocate(  dragfxflux(dimension_3p, dimension_m) )   ! X- drag force
        Allocate(  dragfyflux(dimension_3p, dimension_m) )   ! Y- drag force
        Allocate(  dragfzflux(dimension_3p, dimension_m) )   ! Z- drag force
        Allocate(  fiminusdragx(dimension_3p, dimension_m) )   ! X- drag force
        Allocate(  joiminusdragx(dimension_3p, dimension_m) )   ! X- drag force
        Allocate(  fiminusdragy(dimension_3p, dimension_m) )   ! Y- drag force
        Allocate(  joiminusdragy(dimension_3p, dimension_m) )   ! Y- drag force
        Allocate(  fiminusdragz(dimension_3p, dimension_m) )   ! Z- drag force
        Allocate(  joiminusdragz(dimension_3p, dimension_m) )   ! Z- drag force
        Allocate(  beta_cell_x(dimension_3p, dimension_m) )   ! X- drag force
        Allocate(  beta_cell_y(dimension_3p, dimension_m) )   ! Y- drag force
        Allocate(  beta_cell_z(dimension_3p, dimension_m) )   ! Y- drag force
        Allocate(  beta_ij_cell_x(dimension_3p, dimension_m,dimension_m) )   ! X- drag force
        Allocate(  beta_ij_cell_y(dimension_3p, dimension_m,dimension_m) )   ! Y- drag force
        Allocate(  beta_ij_cell_z(dimension_3p, dimension_m,dimension_m) )   ! Y- drag force
        Allocate(  del_dot_j(dimension_3p, dimension_m) )
        Allocate(  dit_harme(dimension_3p) )
        Allocate(  dit_harmn(dimension_3p) )
        Allocate(  dit_harmt(dimension_3p) )
        Allocate(  dij_harme(dimension_3p, dimension_m) )
        Allocate(  dij_harmn(dimension_3p, dimension_m) )
        Allocate(  dij_harmt(dimension_3p, dimension_m) )
        Allocate(  dijf_harme(dimension_3p, dimension_m) )
        Allocate(  dijf_harmn(dimension_3p, dimension_m) )
        Allocate(  dijf_harmt(dimension_3p, dimension_m) )
      ENDIF


! We need to set this even when KT_TYPE is not set to IA_NONEP - at
! least in the current version of the code and needs to be revisited
      Allocate(  ktmom_u_s(dimension_3p, dimension_m) )
      Allocate(  ktmom_v_s(dimension_3p, dimension_m) )
      Allocate(  ktmom_w_s(dimension_3p, dimension_m) )

! allocate variables for Iddir & Arastoopour (2005) kinetic theory
! EDvel_sM_ip & EDT_s_ip are also used for Garzy & Dufty (1999) kinetic theory
      IF (kt_type_enum == ia_2005) THEN
         Allocate(  trd_s2_ip(dimension_3, dimension_m, dimension_m) )
         Allocate(  mu_sm_ip(dimension_3, dimension_m, dimension_m) )
         Allocate(  mu_sl_ip(dimension_3, dimension_m, dimension_m) )
         Allocate(  xi_sm_ip(dimension_3, dimension_m, dimension_m) )
         Allocate(  xi_sl_ip(dimension_3, dimension_m, dimension_m) )
         Allocate(  fnu_s_ip(dimension_3p, dimension_m, dimension_m) )
         Allocate(  ft_sm_ip(dimension_3p, dimension_m, dimension_m) )
         Allocate(  ft_sl_ip(dimension_3p, dimension_m, dimension_m) )
         Allocate(  kth_sl_ip(dimension_3, dimension_m, dimension_m) )
         Allocate(  knu_sm_ip(dimension_3, dimension_m, dimension_m) )
         Allocate(  knu_sl_ip(dimension_3, dimension_m, dimension_m) )
         Allocate(  kvel_s_ip(dimension_3, dimension_m, dimension_m) )
         Allocate(  edvel_sl_ip(dimension_3p, dimension_m, dimension_m) )
         Allocate(  ed_ss_ip(dimension_3p, 0:dimension_lm) )
      ENDIF
      IF (kt_type_enum == gtsh_2012) THEN
         Allocate(  a2_gtsh(dimension_3) )
         Allocate(  xsi_gtsh(dimension_3) )
      ENDIF
      IF (kt_type_enum == ia_2005 .OR. &
          kt_type_enum == gd_1999 .OR. &
          kt_type_enum == gtsh_2012) THEN
         Allocate(  edt_s_ip(dimension_3p, dimension_m, dimension_m) )
         Allocate(  edvel_sm_ip(dimension_3p, dimension_m, dimension_m) )
      ENDIF

      Allocate(errorpercent(0:mmax))

      RETURN
      END SUBROUTINE allocate_arrays

!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv!
!                                                                      !
!  Module name: ALLOCATE_ARRAYS_GEOMETRY                               !
!  Author: M. Syamlal                                 Date: 21-JAN-92  !
!                                                                      !
!  Purpose: Calculate X, X_E,  oX, oX_E                                !
!                                                                      !
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^!
      SUBROUTINE allocate_arrays_geometry

! Global Variables:
!---------------------------------------------------------------------//
! Domain decomposition and dimensions
      use geometry, only: odx, odx_e
      use geometry, only: odz, odz_t
      use geometry, only: ody, ody_n
      use geometry, only: x, x_e, ox, ox_e, cyl_x, cyl_x_e
      use geometry, only: z, z_t
! Averaging factors.
      use geometry, only: fx_e, fx_e_bar, fx, fx_bar
      use geometry, only: fy_n, fy_n_bar
      use geometry, only: fz_t, fz_t_bar
! Domain flags.
      use geometry, only: icbc_flag
      use geometry, only: flag, flag3
      use geometry, only: flag_e, flag_n, flag_t
! Domain volumes and areas.
      use geometry, only: vol, vol_surr, ayz, axz, axy! Scalar grid
      use geometry, only: vol_u, ayz_u, axz_u, axy_u  ! X-Momentum
      use geometry, only: vol_v, ayz_v, axz_v, axy_v  ! Y-Momentum
      use geometry, only: vol_w, ayz_w, axz_w, axy_w  ! Z-Momentum
! Axis decomposition
      USE param, only: dimension_i, dimension_j, dimension_k
      USE param, only: dimension_3, dimension_4
      USE param, only: dimension_3l, dimension_3p
! Flag for POST_MFIX
      use cdist, only: bdoing_postmfix

! Module procedures
!---------------------------------------------------------------------//
      use mpi_utility, only: global_all_sum
      use error_manager

      IMPLICIT NONE

! Local Variables:
!---------------------------------------------------------------------//
! Error Flag
      INTEGER :: IER
! Flag indicating that the arrays were previously allocated.
      INTEGER, SAVE :: CALLED = -1
!......................................................................!

      called = called + 1

      IF(called > 0) THEN
         IF(.NOT.bdoing_postmfix) THEN
            RETURN
         ELSEIF(mod(called,2) /= 0) THEN
            RETURN
         ENDIF
      ENDIF

! Initialize the error manager.
      CALL init_err_msg("ALLOCATE_ARRAYS_GEOMETRY")

! Allocate geometry components related to the mesh. Check the
! allocation error status and abort if any failure is detected.
      ALLOCATE( x      (0:dimension_i), stat=ier)
      ALLOCATE( cyl_x      (0:dimension_i), stat=ier)
      ALLOCATE( x_e  (0:dimension_i), stat=ier)
      ALLOCATE( cyl_x_e  (0:dimension_i), stat=ier)
      ALLOCATE( ox    (0:dimension_i), stat=ier)
      ALLOCATE( ox_e(0:dimension_i), stat=ier)
      ALLOCATE( odx  (0:dimension_i), stat=ier)
      ALLOCATE( odx_e(0:dimension_i), stat=ier)
      IF(ier /= 0) goto 500

      ALLOCATE( ody  (0:dimension_j), stat=ier )
      ALLOCATE( ody_n(0:dimension_j), stat=ier )
      IF(ier /= 0) goto 500

      ALLOCATE( z      (0:dimension_k), stat=ier )
      ALLOCATE( z_t  (0:dimension_k), stat=ier )
      ALLOCATE( odz  (0:dimension_k), stat=ier )
      ALLOCATE( odz_t(0:dimension_k), stat=ier )
      IF(ier /= 0) goto 500

      ALLOCATE( fx      (0:dimension_i), stat=ier)
      ALLOCATE( fx_bar(0:dimension_i), stat=ier)
      IF(ier /= 0) goto 500

      ALLOCATE( fx_e      (0:dimension_i), stat=ier)
      ALLOCATE( fx_e_bar(0:dimension_i), stat=ier)
      IF(ier /= 0) goto 500

      ALLOCATE( fy_n      (0:dimension_j), stat=ier )
      ALLOCATE( fy_n_bar(0:dimension_j), stat=ier )
      IF(ier /= 0) goto 500

      ALLOCATE( fz_t      (0:dimension_k), stat=ier )
      ALLOCATE( fz_t_bar(0:dimension_k), stat=ier )
      IF(ier /= 0) goto 500

! Flags for the scalar grid.
      Allocate( flag(dimension_3), stat=ier )
      Allocate( flag3(dimension_4), stat=ier )
      IF(ier /= 0) goto 500

! Flags for the momentum grids.
      Allocate( flag_e(dimension_3), stat=ier )
      Allocate( flag_n(dimension_3), stat=ier )
      Allocate( flag_t(dimension_3), stat=ier )
      IF(ier /= 0) goto 500

! Text flags for scalar grid.
      Allocate( icbc_flag(dimension_3l), stat=ier )
      IF(ier /= 0) goto 500

! Volume and face-areas of scalar grid.
      Allocate( vol(dimension_3),  stat=ier )
      Allocate( ayz(dimension_3p), stat=ier )
      Allocate( axz(dimension_3p), stat=ier )
      Allocate( axy(dimension_3p), stat=ier )
      IF(ier /= 0) goto 500

      ! total volume of each cell's surrounding stencil cells
      Allocate( vol_surr(dimension_3), stat=ier )

! Volume and face-areas of X-Momentumn grid.
      Allocate( vol_u(dimension_3),  stat=ier )
      Allocate( ayz_u(dimension_3p), stat=ier )
      Allocate( axz_u(dimension_3p), stat=ier )
      Allocate( axy_u(dimension_3p), stat=ier )
      IF(ier /= 0) goto 500

! Volume and face-areas of Y-Momentum grid.
      Allocate( vol_v(dimension_3),  stat=ier )
      Allocate( ayz_v(dimension_3p), stat=ier )
      Allocate( axz_v(dimension_3p), stat=ier )
      Allocate( axy_v(dimension_3p), stat=ier )
      IF(ier /= 0) goto 500

! Volume and face-areas of Z-Momentum grid.
      Allocate( vol_w(dimension_3),  stat=ier )
      Allocate( ayz_w(dimension_3p), stat=ier )
      Allocate( axz_w(dimension_3p), stat=ier )
      Allocate( axy_w(dimension_3p), stat=ier )
      IF(ier /= 0) goto 500

! Collect the error flags from all ranks. If all allocaitons were
! successfull, do nothing. Otherwise, flag the error and abort.
! Note that the allocation status is checked in groups. This can
! be increase if tracking the source of an allocation failure.
  500 CALL global_all_sum(ier)

      IF(ier /= 0) THEN
         WRITE(err_msg,1100)
         CALL flush_err_msg(abort=.true.)
      ENDIF

 1100 FORMAT('Error 1100: Failure during array allocation.')

      CALL finl_err_msg

      RETURN
      END SUBROUTINE allocate_arrays_geometry


!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv!
!                                                                      !
!  Module name: ALLOCATE_ARRAYS_INCREMENTS                             !
!  Author: M. Syamlal, W. Rogers                      Date: 10-DEC-91  !
!                                                                      !
!  Purpose: The purpose of this module is to create increments to be   !
!           stored in the array STORE_INCREMENT which will be added    !
!           to cell index ijk to find the effective indices of its     !
!           neighbors. These increments are found using the 'class'    !
!           of cell ijk. The class is determined based on the          !
!           neighboring cell type, i.e. wall or fluid.                 !
!                                                                      !
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^!
      SUBROUTINE allocate_arrays_increments

      USE param
      USE param1
      USE indices
      USE geometry
      USE compar
      USE physprop
      USE fldvar
      USE funits

! Module procedures
!---------------------------------------------------------------------//
      use mpi_utility, only: global_all_sum
      use error_manager


      IMPLICIT NONE


! Local Variables:
!---------------------------------------------------------------------//
! Error flag.
      INTEGER :: IER
! Flag indicating that the arrays were previously allocated.
      LOGICAL, SAVE :: ALREADY_ALLOCATED = .false.
!......................................................................!

      IF(already_allocated) RETURN

! Initialize the error manager.
      CALL init_err_msg("ALLOCATE_ARRAYS_INCREMENTS")

! Allocate increment arrays and report an allocation errors.
      Allocate( i_of(dimension_3), stat=ier)
      Allocate( j_of(dimension_3), stat=ier)
      Allocate( k_of(dimension_3), stat=ier)
      IF(ier /= 0) goto 500

      Allocate( im1(0:dimension_i), stat=ier)
      Allocate( ip1(0:dimension_i), stat=ier)
      IF(ier /= 0) goto 500

      Allocate( jm1(0:dimension_j), stat=ier)
      Allocate( jp1(0:dimension_j), stat=ier)
      IF(ier /= 0) goto 500

      Allocate( km1(0:dimension_k), stat=ier)
      Allocate( kp1(0:dimension_k), stat=ier)
      IF(ier /= 0) goto 500

      Allocate( store_lm(dimension_m, dimension_m), stat=ier)
      Allocate( cell_class(dimension_3), stat=ier)
      IF(ier /= 0) goto 500


! Allocate increment arrays and report an allocation errors.
      Allocate( i3_of(dimension_4), stat=ier)
      Allocate( j3_of(dimension_4), stat=ier)
      Allocate( k3_of(dimension_4), stat=ier)
      IF(ier /= 0) goto 500

      Allocate( im1_3(-1:dimension_i+1), stat=ier)
      Allocate( ip1_3(-1:dimension_i+1), stat=ier)
      IF(ier /= 0) goto 500

      Allocate( jm1_3(-1:dimension_j+1), stat=ier)
      Allocate( jp1_3(-1:dimension_j+1), stat=ier)
      IF(ier /= 0) goto 500

      Allocate( km1_3(-1:dimension_k+1), stat=ier)
      Allocate( kp1_3(-1:dimension_k+1), stat=ier)
      IF(ier /= 0) goto 500

      Allocate( cell_class3(dimension_4), stat=ier)
      IF(ier /= 0) goto 500

! Collect the error flags from all ranks. If all allocaitons were
! successfull, do nothing. Otherwise, flag the error and abort.
! Note that the allocation status is checked in groups. This can
! be increase if tracking the source of an allocation failure.
  500 CALL global_all_sum(ier)

      IF(ier /= 0) THEN
         WRITE(err_msg,1100)
         CALL flush_err_msg(abort=.true.)
      ENDIF

 1100 FORMAT('Error 1100: Failure during array allocation.')

      already_allocated = .true.

      CALL finl_err_msg

      RETURN
      END SUBROUTINE allocate_arrays_increments