output_mod.f

Go to the documentation of this file.

!vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv!
!                                                                      !
!  Module: output                                                      !
!  Author: M. Syamlal                                 Date: dd-mmm-yy  !
!                                                                      !
!  Purpose: Contain data for output control.                           !
!                                                                      !
!^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^!
      MODULE output

      use param, only: dimension_usr
      use param1, only: n_spx

! Interval at which restart (.RES) file data is updated.
      DOUBLE PRECISION :: res_dt
! Interval to create a backup copy of the RES file.
      DOUBLE PRECISION :: res_backup_dt
! Number of RES file copies to retain.
      INTEGER :: res_backups
! Interval at which REAL restart (.SPx) files data are updated.
      DOUBLE PRECISION :: spx_dt(n_spx)
! Interval at which standard output (.OUT) file data is updated.
      DOUBLE PRECISION :: out_dt
! Interval at which user-defined output files are updated.
      DOUBLE PRECISION :: usr_dt (dimension_usr)
! Interval to check and report the mass balance
      DOUBLE PRECISION :: report_mass_balance_dt
! Interval in number of time steps at which LOG file is written
      INTEGER :: nlog
! Flag to display messages and residuals on the screen
      LOGICAL :: full_log
! Flag to enable all ranks to write private LOG files.
      LOGICAL :: enable_dmp_log
! Flag to print the index layout for  ijk<=>i,j,k  debugging tasks
      LOGICAL :: dbgprn_layout
! Generate log files when negative gas density is detected.
      LOGICAL :: report_neg_density
! Generate log files when negative specific heat is detected.
      LOGICAL :: report_neg_specificheat


! Time at which special output is to be written
      DOUBLE PRECISION :: usr_time(dimension_usr)
! Time at which restart file is to be written
      DOUBLE PRECISION :: res_time
! Time at which restart backup file is to be written
      DOUBLE PRECISION :: res_backup_time
! Time at which REAL restart file is to be written
      DOUBLE PRECISION :: spx_time(n_spx)
! Time at which standard output is to be written
      DOUBLE PRECISION :: out_time

! The approximate amount (in MB) of space needed to write
! one time step of data into the indexed SPX file.
      DOUBLE PRECISION :: disk(n_spx) = 0.0d0
! The approximated total disk space (in MB)
      DOUBLE PRECISION :: disk_tot = 0.0d0
! One megabite (MB)
      DOUBLE PRECISION, PARAMETER :: onemeg = 1048576

! The following have no direct usage in the code. They are generic
! hooks wereby a user can specify some information. It may be useful
! to have the USR_I/J/K variables calculated in a check routine
! the same way that coordinates for BCs, ICs, PSs, are calculated.
!--------------------------------------------------------------------//
! X coordinate of the west face of user output region
      DOUBLE PRECISION :: usr_x_w (dimension_usr)
! X coordinate of the east face of user output region
      DOUBLE PRECISION :: usr_x_e (dimension_usr)
! Y coordinate of the south face of user output region
      DOUBLE PRECISION :: usr_y_s (dimension_usr)
! Y coordinate of the north face of user output region
      DOUBLE PRECISION :: usr_y_n (dimension_usr)
! Z coordinate of the bottom face of user output region
      DOUBLE PRECISION :: usr_z_b (dimension_usr)
! Z coordinate of the top face of user output region
      DOUBLE PRECISION :: usr_z_t (dimension_usr)
! I index of the west face of user output region
      INTEGER :: usr_i_w (dimension_usr)
! I index of the east face of user output region
      INTEGER :: usr_i_e (dimension_usr)
! J index of the south face of user output region
      INTEGER :: usr_j_s (dimension_usr)
! J index of the north face of user output region
      INTEGER :: usr_j_n (dimension_usr)
! K index of the bottom face of user output region
      INTEGER :: usr_k_b (dimension_usr)
! K index of the top face of user output region
      INTEGER :: usr_k_t (dimension_usr)
! Type of user-defined output: BINARY or ASCII.
      CHARACTER(LEN=6) :: usr_type (dimension_usr)
! Variables to be written in the user-defined output file.
      CHARACTER(LEN=60) :: usr_var (dimension_usr)
! Format for writing user-defined (ASCII) output file.
      CHARACTER(LEN=60) :: usr_format (dimension_usr)
! Extension for the user-defined output file.
      CHARACTER(LEN=16) :: usr_ext (dimension_usr)


      END MODULE output