MFC: Post-Process
High-fidelity multiphase flow simulation
Loading...
Searching...
No Matches
m_global_parameters Module Reference

This module contains all of the parameters characterizing the computational domain, simulation algorithm, stiffened equation of state and finally, the formatted database file(s) structure. More...

Functions/Subroutines

subroutine s_assign_default_values_to_user_inputs ()
 Assigns default values to user inputs prior to reading them in. This allows for an easier consistency check of these parameters once they are read from the input file.
 
subroutine s_initialize_global_parameters_module ()
 Computation of parameters, allocation procedures, and/or any other tasks needed to properly setup the module.
 
subroutine s_initialize_parallel_io ()
 Subroutine to initialize parallel infrastructure.
 
subroutine s_finalize_global_parameters_module ()
 Deallocation procedures for the module.
 

Variables

integer proc_rank
 Rank of the local processor.
 
integer(8) nglobal
 
integer num_dims
 Number of spatial dimensions.
 
integer buff_size
 Number of cells in buffer region. For the variables which feature a buffer region, this region is used to store information outside the computational domain based on the boundary conditions.
 
integer t_step_start
 First time-step directory.
 
integer t_step_stop
 Last time-step directory.
 
integer t_step_save
 Interval between consecutive time-step directory.
 
logical parallel_io
 Format of the data files.
 
logical file_per_process
 output format
 
integer, dimension(:), allocatable proc_coords
 Processor coordinates in MPI_CART_COMM.
 
integer, dimension(:), allocatable start_idx
 Starting cell-center index of local processor in global grid.
 
type(mpi_io_var), public mpi_io_data
 
integer, private ierr
 
type(physical_parameters), dimension(num_fluids_max) fluid_pp
 Database of the physical parameters of each of the fluids that is present in the flow. These include the stiffened gas equation of state parameters, the Reynolds numbers and the Weber numbers.
 
real(kind(0d0)), dimension(:), allocatable adv
 Advection variables.
 
integer format
 Format of the database file(s)
 
integer precision
 Floating point precision of the database file(s)
 
real(kind(0d0)), dimension(num_fluids_max) schlieren_alpha
 Amplitude coefficients of the numerical Schlieren function that are used to adjust the intensity of numerical Schlieren renderings for individual fluids. This enables waves and interfaces of varying strengths and in all of the fluids to be made simultaneously visible on a single plot.
 
integer fd_order
 The order of the finite-difference (fd) approximations of the first-order derivatives that need to be evaluated when vorticity and/or the numerical Schlieren function are to be outputted to the formatted database file(s).
 
integer fd_number
 The finite-difference number is given by MAX(1, fd_order/2). Essentially, it is a measure of the half-size of the finite-difference stencil for the selected order of accuracy.
 
Logistics
integer num_procs
 Number of processors.
 
character(len=path_len) case_dir
 Case folder location.
 
Number of cells in the x-, y- and z-coordinate directions
integer m
 
integer m_root
 
integer n
 
integer p
 
Cylindrical coordinates (either axisymmetric or full 3D)
logical cyl_coord
 
integer grid_geometry
 
Global number of cells in each direction
integer m_glb
 
integer n_glb
 
integer p_glb
 
Cell-boundary locations in the x-, y- and z-coordinate directions
real(kind(0d0)), dimension(:), allocatable x_cb
 
real(kind(0d0)), dimension(:), allocatable x_root_cb
 
real(kind(0d0)), dimension(:), allocatable y_cb
 
real(kind(0d0)), dimension(:), allocatable z_cb
 
real(kind(0.0)), dimension(:), allocatable x_cb_s
 
real(kind(0.0)), dimension(:), allocatable y_cb_s
 
real(kind(0.0)), dimension(:), allocatable z_cb_s
 
Cell-center locations in the x-, y- and z-coordinate directions
real(kind(0d0)), dimension(:), allocatable x_cc
 
real(kind(0d0)), dimension(:), allocatable x_root_cc
 
real(kind(0d0)), dimension(:), allocatable y_cc
 
real(kind(0d0)), dimension(:), allocatable z_cc
 
real(kind(0d0)), dimension(:), allocatable dx
 Cell-width distributions in the x-, y- and z-coordinate directions.
 
real(kind(0d0)), dimension(:), allocatable dy
 
real(kind(0d0)), dimension(:), allocatable dz
 
Simulation Algorithm Parameters
integer model_eqns
 Multicomponent flow model.
 
integer num_fluids
 Number of different fluids present in the flow.
 
logical relax
 phase change
 
integer relax_model
 Phase change relaxation model.
 
logical adv_alphan
 Advection of the last volume fraction.
 
logical mpp_lim
 Maximum volume fraction limiter.
 
integer sys_size
 Number of unknowns in the system of equations.
 
integer weno_order
 Order of accuracy for the WENO reconstruction.
 
logical mixture_err
 Mixture error limiter.
 
logical alt_soundspeed
 Alternate sound speed.
 
logical hypoelasticity
 Turn hypoelasticity on.
 
Annotations of the structure, i.e. the organization, of the state vectors
type(int_bounds_infocont_idx
 Indexes of first & last continuity eqns.
 
type(int_bounds_infomom_idx
 Indexes of first & last momentum eqns.
 
integer e_idx
 Index of energy equation.
 
type(int_bounds_infoadv_idx
 Indexes of first & last advection eqns.
 
type(int_bounds_infointernalenergies_idx
 Indexes of first & last internal energy eqns.
 
type(bub_bounds_infobub_idx
 Indexes of first & last bubble variable eqns.
 
integer gamma_idx
 Index of specific heat ratio func. eqn.
 
integer alf_idx
 Index of specific heat ratio func. eqn.
 
integer pi_inf_idx
 Index of liquid stiffness func. eqn.
 
type(int_bounds_infostress_idx
 Indices of elastic stresses.
 
Boundary conditions in the x-, y- and z-coordinate directions
type(int_bounds_infobc_x
 
type(int_bounds_infobc_y
 
type(int_bounds_infobc_z
 
MPI info for parallel IO with Lustre file systems
character(len=name_len) mpiiofs
 
integer mpi_info_int
 
Size of the ghost zone layer in the x-, y- and z-coordinate directions.

The definition of the ghost zone layers is only necessary when using the Silo database file format in multidimensions. These zones provide VisIt with the subdomain connectivity information that it requires in order to produce smooth plots.

type(int_bounds_infooffset_x
 
type(int_bounds_infooffset_y
 
type(int_bounds_infooffset_z
 
The list of all possible flow variables that may be written to a database

file. It includes partial densities, density, momentum, velocity, energy, pressure, volume fraction(s), specific heat ratio function, specific heat ratio, liquid stiffness function, liquid stiffness, primitive variables, conservative variables, speed of sound, the vorticity, and the numerical Schlieren function.

logical, dimension(num_fluids_max) alpha_rho_wrt
 
logical rho_wrt
 
logical, dimension(3) mom_wrt
 
logical, dimension(3) vel_wrt
 
integer flux_lim
 
logical, dimension(3) flux_wrt
 
logical e_wrt
 
logical pres_wrt
 
logical, dimension(num_fluids_max) alpha_wrt
 
logical gamma_wrt
 
logical heat_ratio_wrt
 
logical pi_inf_wrt
 
logical pres_inf_wrt
 
logical prim_vars_wrt
 
logical cons_vars_wrt
 
logical c_wrt
 
logical, dimension(3) omega_wrt
 
logical qm_wrt
 
logical schlieren_wrt
 
Reference parameters for Tait EOS
real(kind(0d0)) rhoref
 
real(kind(0d0)) pref
 
Bubble modeling variables and parameters
integer nb
 
real(kind(0d0)) r0ref
 
real(kind(0d0)) ca
 
real(kind(0d0)) web
 
real(kind(0d0)) re_inv
 
real(kind(0d0)), dimension(:), allocatable weight
 
real(kind(0d0)), dimension(:), allocatable r0
 
real(kind(0d0)), dimension(:), allocatable v0
 
logical bubbles
 
logical qbmm
 
logical polytropic
 
logical polydisperse
 
integer thermal
 1 = adiabatic, 2 = isotherm, 3 = transfer
 
real(kind(0d0)) r_n
 
real(kind(0d0)) r_v
 
real(kind(0d0)) phi_vn
 
real(kind(0d0)) phi_nv
 
real(kind(0d0)) pe_c
 
real(kind(0d0)) tw
 
real(kind(0d0)) g
 
real(kind(0d0)) pv
 
real(kind(0d0)) m_n
 
real(kind(0d0)) m_v
 
real(kind(0d0)), dimension(:), allocatable k_n
 
real(kind(0d0)), dimension(:), allocatable k_v
 
real(kind(0d0)), dimension(:), allocatable pb0
 
real(kind(0d0)), dimension(:), allocatable mass_n0
 
real(kind(0d0)), dimension(:), allocatable mass_v0
 
real(kind(0d0)), dimension(:), allocatable pe_t
 
real(kind(0d0)), dimension(:), allocatable re_trans_t
 
real(kind(0d0)), dimension(:), allocatable re_trans_c
 
real(kind(0d0)), dimension(:), allocatable im_trans_t
 
real(kind(0d0)), dimension(:), allocatable im_trans_c
 
real(kind(0d0)), dimension(:), allocatable omegan
 
real(kind(0d0)) mul0
 
real(kind(0d0)) ss
 
real(kind(0d0)) gamma_v
 
real(kind(0d0)) mu_v
 
real(kind(0d0)) gamma_m
 
real(kind(0d0)) gamma_n
 
real(kind(0d0)) mu_n
 
real(kind(0d0)) poly_sigma
 
real(kind(0d0)) sigr
 
integer nmom
 
Index variables used for m_variables_conversion
integer momxb
 
integer momxe
 
integer advxb
 
integer advxe
 
integer contxb
 
integer contxe
 
integer intxb
 
integer intxe
 
integer bubxb
 
integer bubxe
 
integer strxb
 
integer strxe
 

Detailed Description

This module contains all of the parameters characterizing the computational domain, simulation algorithm, stiffened equation of state and finally, the formatted database file(s) structure.

Function/Subroutine Documentation

◆ s_assign_default_values_to_user_inputs()

subroutine m_global_parameters::s_assign_default_values_to_user_inputs

Assigns default values to user inputs prior to reading them in. This allows for an easier consistency check of these parameters once they are read from the input file.

Here is the caller graph for this function:

◆ s_finalize_global_parameters_module()

subroutine m_global_parameters::s_finalize_global_parameters_module

Deallocation procedures for the module.

Here is the caller graph for this function:

◆ s_initialize_global_parameters_module()

subroutine m_global_parameters::s_initialize_global_parameters_module

Computation of parameters, allocation procedures, and/or any other tasks needed to properly setup the module.

Here is the caller graph for this function:

◆ s_initialize_parallel_io()

subroutine m_global_parameters::s_initialize_parallel_io

Subroutine to initialize parallel infrastructure.

Here is the caller graph for this function:

Variable Documentation

◆ adv

real(kind(0d0)), dimension(:), allocatable m_global_parameters::adv

Advection variables.

◆ adv_alphan

logical m_global_parameters::adv_alphan

Advection of the last volume fraction.

◆ adv_idx

type(int_bounds_info) m_global_parameters::adv_idx

Indexes of first & last advection eqns.

◆ advxb

integer m_global_parameters::advxb

◆ advxe

integer m_global_parameters::advxe

◆ alf_idx

integer m_global_parameters::alf_idx

Index of specific heat ratio func. eqn.

◆ alpha_rho_wrt

logical, dimension(num_fluids_max) m_global_parameters::alpha_rho_wrt

◆ alpha_wrt

logical, dimension(num_fluids_max) m_global_parameters::alpha_wrt

◆ alt_soundspeed

logical m_global_parameters::alt_soundspeed

Alternate sound speed.

◆ bc_x

type(int_bounds_info) m_global_parameters::bc_x

◆ bc_y

type(int_bounds_info) m_global_parameters::bc_y

◆ bc_z

type(int_bounds_info) m_global_parameters::bc_z

◆ bub_idx

type(bub_bounds_info) m_global_parameters::bub_idx

Indexes of first & last bubble variable eqns.

◆ bubbles

logical m_global_parameters::bubbles

◆ bubxb

integer m_global_parameters::bubxb

◆ bubxe

integer m_global_parameters::bubxe

◆ buff_size

integer m_global_parameters::buff_size

Number of cells in buffer region. For the variables which feature a buffer region, this region is used to store information outside the computational domain based on the boundary conditions.

◆ c_wrt

logical m_global_parameters::c_wrt

◆ ca

real(kind(0d0)) m_global_parameters::ca

◆ case_dir

character(len=path_len) m_global_parameters::case_dir

Case folder location.

◆ cons_vars_wrt

logical m_global_parameters::cons_vars_wrt

◆ cont_idx

type(int_bounds_info) m_global_parameters::cont_idx

Indexes of first & last continuity eqns.

◆ contxb

integer m_global_parameters::contxb

◆ contxe

integer m_global_parameters::contxe

◆ cyl_coord

logical m_global_parameters::cyl_coord

◆ dx

real(kind(0d0)), dimension(:), allocatable m_global_parameters::dx

Cell-width distributions in the x-, y- and z-coordinate directions.

◆ dy

real(kind(0d0)), dimension(:), allocatable m_global_parameters::dy

◆ dz

real(kind(0d0)), dimension(:), allocatable m_global_parameters::dz

◆ e_idx

integer m_global_parameters::e_idx

Index of energy equation.

◆ e_wrt

logical m_global_parameters::e_wrt

◆ fd_number

integer m_global_parameters::fd_number

The finite-difference number is given by MAX(1, fd_order/2). Essentially, it is a measure of the half-size of the finite-difference stencil for the selected order of accuracy.

◆ fd_order

integer m_global_parameters::fd_order

The order of the finite-difference (fd) approximations of the first-order derivatives that need to be evaluated when vorticity and/or the numerical Schlieren function are to be outputted to the formatted database file(s).

◆ file_per_process

logical m_global_parameters::file_per_process

output format

◆ fluid_pp

type(physical_parameters), dimension(num_fluids_max) m_global_parameters::fluid_pp

Database of the physical parameters of each of the fluids that is present in the flow. These include the stiffened gas equation of state parameters, the Reynolds numbers and the Weber numbers.

◆ flux_lim

integer m_global_parameters::flux_lim

◆ flux_wrt

logical, dimension(3) m_global_parameters::flux_wrt

◆ format

integer m_global_parameters::format

Format of the database file(s)

◆ g

real(kind(0d0)) m_global_parameters::g

◆ gamma_idx

integer m_global_parameters::gamma_idx

Index of specific heat ratio func. eqn.

◆ gamma_m

real(kind(0d0)) m_global_parameters::gamma_m

◆ gamma_n

real(kind(0d0)) m_global_parameters::gamma_n

◆ gamma_v

real(kind(0d0)) m_global_parameters::gamma_v

◆ gamma_wrt

logical m_global_parameters::gamma_wrt

◆ grid_geometry

integer m_global_parameters::grid_geometry

◆ heat_ratio_wrt

logical m_global_parameters::heat_ratio_wrt

◆ hypoelasticity

logical m_global_parameters::hypoelasticity

Turn hypoelasticity on.

◆ ierr

integer, private m_global_parameters::ierr
private

◆ im_trans_c

real(kind(0d0)), dimension(:), allocatable m_global_parameters::im_trans_c

◆ im_trans_t

real(kind(0d0)), dimension(:), allocatable m_global_parameters::im_trans_t

◆ internalenergies_idx

type(int_bounds_info) m_global_parameters::internalenergies_idx

Indexes of first & last internal energy eqns.

◆ intxb

integer m_global_parameters::intxb

◆ intxe

integer m_global_parameters::intxe

◆ k_n

real(kind(0d0)), dimension(:), allocatable m_global_parameters::k_n

◆ k_v

real(kind(0d0)), dimension(:), allocatable m_global_parameters::k_v

◆ m

integer m_global_parameters::m

◆ m_glb

integer m_global_parameters::m_glb

◆ m_n

real(kind(0d0)) m_global_parameters::m_n

◆ m_root

integer m_global_parameters::m_root

◆ m_v

real(kind(0d0)) m_global_parameters::m_v

◆ mass_n0

real(kind(0d0)), dimension(:), allocatable m_global_parameters::mass_n0

◆ mass_v0

real(kind(0d0)), dimension(:), allocatable m_global_parameters::mass_v0

◆ mixture_err

logical m_global_parameters::mixture_err

Mixture error limiter.

◆ model_eqns

integer m_global_parameters::model_eqns

Multicomponent flow model.

◆ mom_idx

type(int_bounds_info) m_global_parameters::mom_idx

Indexes of first & last momentum eqns.

◆ mom_wrt

logical, dimension(3) m_global_parameters::mom_wrt

◆ momxb

integer m_global_parameters::momxb

◆ momxe

integer m_global_parameters::momxe

◆ mpi_info_int

integer m_global_parameters::mpi_info_int

◆ mpi_io_data

type(mpi_io_var), public m_global_parameters::mpi_io_data

◆ mpiiofs

character(len=name_len) m_global_parameters::mpiiofs

◆ mpp_lim

logical m_global_parameters::mpp_lim

Maximum volume fraction limiter.

◆ mu_n

real(kind(0d0)) m_global_parameters::mu_n

◆ mu_v

real(kind(0d0)) m_global_parameters::mu_v

◆ mul0

real(kind(0d0)) m_global_parameters::mul0

◆ n

integer m_global_parameters::n

◆ n_glb

integer m_global_parameters::n_glb

◆ nb

integer m_global_parameters::nb

◆ nglobal

integer(8) m_global_parameters::nglobal

◆ nmom

integer m_global_parameters::nmom

◆ num_dims

integer m_global_parameters::num_dims

Number of spatial dimensions.

◆ num_fluids

integer m_global_parameters::num_fluids

Number of different fluids present in the flow.

◆ num_procs

integer m_global_parameters::num_procs

Number of processors.

◆ offset_x

type(int_bounds_info) m_global_parameters::offset_x

◆ offset_y

type(int_bounds_info) m_global_parameters::offset_y

◆ offset_z

type(int_bounds_info) m_global_parameters::offset_z

◆ omega_wrt

logical, dimension(3) m_global_parameters::omega_wrt

◆ omegan

real(kind(0d0)), dimension(:), allocatable m_global_parameters::omegan

◆ p

integer m_global_parameters::p

◆ p_glb

integer m_global_parameters::p_glb

◆ parallel_io

logical m_global_parameters::parallel_io

Format of the data files.

◆ pb0

real(kind(0d0)), dimension(:), allocatable m_global_parameters::pb0

◆ pe_c

real(kind(0d0)) m_global_parameters::pe_c

◆ pe_t

real(kind(0d0)), dimension(:), allocatable m_global_parameters::pe_t

◆ phi_nv

real(kind(0d0)) m_global_parameters::phi_nv

◆ phi_vn

real(kind(0d0)) m_global_parameters::phi_vn

◆ pi_inf_idx

integer m_global_parameters::pi_inf_idx

Index of liquid stiffness func. eqn.

◆ pi_inf_wrt

logical m_global_parameters::pi_inf_wrt

◆ poly_sigma

real(kind(0d0)) m_global_parameters::poly_sigma

◆ polydisperse

logical m_global_parameters::polydisperse

◆ polytropic

logical m_global_parameters::polytropic

◆ precision

integer m_global_parameters::precision

Floating point precision of the database file(s)

◆ pref

real(kind(0d0)) m_global_parameters::pref

◆ pres_inf_wrt

logical m_global_parameters::pres_inf_wrt

◆ pres_wrt

logical m_global_parameters::pres_wrt

◆ prim_vars_wrt

logical m_global_parameters::prim_vars_wrt

◆ proc_coords

integer, dimension(:), allocatable m_global_parameters::proc_coords

Processor coordinates in MPI_CART_COMM.

◆ proc_rank

integer m_global_parameters::proc_rank

Rank of the local processor.

◆ pv

real(kind(0d0)) m_global_parameters::pv

◆ qbmm

logical m_global_parameters::qbmm

◆ qm_wrt

logical m_global_parameters::qm_wrt

◆ r0

real(kind(0d0)), dimension(:), allocatable m_global_parameters::r0

◆ r0ref

real(kind(0d0)) m_global_parameters::r0ref

◆ r_n

real(kind(0d0)) m_global_parameters::r_n

◆ r_v

real(kind(0d0)) m_global_parameters::r_v

◆ re_inv

real(kind(0d0)) m_global_parameters::re_inv

◆ re_trans_c

real(kind(0d0)), dimension(:), allocatable m_global_parameters::re_trans_c

◆ re_trans_t

real(kind(0d0)), dimension(:), allocatable m_global_parameters::re_trans_t

◆ relax

logical m_global_parameters::relax

phase change

◆ relax_model

integer m_global_parameters::relax_model

Phase change relaxation model.

◆ rho_wrt

logical m_global_parameters::rho_wrt

◆ rhoref

real(kind(0d0)) m_global_parameters::rhoref

◆ schlieren_alpha

real(kind(0d0)), dimension(num_fluids_max) m_global_parameters::schlieren_alpha

Amplitude coefficients of the numerical Schlieren function that are used to adjust the intensity of numerical Schlieren renderings for individual fluids. This enables waves and interfaces of varying strengths and in all of the fluids to be made simultaneously visible on a single plot.

◆ schlieren_wrt

logical m_global_parameters::schlieren_wrt

◆ sigr

real(kind(0d0)) m_global_parameters::sigr

◆ ss

real(kind(0d0)) m_global_parameters::ss

◆ start_idx

integer, dimension(:), allocatable m_global_parameters::start_idx

Starting cell-center index of local processor in global grid.

◆ stress_idx

type(int_bounds_info) m_global_parameters::stress_idx

Indices of elastic stresses.

◆ strxb

integer m_global_parameters::strxb

◆ strxe

integer m_global_parameters::strxe

◆ sys_size

integer m_global_parameters::sys_size

Number of unknowns in the system of equations.

◆ t_step_save

integer m_global_parameters::t_step_save

Interval between consecutive time-step directory.

◆ t_step_start

integer m_global_parameters::t_step_start

First time-step directory.

◆ t_step_stop

integer m_global_parameters::t_step_stop

Last time-step directory.

◆ thermal

integer m_global_parameters::thermal

1 = adiabatic, 2 = isotherm, 3 = transfer

◆ tw

real(kind(0d0)) m_global_parameters::tw

◆ v0

real(kind(0d0)), dimension(:), allocatable m_global_parameters::v0

◆ vel_wrt

logical, dimension(3) m_global_parameters::vel_wrt

◆ web

real(kind(0d0)) m_global_parameters::web

◆ weight

real(kind(0d0)), dimension(:), allocatable m_global_parameters::weight

◆ weno_order

integer m_global_parameters::weno_order

Order of accuracy for the WENO reconstruction.

◆ x_cb

real(kind(0d0)), dimension(:), allocatable m_global_parameters::x_cb

◆ x_cb_s

real(kind(0.0)), dimension(:), allocatable m_global_parameters::x_cb_s

◆ x_cc

real(kind(0d0)), dimension(:), allocatable m_global_parameters::x_cc

◆ x_root_cb

real(kind(0d0)), dimension(:), allocatable m_global_parameters::x_root_cb

◆ x_root_cc

real(kind(0d0)), dimension(:), allocatable m_global_parameters::x_root_cc

◆ y_cb

real(kind(0d0)), dimension(:), allocatable m_global_parameters::y_cb

◆ y_cb_s

real(kind(0.0)), dimension(:), allocatable m_global_parameters::y_cb_s

◆ y_cc

real(kind(0d0)), dimension(:), allocatable m_global_parameters::y_cc

◆ z_cb

real(kind(0d0)), dimension(:), allocatable m_global_parameters::z_cb

◆ z_cb_s

real(kind(0.0)), dimension(:), allocatable m_global_parameters::z_cb_s

◆ z_cc

real(kind(0d0)), dimension(:), allocatable m_global_parameters::z_cc