m_constants.fpp.f90

Go to the documentation of this file.

# 1 "/home/runner/work/MFC/MFC/src/common/m_constants.fpp"
!>
!! @file
!! @brief Contains constant values used throughout the code(s).
 
!> @brief Compile-time constant parameters: default values, tolerances, and physical constants
module m_constants
 
    use m_precision_select
 
    character, parameter :: dflt_char = ' '             !< Default string value
    real(wp), parameter  :: dflt_real = -1.e6_wp        !< Default real value
    real(wp), parameter  :: sgm_eps = 1.e-16_wp         !< Segmentation tolerance
    real(wp), parameter  :: chem_tolerance = 1.e-16_wp  !< Speed of Sound Tolerance in Chemistry
    real(wp), parameter  :: small_alf = 1.e-11_wp       !< Small alf tolerance
    real(wp), parameter  :: pi = 3.141592653589793_wp   !< Pi
    real(wp), parameter  :: verysmall = 1.e-12_wp       !< Very small number
    !> Temperature window the immersed-boundary reacting-surface state is kept inside. It is the range the NASA polynomials behind
    !! the thermodynamic evaluations are fitted over -- 200 K is the T_low of every species in the mechanisms shipped with the
    !! reacting-surface example -- so it is where those fits mean anything. Shared by the surface Newton solve, which searches
    !! inside it, the ghost reconstruction, which will not extrapolate out of it, and the case checker, which rejects a prescribed
    !! wall temperature outside it.
    real(wp), parameter :: t_surface_min = 200._wp
    real(wp), parameter :: t_surface_max = 5000._wp
    !> Radius cutoff to avoid division by zero for 3D spherical harmonic patch (geometry 14)
    real(wp), parameter :: small_radius = 1.e-32_wp
    integer, parameter  :: num_stcls_min = 5        !< Minimum # of stencils
    integer, parameter  :: path_len = 400           !< Maximum path length
    integer, parameter  :: name_len = 50            !< Maximum name length
    integer, parameter  :: dflt_int = -100          !< Default integer value
    integer, parameter  :: fourier_rings = 5        !< Fourier filter ring limit
    integer, parameter  :: num_fluids_max = 10      !< Maximum number of fluids in the simulation
    integer, parameter  :: num_probes_max = 64      !< Maximum number of flow probes in the simulation
    integer, parameter  :: num_patches_max = 10     !< Maximum number of IC patches
    integer, parameter  :: num_ib_airfoils_max = 5  !< Maximum number of ib_airfoil instances
    integer, parameter  :: num_stl_models_max = 10
    !> Maximum number of immersed boundary patches (legacy, not used for patch_ib sizing)
    !> Fixed capacity of patch_ib (namelist patches + local particle bed subset after reduction)
    integer, parameter  :: num_local_ibs_max = 30000           !< Maximum number of immersed boundary patches (patch_ib)
    integer, parameter  :: num_ib_patches_max_namelist = 810000
    integer, parameter  :: num_particle_clouds_max = 10        !< Maximum number of particle bed patch specifications
    integer, parameter  :: num_bc_patches_max = 10             !< Maximum number of boundary condition patches
    integer, parameter  :: max_2d_fourier_modes = 10           !< Max Fourier mode index for 2D modal patch (geometry 13)
    integer, parameter  :: max_sph_harm_degree = 5             !< Max degree L for 3D spherical harmonic patch (geometry 14)
    integer, parameter  :: pathlen_max = 400                   !< Maximum path length for STL/OBJ model files
    integer, parameter  :: nnode = 4                           !< Number of QBMM nodes
    integer, parameter  :: dflt_num_igr_iters = 2              !< number of iterations for IGR elliptic solve
    integer, parameter  :: dflt_num_igr_warm_start_iters = 50  !< default number of iterations for IGR elliptic solve
    real(wp), parameter :: dflt_alf_factor = 10._wp            !< scaling factor for IGR alpha
    integer, parameter  :: gp_layers = 3                       !< Number of ghost point layers for IBM
    !> color function gradient magnitude at which to apply the surface tension fluxes
    real(wp), parameter :: capillary_cutoff = 1.e-6
    !> Spatial support width of acoustic source, used in s_source_spatial
    real(wp), parameter :: acoustic_spatial_support_width = 2.5_wp
    real(wp), parameter :: dflt_vcfl_dt = 100._wp  !< value of vcfl_dt when viscosity is off for computing adaptive timestep size
    !> The constant to scale the spectral level at the lower frequency bound
    real(wp), parameter :: broadband_spectral_level_constant = 20._wp
    !> The spectral level constant to correct the magnitude at each frequency to ensure the source is overall broadband
    real(wp), parameter :: broadband_spectral_level_growth_rate = 10._wp
    ! Interface compression (THINC)
    real(wp), parameter :: dflt_ic_eps = 1e-4_wp        !< Ensure compression is only applied to surface cells in THINC
    real(wp), parameter :: dflt_ic_beta = 1.6_wp        !< Sharpness parameter's default value used in THINC
    real(wp), parameter :: moncon_cutoff = 1e-8_wp      !< Monotonicity constraint's limiter to prevent extremas in THINC
    real(wp), parameter :: mthinc_align_tol = 1.e-8_wp  !< Grid aligned snap tolerance for MTHINC normals
    ! Chemistry
    real(wp), parameter :: dflt_t_guess = 1200._wp  !< Default guess for temperature (when a previous value is not available)
 
    ! IBM+STL interpolation constants
    integer, parameter  :: num_ray = 20                        !< Default number of rays traced per cell
    real(wp), parameter :: ray_tracing_threshold = 0.9_wp      !< Threshold above which the cell is marked as the model patch
    real(wp), parameter :: threshold_vector_zero = 1.e-10_wp   !< Threshold to treat the component of a vector to be zero
    real(wp), parameter :: threshold_edge_zero = 1.e-10_wp     !< Threshold to treat two edges to be overlapped
    real(wp), parameter :: initial_distance_buffer = 1.e12_wp  !< Initialized levelset distance for the shortest path pair algorithm
    ! Lagrange bubbles constants
    integer, parameter  :: mapcells = 3      !< Number of cells around the bubble where the smoothening function will have effect
    real(wp), parameter :: r_uni = 8314._wp  !< Universal gas constant - J/kmol/K
    integer, parameter  :: lag_io_vars = 21  !< Number of variables per particle for MPI_IO
 
    ! Strang Splitting constants
    real(wp), parameter :: dflt_adap_dt_tol = 1.e-4_wp   !< Default tolerance for adaptive step size
    integer, parameter  :: dflt_adap_dt_max_iters = 100  !< Default max iteration for adaptive step size
    ! Constants of the algorithm described by Heirer, E. Hairer, S. P.Norsett, G. Wanner, Solving Ordinary Differential Equations I,
    ! Chapter II.4 to choose the initial time step size for the adaptive time stepping routine
    real(wp), parameter :: threshold_first_guess = 1.e-5_wp    !< Threshold for initial step size estimate
    real(wp), parameter :: threshold_second_guess = 1.e-15_wp  !< Threshold for refined step size estimate
    real(wp), parameter :: scale_first_guess = 1.e-3_wp        !< Scale factor for initial step size
    real(wp), parameter :: scale_guess = 1.e-2_wp              !< Scale factor for step size adjustment
    real(wp), parameter :: small_guess = 1.e-6_wp              !< Minimum initial step size
 
    ! Relativity
    !> Max Newton-Raphson iterations for relativistic primitive recovery
    integer, parameter :: relativity_cons_to_prim_max_iter = 100
 
    ! Linear congruential pseudo-random number generator parameters
    integer, parameter  :: modulus = 2**30 - 1     !< PRNG modulus
    integer, parameter  :: multiplier = 1664525    !< PRNG multiplier
    integer, parameter  :: increment = 1013904223  !< PRNG increment
    integer, parameter  :: amplifier = 3**13       !< PRNG amplifier for mixing
    real(wp), parameter :: decimal_trim = 1.e5_wp  !< PRNG decimal truncation factor
 
    ! System constants
    integer, parameter :: case_file_error_code = 22  !< Exit code for case file validation errors
 
    ! Boundary condition enumeration Abbreviations CHAR - Characteristic NR - Non-reflecting SUB - subsonic SUP - supersonic FF -
    ! Force-free CP - Constant pressure
    integer, parameter :: bc_periodic = -1
    integer, parameter :: bc_reflective = -2
    integer, parameter :: bc_ghost_extrap = -3
    integer, parameter :: bc_riemann_extrap = -4
    integer, parameter :: bc_char_slip_wall = -5
    integer, parameter :: bc_char_nr_sub_buffer = -6
    integer, parameter :: bc_char_nr_sub_inflow = -7
    integer, parameter :: bc_char_nr_sub_outflow = -8
    integer, parameter :: bc_char_ff_sub_outflow = -9
    integer, parameter :: bc_char_cp_sub_outflow = -10
    integer, parameter :: bc_char_sup_inflow = -11
    integer, parameter :: bc_char_sup_outflow = -12
    integer, parameter :: bc_null = -13
    integer, parameter :: bc_axis = -14
    integer, parameter :: bc_slip_wall = -15
    integer, parameter :: bc_no_slip_wall = -16
    integer, parameter :: bc_dirichlet = -17
 
    !> Equation of state per fluid (eos_stiffened_gas, eos_ideal_gas, eos_mie_gruneisen, eos_jwl, eos_vinet) is generated from
    !! EOS_FAMILIES in toolchain/mfc/params/eos_families.py; see generated_constants.fpp below.
    integer, parameter :: eos_rk4_steps = 8  !< fixed-step RK4 along a phasic isentrope or a reference temperature
    integer, parameter :: ode_isentrope = 1, ode_reference_temperature = 2  !< the two ODEs s_rk4 integrates
 
    ! Synthetic turbulence array size limits
    integer, parameter :: num_synth_shells_max = 50  !< Max energy shells for synthetic turbulence
    integer, parameter :: num_turb_sources_max = 10  !< Max Gaussian forcing zones for synthetic turbulence
 
    ! Named values for enumerated case parameters (e.g. riemann_solver_hllc).
    ! AUTO-GENERATED from "names" in toolchain/mfc/params/definitions.py.
# 1 "/home/runner/work/MFC/MFC/build/include/post_process/generated_constants.fpp" 1
! AUTO-GENERATED - do not edit directly. Regenerate: cmake reconfigure
!
integer, parameter :: avg_state_roe = 1
integer, parameter :: avg_state_arithmetic = 2
integer, parameter :: bubble_model_particle = 0
integer, parameter :: bubble_model_gilmore = 1
integer, parameter :: bubble_model_keller_miksis = 2
integer, parameter :: bubble_model_rayleigh_plesset = 3
integer, parameter :: eos_stiffened_gas = 1
integer, parameter :: eos_ideal_gas = 2
integer, parameter :: eos_mie_gruneisen = 3
integer, parameter :: eos_jwl = 4
integer, parameter :: eos_vinet = 5
integer, parameter :: format_silo = 1
integer, parameter :: format_binary = 2
integer, parameter :: int_comp_off = 0
integer, parameter :: int_comp_thinc = 1
integer, parameter :: int_comp_mthinc = 2
integer, parameter :: model_eqns_gamma_law = 1
integer, parameter :: model_eqns_5eq = 2
integer, parameter :: model_eqns_6eq = 3
integer, parameter :: muscl_lim_unlimited = 0
integer, parameter :: muscl_lim_minmod = 1
integer, parameter :: muscl_lim_mc = 2
integer, parameter :: muscl_lim_van_albada = 3
integer, parameter :: muscl_lim_van_leer = 4
integer, parameter :: muscl_lim_superbee = 5
integer, parameter :: muscl_order_first_order = 1
integer, parameter :: muscl_order_second_order = 2
integer, parameter :: precision_single = 1
integer, parameter :: precision_double = 2
integer, parameter :: recon_type_weno = 1
integer, parameter :: recon_type_muscl = 2
integer, parameter :: riemann_solver_hll = 1
integer, parameter :: riemann_solver_hllc = 2
integer, parameter :: riemann_solver_hlld = 4
integer, parameter :: riemann_solver_lax_friedrichs = 5
integer, parameter :: time_stepper_rk1 = 1
integer, parameter :: time_stepper_rk2 = 2
integer, parameter :: time_stepper_rk3 = 3
integer, parameter :: wave_speeds_direct = 1
integer, parameter :: wave_speeds_pressure = 2
# 135 "/home/runner/work/MFC/MFC/src/common/m_constants.fpp" 2
end module m_constants