mms_mod.f

Go to the documentation of this file.

!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv!
!                                                                      !
!  Module name: MMS_SRC                                                !
!  Purpose: Global storage containers for MMS variables.               !
!                                                                      !
!  Author: Aniruddha Choudhary                        Date: 17-Oct-11  !
!  email: anirudd@vt.edu                                               !
!                                                                      !
!  Reviewer: J.Musser                                 Date: 04-Dec-13  !
!                                                                      !
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^!
      MODULE mms

! By default the MMS functions are unavailable.
      LOGICAL :: use_mms = .false.

!! Method of Manufactured Solutions (MMS) and Tecplot variables :

! Gas volume fraction
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_ep_g

! Gas pressure
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_p_g

! Gas velocity components
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_u_g
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_v_g
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_w_g

! Gas temperature
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_t_g

! Solid bulk density
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_rop_s

! Solids velocity components
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_u_s
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_v_s
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_w_s

! Solids temperature
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_t_s

! Granular temperature
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_theta_m

! Gas continuity MMS source term
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_rop_g_src

! Gas Momentum source terms
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_u_g_src
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_v_g_src
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_w_g_src

! Gas energy equation MMS source term
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_t_g_src

! Solid continuity MMS source term
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_rop_s_src

! Solid momentum MMS source terms
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_u_s_src
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_v_s_src
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_w_s_src

! Solid energy equation MMS source term
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_t_s_src

! Granular energy MMS source term
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  mms_theta_m_src

! Temporary variable for pressure shifting while plotting and
! discretization error norm calculation
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  p_g_sh

! Index for pressure shifting
      INTEGER :: ijk_sh

!  x, y, z locations of top-right corner of a cell
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  xtr
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  ytr
      DOUBLE PRECISION, DIMENSION(:), ALLOCATABLE ::  ztr

      contains



!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv!
!                                                                      !
!  Module name: ALLOCATE_MMS_VARS                                      !
!  Purpose: Allocate memory for allocatable variables defined inside   !
!  MMS module.                                                         !
!                                                                      !
!  Author: Aniruddha Choudhary                        Date: Feb 2015   !
!                                                                      !
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^!
      SUBROUTINE allocate_mms_vars
      use param, only   : dimension_3

      IMPLICIT NONE

! Note: both fluid and solid phase variables can be of size DIMENSION_3
! since MMS tests do not work for more than one solid phase.

        allocate(mms_ep_g(dimension_3))
        allocate(mms_p_g(dimension_3))
        allocate(mms_u_g(dimension_3))
        allocate(mms_v_g(dimension_3))
        allocate(mms_w_g(dimension_3))
        allocate(mms_t_g(dimension_3))

        allocate(mms_rop_s(dimension_3))
        allocate(mms_u_s(dimension_3))
        allocate(mms_v_s(dimension_3))
        allocate(mms_w_s(dimension_3))
        allocate(mms_t_s(dimension_3))
        allocate(mms_theta_m(dimension_3))

        allocate(mms_rop_g_src(dimension_3))
        allocate(mms_u_g_src(dimension_3))
        allocate(mms_v_g_src(dimension_3))
        allocate(mms_w_g_src(dimension_3))
        allocate(mms_t_g_src(dimension_3))

        allocate(mms_rop_s_src(dimension_3))
        allocate(mms_u_s_src(dimension_3))
        allocate(mms_v_s_src(dimension_3))
        allocate(mms_w_s_src(dimension_3))
        allocate(mms_t_s_src(dimension_3))
        allocate(mms_theta_m_src(dimension_3))

        allocate(p_g_sh(dimension_3))

        allocate(xtr(dimension_3))
        allocate(ytr(dimension_3))
        allocate(ztr(dimension_3))


      RETURN
      END SUBROUTINE allocate_mms_vars


!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv!
!                                                                      !
!  Module name: DEALLOCATE_MMS_VARS                                    !
!  Purpose: Deallocate memory for allocatable variables defined inside !
!  MMS module.                                                         !
!                                                                      !
!  Author: Aniruddha Choudhary                        Date: Feb 2015   !
!                                                                      !
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^!
      SUBROUTINE deallocate_mms_vars

      IMPLICIT NONE


        deallocate(mms_ep_g)
        deallocate(mms_p_g)
        deallocate(mms_u_g)
        deallocate(mms_v_g)
        deallocate(mms_w_g)
        deallocate(mms_t_g)

        deallocate(mms_rop_s)
        deallocate(mms_u_s)
        deallocate(mms_v_s)
        deallocate(mms_w_s)
        deallocate(mms_t_s)
        deallocate(mms_theta_m)

        deallocate(mms_rop_g_src)
        deallocate(mms_u_g_src)
        deallocate(mms_v_g_src)
        deallocate(mms_w_g_src)
        deallocate(mms_t_g_src)

        deallocate(mms_rop_s_src)
        deallocate(mms_u_s_src)
        deallocate(mms_v_s_src)
        deallocate(mms_w_s_src)
        deallocate(mms_t_s_src)
        deallocate(mms_theta_m_src)

        deallocate(p_g_sh)

        deallocate(xtr)
        deallocate(ytr)
        deallocate(ztr)

      RETURN
      END SUBROUTINE deallocate_mms_vars

!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv!
!                                                                      !
!  Module name:CALCULATE_MMS                                           !
!  Purpose: Generic stub/placeholder for MMS analytical solutions.     !
!                                                                      !
!  Author: J.Musser                                   Date: 04-Dec-13  !
!                                                                      !
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^!
      SUBROUTINE calculate_mms

      IMPLICIT NONE

      RETURN
      END SUBROUTINE calculate_mms

!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv!
!                                                                      !
!  Module name:CALCULATE_MMS_SOURCE                                    !
!  Purpose: Generic stub/placeholder for MMS source terms.             !
!                                                                      !
!  Author: J.Musser                                   Date: 04-Dec-13  !
!                                                                      !
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^!
      SUBROUTINE calculate_mms_source

      IMPLICIT NONE

      RETURN
      End SUBROUTINE calculate_mms_source

      END MODULE mms