run_mod.f

Go to the documentation of this file.

! -*- f90 -*-
!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvC
!                                                                      C
!  Module name: run                                                    C
!  Purpose: Common block containing run control data                   C
!                                                                      C
!  Author: M. Syamlal                                 Date: dd-mmm-yy  C
!  Reviewer:                                          Date: dd-mmm-yy  C
!                                                                      C
!                                                                      C
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^C

      MODULE run

! Modules
!---------------------------------------------------------------------//
      use param, only: dim_m, dim_eqs
      use param1, only: undefined_i
      use derived_types
!---------------------------------------------------------------------//

! Main filename to be used for output files  Name must
! still be legal after extensions are added to it.
      CHARACTER(LEN=60) :: run_name

! Brief description of the problem.
      CHARACTER(LEN=60) :: description

! Units for data input and output: CGS.
      CHARACTER(LEN=16) :: units

! Type of run: NEW, RESTART
      CHARACTER(LEN=16) :: run_type

! Variable which triggers automatic restart
      LOGICAL :: automatic_restart

! counter to keep track of how many auto_retart were performed
      INTEGER :: iter_restart

! version.release of software
      CHARACTER(LEN=10) :: id_version

! Start-time of the run.
      DOUBLE PRECISION :: time

! Stop-time of the run.
      DOUBLE PRECISION :: tstop

! Time step.
      DOUBLE PRECISION :: dt

! 1./Time step.
      DOUBLE PRECISION :: odt

! Indicates whether simulation is steady-state
      LOGICAL :: steady_state

! Number of times steps completed.
      INTEGER :: nstep

! Declare a new variable to use on CN with RESTART cases
! Number of time steps when restart file was read
      INTEGER :: nsteprst

! Discretization scheme for different equations
      INTEGER :: discretize(dim_eqs)

! Use Chi scheme for discretizing certain equation sets
!  (species mass fractions)
      LOGICAL :: chi_scheme

! If .TRUE. solve X momentum equations
      LOGICAL :: momentum_x_eq(0:dim_m)

! If .TRUE. solve Y momentum equations
      LOGICAL :: momentum_y_eq(0:dim_m)

! If .TRUE. solve Z momentum equations
      LOGICAL :: momentum_z_eq(0:dim_m)

! IF .TRUE. use Jackson form momentum equations
      LOGICAL :: jackson
! IF .TRUE. use Ishii form momentum equations
      LOGICAL :: ishii

! If .TRUE. use Model-B momentum equations
      LOGICAL :: model_b

! If .TRUE. include added (virtual) mass in momentum eq.
      LOGICAL :: added_mass

! phase number where added mass is applied.
      INTEGER :: m_am

! If .TRUE. solve K_Epsilon turbulence eq.
      LOGICAL :: k_epsilon

! If .TRUE. solve energy equations
      LOGICAL :: energy_eq

! If .TRUE. use the deferred correction method
      LOGICAL :: def_cor

! If .TRUE. use the fourth order interpolation
      LOGICAL :: fpfoi

! If .TRUE. activate 2nd order accurate time implementation
      LOGICAL :: cn_on

! If .TRUE. solve granular energy equations
      LOGICAL :: granular_energy

! If .TRUE. solve species balance equations
      LOGICAL :: species_eq(0:dim_m)

! If .TRUE. one of the species equations is being solved
      LOGICAL :: any_species_eq

! If .TRUE. call user-defined subroutines
      LOGICAL :: call_usr

! If .TRUE. force time-step when NIT=MAX_NIT and DT=DT_MIN
      LOGICAL :: persistent_mode

! If .TRUE. solve population balance  equations
      LOGICAL :: call_dqmom

! If .TRUE. incorporate the wall effects upon the calculation of the
! subgrid solids viscosity, solids pressure, and gas-solids drag
      LOGICAL :: subgrid_wall
! the ratio of the FilterSize to the GridSize
      DOUBLE PRECISION :: filter_size_ratio

! Single particle drag correlation
      CHARACTER(64) :: cd_function

! Parameter used to calculate lubrication interactions between
! different particles in HYS drag model
      DOUBLE PRECISION :: lam_hys

! If .TRUE. use Simonin model (k_epsilon must also be true)
      LOGICAL :: simonin

! If .TRUE. use Ahmadi model (k_epsilon must also be true)
      LOGICAL :: ahmadi

! If .TRUE. calculate frictional stress terms
      LOGICAL :: friction
! Form of friction model:
!             If 0: use S:S
!             If 1: use the form of Savage to compute S:S
!             If 2: use combination of both for frictional stress terms
      INTEGER :: savage

! If .TRUE. use Scheffer frictional stress (default set to .TRUE.)
      LOGICAL :: schaeffer

! If .TRUE. use blending frictional/kinetic stresses
! (default set to .FALSE. do not blend)
      LOGICAL :: blending_stress
      LOGICAL :: tanh_blend ! default set to true
      LOGICAL :: sigm_blend ! default set to false

! If .TRUE. use Jenkins small friction BC
      LOGICAL :: jenkins
! If .TRUE. use revised phip for JJ BC
      LOGICAL :: bc_jj_m
! If .TRUE. output PHIP to JJ_PHIP.dat
      LOGICAL :: phip_out_jj
! to write specularity
      INTEGER :: phip_out_iter

! If .TRUE. treat system as if shearing
      LOGICAL :: shear
! Shear Vel
      DOUBLE PRECISION :: v_sh

! If .TRUE. use Yu and Standish correlation to compute ep_star
      LOGICAL :: yu_standish

! If .TRUE. use Fedors and Landel correlation to compute ep_star
      LOGICAL :: fedors_landel

! STOP Trigger mechanism to terminate MFIX normally before batch
! queue terminates flag variable to check for end of batch queue when
! set to TRUE check performed at the beginning of each time step and
! termination of mfix triggered after saving all files if condition
! is met
      LOGICAL :: chk_batchq_end
! variable to store the total wall clock duration of the batch queue
! session wall clock time specified in seconds
! for jaguarcnl@NCCS max wall clock limit is 2.5 hr limit up to 512
! processors
      DOUBLE PRECISION :: batch_wallclock
! variable to set a buffer time before the batch queue session ends to
! make sure once MFIX is triggered to shutdown, there is sufficient
! time to save files, make copies to HPSS storage before batch queue
! time runs out. Current logic in MFIX checks for:
!    if CPU_TIME > (BATCH_WALLCLOCK - TERM_BUFFER) then
!    save all .RES .SP files and trigger shutdown
      DOUBLE PRECISION :: term_buffer

! If .TRUE. code will automatically restart for DT < DT_MIN
      LOGICAL :: auto_restart

! If .TRUE. code will automatically restart for DT < DT_MIN
      LOGICAL :: reinitializing = .false.

! Time-step failure rate:
! 1) Number of failed time steps
! 2) Observation window
      INTEGER :: timestep_fail_rate(2)

! parameters for dynamically adjusting time step
! +1 -> increase dt; -1 decrease dt
      INTEGER :: dt_dir = -1

! Maximum Time step.
      DOUBLE PRECISION :: dt_max

! Minimum Time step.
      DOUBLE PRECISION :: dt_min

! Time step adjustment factor (<1.0)
      DOUBLE PRECISION :: dt_fac

! The previous time step used in iterate (before it is
! changed by adjust_dt)
      DOUBLE PRECISION :: dt_prev

! in case iterations converged and DT modified, use old dt
! to advance time in time_march.
      LOGICAL :: use_dt_prev

! Slope limiter parameter (0 < C _FAC <= 1.0)
      DOUBLE PRECISION :: c_fac

! If .TRUE. reduce time step when residuals do not decrease
      LOGICAL :: detect_stall

! String which controls reduction of global sums for residual
! calculations
      LOGICAL :: debug_resid

       common /run_dp/ time      !for Linux


! Flags indicating variable solids density.
      LOGICAL :: solve_ros(dim_m), any_solve_ros

! Specifies the type of solids: TFM, DEM, MPPIC
      CHARACTER(len=3), DIMENSION(DIM_M) :: solids_model

! Flags for various solids phase models.
      LOGICAL :: tfm_solids
      LOGICAL :: dem_solids
      LOGICAL :: pic_solids
! The number of the various solids phases.
      INTEGER :: tfm_count = 0
      INTEGER :: dem_count = 0
      INTEGER :: pic_count = 0

      ! Error index
      INTEGER :: ier

      ! CPU time unit.
      CHARACTER(LEN=4) :: tunit

      CONTAINS

         !vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvC
         !  Purpose:  Given time in seconds, calculate time in days/hours/seconds
         !
         !^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^C
         SUBROUTINE get_tunit(TLEFT, TUNIT)

            !-----------------------------------------------
            ! Modules
            !-----------------------------------------------
            IMPLICIT NONE
            !-----------------------------------------------
            ! Dummy arguments
            !-----------------------------------------------
            DOUBLE PRECISION, INTENT(INOUT) :: TLEFT
            CHARACTER(LEN=4) :: TUNIT
            !-----------------------------------------------

            IF (tleft < 3600.0d0) THEN
               tunit = 's'
            ELSE
               tleft = tleft/3600.0d0
               tunit = 'h'
               IF (tleft >= 24.) THEN
                  tleft = tleft/24.0d0
                  tunit = 'days'
               ENDIF
            ENDIF

            RETURN
         END SUBROUTINE get_tunit

      END MODULE run