MFC
Exascale flow solver
Loading...
Searching...
No Matches
m_global_parameters Module Reference

Defines global parameters for the computational domain, simulation algorithm, and initial conditions. More...

Functions/Subroutines

impure 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.
impure subroutine s_initialize_global_parameters_module
 Computation of parameters, allocation procedures, and/or any other tasks needed to properly setup the module.
impure subroutine s_initialize_parallel_io
 Configure MPI parallel I/O settings and allocate processor coordinate arrays.
impure subroutine s_finalize_global_parameters_module
 Deallocate all global grid, index, and equation-of-state parameter arrays.

Variables

integer num_procs
 Number of processors.
logical non_axis_sym
 Use existing IC data.
logical cfl_dt
integer proc_rank
 Rank of the local processor Number of cells in the x-, y- and z-coordinate directions.
type(mpi_io_var), public mpi_io_data
logical bc_io
 whether or not to save BC data
type(chemistry_parameterschem_params
integer, dimension(:,:,:), allocatable logic_grid
type(pres_fieldpb
type(pres_fieldmv
integer buff_size
 Number of ghost cells for boundary condition storage.
character(len=2 *path_leninterface_file
real(wpnormfac
real(wpnormmag
real(wpg0_ic
real(wpp0_ic
Max and min number of cells in a direction of each combination of x-,y-, and z-
type(cell_num_boundscells_bounds
integer(kind=8) nglobal
 Global number of cells in the domain.
integer m_glb
integer n_glb
integer p_glb
 Global number of cells in each direction.
integer grid_geometry
 Cylindrical coordinates (either axisymmetric or full 3D).
real(wp), dimension(:), allocatable x_cc
 Locations of cell-centers (cc) in x-, y- and z-directions, respectively.
real(wp), dimension(:), allocatable y_cc
real(wp), dimension(:), allocatable z_cc
real(wp), dimension(:), allocatable x_cb
 Locations of cell-boundaries (cb) in x-, y- and z-directions, respectively.
real(wp), dimension(:), allocatable y_cb
real(wp), dimension(:), allocatable z_cb
real(wpdx
real(wpdy
real(wpdz
 Minimum cell-widths in the x-, y- and z-coordinate directions.
type(bounds_infox_domain
type(bounds_infoy_domain
type(bounds_infoz_domain
 Locations of the domain bounds in the x-, y- and z-coordinate directions.
type(bounds_infox_domain_glb
 Global (pre-decomposition) domain bounds, needed by s_generate_serial_grid to stretch the grid using the full domain length rather than a local processor's sub-domain length.
type(bounds_infoy_domain_glb
type(bounds_infoz_domain_glb
type(qbmm_idx_infoqbmm_idx
 QBMM moment index mappings.
type(int_bounds_info), dimension(1:3) idwint
type(int_bounds_info), dimension(1:3) idwbuff
type(int_bounds_infobc_x
type(int_bounds_infobc_y
type(int_bounds_infobc_z
 Boundary conditions in the x-, y- and z-coordinate directions.
type(bc_xyz_infobc
 Combined BC storage (used by the shared beta-buffer routines; pre-process-local).
integer fd_order
 Finite-difference order for CoM/probe derivative approximations.
integer fd_number
 FD half-stencil size: MAX(1, fd_order/2).
type(bubbles_lagrange_parameterslag_params
 Lagrange bubbles' parameters (pre_process-local; not in generated_decls).
MPI domain-decomposition neighbor info (Lagrangian-bubble decomposition, #1290)
type(int_bounds_info), dimension(3) nidx
integer, dimension(:,:,:), allocatable neighbor_ranks
 Neighbor ranks.
Bubble modeling
real(wpeu
real(wp), dimension(:), allocatable weight
real(wp), dimension(:), allocatable r0
integer nmom
 Number of carried moments.
Immersed Boundaries
type(ib_airfoil_grid), dimension(:), allocatable ib_airfoil_grids
 Per-airfoil computed surface grids (unused in pre_process).
Non-polytropic bubble gas compression
real(wpphi_vg
real(wpphi_gv
real(wppe_c
real(wptw
real(wpk_vl
real(wpk_gl
real(wpgam_m
real(wp), dimension(:), allocatable pb0
real(wp), dimension(:), allocatable mass_g0
real(wp), dimension(:), allocatable mass_v0
real(wp), dimension(:), allocatable pe_t
real(wp), dimension(:), allocatable k_v
real(wp), dimension(:), allocatable k_g
real(wp), dimension(:), allocatable re_trans_t
real(wp), dimension(:), allocatable re_trans_c
real(wp), dimension(:), allocatable im_trans_t
real(wp), dimension(:), allocatable im_trans_c
real(wp), dimension(:), allocatable omegan
real(wpp0ref
real(wprho0ref
real(wpt0ref
real(wpss
real(wppv
real(wpvd
real(wpmu_l
real(wpmu_v
real(wpmu_g
real(wpgam_v
real(wpgam_g
real(wpm_v
real(wpm_g
real(wpcp_v
real(wpcp_g
real(wpr_v
real(wpr_g

Detailed Description

Defines global parameters for the computational domain, simulation algorithm, and initial conditions.

Function/Subroutine Documentation

◆ s_assign_default_values_to_user_inputs()

impure 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.

Definition at line 127 of file m_global_parameters.fpp.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_finalize_global_parameters_module()

impure subroutine m_global_parameters::s_finalize_global_parameters_module

Deallocate all global grid, index, and equation-of-state parameter arrays.

Definition at line 634 of file m_global_parameters.fpp.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_initialize_global_parameters_module()

impure 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.

Definition at line 480 of file m_global_parameters.fpp.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_initialize_parallel_io()

impure subroutine m_global_parameters::s_initialize_parallel_io

Configure MPI parallel I/O settings and allocate processor coordinate arrays.

Definition at line 627 of file m_global_parameters.fpp.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ bc

type(bc_xyz_info) m_global_parameters::bc

Combined BC storage (used by the shared beta-buffer routines; pre-process-local).

Definition at line 67 of file m_global_parameters.fpp.f90.

◆ bc_io

logical m_global_parameters::bc_io

whether or not to save BC data

Definition at line 87 of file m_global_parameters.fpp.f90.

◆ bc_x

type(int_bounds_info) m_global_parameters::bc_x

Definition at line 66 of file m_global_parameters.fpp.f90.

◆ bc_y

type(int_bounds_info) m_global_parameters::bc_y

Definition at line 66 of file m_global_parameters.fpp.f90.

◆ bc_z

type(int_bounds_info) m_global_parameters::bc_z

Boundary conditions in the x-, y- and z-coordinate directions.

Definition at line 66 of file m_global_parameters.fpp.f90.

◆ buff_size

integer m_global_parameters::buff_size

Number of ghost cells for boundary condition storage.

Definition at line 117 of file m_global_parameters.fpp.f90.

◆ cells_bounds

type(cell_num_bounds) m_global_parameters::cells_bounds

Definition at line 42 of file m_global_parameters.fpp.f90.

◆ cfl_dt

logical m_global_parameters::cfl_dt

Definition at line 35 of file m_global_parameters.fpp.f90.

◆ chem_params

type(chemistry_parameters) m_global_parameters::chem_params

Definition at line 90 of file m_global_parameters.fpp.f90.

◆ cp_g

real(wp) m_global_parameters::cp_g

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ cp_v

real(wp) m_global_parameters::cp_v

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ dx

real(wp) m_global_parameters::dx

Definition at line 50 of file m_global_parameters.fpp.f90.

◆ dy

real(wp) m_global_parameters::dy

Definition at line 50 of file m_global_parameters.fpp.f90.

◆ dz

real(wp) m_global_parameters::dz

Minimum cell-widths in the x-, y- and z-coordinate directions.

Definition at line 50 of file m_global_parameters.fpp.f90.

◆ eu

real(wp) m_global_parameters::eu

Definition at line 93 of file m_global_parameters.fpp.f90.

◆ fd_number

integer m_global_parameters::fd_number

FD half-stencil size: MAX(1, fd_order/2).

Definition at line 71 of file m_global_parameters.fpp.f90.

◆ fd_order

integer m_global_parameters::fd_order

Finite-difference order for CoM/probe derivative approximations.

Definition at line 70 of file m_global_parameters.fpp.f90.

◆ g0_ic

real(wp) m_global_parameters::g0_ic

Definition at line 121 of file m_global_parameters.fpp.f90.

◆ gam_g

real(wp) m_global_parameters::gam_g

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ gam_m

real(wp) m_global_parameters::gam_m

Definition at line 108 of file m_global_parameters.fpp.f90.

◆ gam_v

real(wp) m_global_parameters::gam_v

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ grid_geometry

integer m_global_parameters::grid_geometry

Cylindrical coordinates (either axisymmetric or full 3D).

Definition at line 45 of file m_global_parameters.fpp.f90.

◆ ib_airfoil_grids

type(ib_airfoil_grid), dimension(:), allocatable m_global_parameters::ib_airfoil_grids

Per-airfoil computed surface grids (unused in pre_process).

Definition at line 102 of file m_global_parameters.fpp.f90.

◆ idwbuff

type(int_bounds_info), dimension(1:3) m_global_parameters::idwbuff

Definition at line 65 of file m_global_parameters.fpp.f90.

◆ idwint

type(int_bounds_info), dimension(1:3) m_global_parameters::idwint

Definition at line 62 of file m_global_parameters.fpp.f90.

◆ im_trans_c

real(wp), dimension(:), allocatable m_global_parameters::im_trans_c

Definition at line 110 of file m_global_parameters.fpp.f90.

◆ im_trans_t

real(wp), dimension(:), allocatable m_global_parameters::im_trans_t

Definition at line 110 of file m_global_parameters.fpp.f90.

◆ interface_file

character(len=2*path_len) m_global_parameters::interface_file

Definition at line 120 of file m_global_parameters.fpp.f90.

◆ k_g

real(wp), dimension(:), allocatable m_global_parameters::k_g

Definition at line 109 of file m_global_parameters.fpp.f90.

◆ k_gl

real(wp) m_global_parameters::k_gl

Definition at line 107 of file m_global_parameters.fpp.f90.

◆ k_v

real(wp), dimension(:), allocatable m_global_parameters::k_v

Definition at line 109 of file m_global_parameters.fpp.f90.

◆ k_vl

real(wp) m_global_parameters::k_vl

Definition at line 107 of file m_global_parameters.fpp.f90.

◆ lag_params

type(bubbles_lagrange_parameters) m_global_parameters::lag_params

Lagrange bubbles' parameters (pre_process-local; not in generated_decls).

Definition at line 72 of file m_global_parameters.fpp.f90.

◆ logic_grid

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

Definition at line 114 of file m_global_parameters.fpp.f90.

◆ m_g

real(wp) m_global_parameters::m_g

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ m_glb

integer m_global_parameters::m_glb

Definition at line 44 of file m_global_parameters.fpp.f90.

◆ m_v

real(wp) m_global_parameters::m_v

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ mass_g0

real(wp), dimension(:), allocatable m_global_parameters::mass_g0

Definition at line 109 of file m_global_parameters.fpp.f90.

◆ mass_v0

real(wp), dimension(:), allocatable m_global_parameters::mass_v0

Definition at line 109 of file m_global_parameters.fpp.f90.

◆ mpi_io_data

type(mpi_io_var), public m_global_parameters::mpi_io_data

Definition at line 83 of file m_global_parameters.fpp.f90.

◆ mu_g

real(wp) m_global_parameters::mu_g

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ mu_l

real(wp) m_global_parameters::mu_l

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ mu_v

real(wp) m_global_parameters::mu_v

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ mv

type(pres_field) m_global_parameters::mv

Definition at line 116 of file m_global_parameters.fpp.f90.

◆ n_glb

integer m_global_parameters::n_glb

Definition at line 44 of file m_global_parameters.fpp.f90.

◆ neighbor_ranks

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

Neighbor ranks.

Definition at line 80 of file m_global_parameters.fpp.f90.

◆ nglobal

integer(kind=8) m_global_parameters::nglobal

Global number of cells in the domain.

Definition at line 43 of file m_global_parameters.fpp.f90.

◆ nidx

type(int_bounds_info), dimension(3) m_global_parameters::nidx

Definition at line 79 of file m_global_parameters.fpp.f90.

◆ nmom

integer m_global_parameters::nmom

Number of carried moments.

Definition at line 95 of file m_global_parameters.fpp.f90.

◆ non_axis_sym

logical m_global_parameters::non_axis_sym

Use existing IC data.

Definition at line 34 of file m_global_parameters.fpp.f90.

◆ normfac

real(wp) m_global_parameters::normfac

Definition at line 121 of file m_global_parameters.fpp.f90.

◆ normmag

real(wp) m_global_parameters::normmag

Definition at line 121 of file m_global_parameters.fpp.f90.

◆ num_procs

integer m_global_parameters::num_procs

Number of processors.

Definition at line 33 of file m_global_parameters.fpp.f90.

◆ omegan

real(wp), dimension(:), allocatable m_global_parameters::omegan

Definition at line 110 of file m_global_parameters.fpp.f90.

◆ p0_ic

real(wp) m_global_parameters::p0_ic

Definition at line 121 of file m_global_parameters.fpp.f90.

◆ p0ref

real(wp) m_global_parameters::p0ref

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ p_glb

integer m_global_parameters::p_glb

Global number of cells in each direction.

Definition at line 44 of file m_global_parameters.fpp.f90.

◆ pb

type(pres_field) m_global_parameters::pb

Definition at line 115 of file m_global_parameters.fpp.f90.

◆ pb0

real(wp), dimension(:), allocatable m_global_parameters::pb0

Definition at line 109 of file m_global_parameters.fpp.f90.

◆ pe_c

real(wp) m_global_parameters::pe_c

Definition at line 107 of file m_global_parameters.fpp.f90.

◆ pe_t

real(wp), dimension(:), allocatable m_global_parameters::pe_t

Definition at line 109 of file m_global_parameters.fpp.f90.

◆ phi_gv

real(wp) m_global_parameters::phi_gv

Definition at line 107 of file m_global_parameters.fpp.f90.

◆ phi_vg

real(wp) m_global_parameters::phi_vg

Definition at line 107 of file m_global_parameters.fpp.f90.

◆ proc_rank

integer m_global_parameters::proc_rank

Rank of the local processor Number of cells in the x-, y- and z-coordinate directions.

Definition at line 39 of file m_global_parameters.fpp.f90.

◆ pv

real(wp) m_global_parameters::pv

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ qbmm_idx

type(qbmm_idx_info) m_global_parameters::qbmm_idx

QBMM moment index mappings.

Definition at line 60 of file m_global_parameters.fpp.f90.

◆ r0

real(wp), dimension(:), allocatable m_global_parameters::r0

Definition at line 94 of file m_global_parameters.fpp.f90.

◆ r_g

real(wp) m_global_parameters::r_g

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ r_v

real(wp) m_global_parameters::r_v

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ re_trans_c

real(wp), dimension(:), allocatable m_global_parameters::re_trans_c

Definition at line 110 of file m_global_parameters.fpp.f90.

◆ re_trans_t

real(wp), dimension(:), allocatable m_global_parameters::re_trans_t

Definition at line 110 of file m_global_parameters.fpp.f90.

◆ rho0ref

real(wp) m_global_parameters::rho0ref

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ ss

real(wp) m_global_parameters::ss

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ t0ref

real(wp) m_global_parameters::t0ref

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ tw

real(wp) m_global_parameters::tw

Definition at line 107 of file m_global_parameters.fpp.f90.

◆ vd

real(wp) m_global_parameters::vd

Definition at line 111 of file m_global_parameters.fpp.f90.

◆ weight

real(wp), dimension(:), allocatable m_global_parameters::weight

Definition at line 94 of file m_global_parameters.fpp.f90.

◆ x_cb

real(wp), dimension(:), allocatable m_global_parameters::x_cb

Locations of cell-boundaries (cb) in x-, y- and z-directions, respectively.

Definition at line 49 of file m_global_parameters.fpp.f90.

◆ x_cc

real(wp), dimension(:), allocatable m_global_parameters::x_cc

Locations of cell-centers (cc) in x-, y- and z-directions, respectively.

Definition at line 47 of file m_global_parameters.fpp.f90.

◆ x_domain

type(bounds_info) m_global_parameters::x_domain

Definition at line 51 of file m_global_parameters.fpp.f90.

◆ x_domain_glb

type(bounds_info) m_global_parameters::x_domain_glb

Global (pre-decomposition) domain bounds, needed by s_generate_serial_grid to stretch the grid using the full domain length rather than a local processor's sub-domain length.

Definition at line 54 of file m_global_parameters.fpp.f90.

◆ y_cb

real(wp), dimension(:), allocatable m_global_parameters::y_cb

Definition at line 49 of file m_global_parameters.fpp.f90.

◆ y_cc

real(wp), dimension(:), allocatable m_global_parameters::y_cc

Definition at line 47 of file m_global_parameters.fpp.f90.

◆ y_domain

type(bounds_info) m_global_parameters::y_domain

Definition at line 51 of file m_global_parameters.fpp.f90.

◆ y_domain_glb

type(bounds_info) m_global_parameters::y_domain_glb

Definition at line 54 of file m_global_parameters.fpp.f90.

◆ z_cb

real(wp), dimension(:), allocatable m_global_parameters::z_cb

Definition at line 49 of file m_global_parameters.fpp.f90.

◆ z_cc

real(wp), dimension(:), allocatable m_global_parameters::z_cc

Definition at line 47 of file m_global_parameters.fpp.f90.

◆ z_domain

type(bounds_info) m_global_parameters::z_domain

Locations of the domain bounds in the x-, y- and z-coordinate directions.

Definition at line 51 of file m_global_parameters.fpp.f90.

◆ z_domain_glb

type(bounds_info) m_global_parameters::z_domain_glb

Definition at line 54 of file m_global_parameters.fpp.f90.