Refactor variable conversion into common code

sbryngelson · sbryngelson · commit b6bf034c0daa · 2026-07-25T20:52:08.000-04:00
diff --git a/src/common/m_global_parameters_common.fpp b/src/common/m_global_parameters_common.fpp
@@ -64,6 +64,29 @@ module m_global_parameters_common
     integer, dimension(3, 2) :: shear_BC_flip_indices  !< Shear stress BC reflection indices (1:3, 1:shear_BC_flip_num)
     !> @}
 
+    !> @name Material properties derived from fluid_pp
+    !> @{ One declaration is shared by all executables and initialized by m_variables_conversion after the case parameters have been
+    !! read.
+    real(wp), allocatable, dimension(:) :: gammas, gs_min, pi_infs, ps_inf, cvs, qvs, qvps
+    $:GPU_DECLARE(create='[gammas, gs_min, pi_infs, ps_inf, cvs, qvs, qvps]')
+    !> @}
+
+    !> @name Fluids participating in shear and bulk viscosity
+    !> @{
+    integer, dimension(2)                :: Re_size = 0
+    integer                              :: Re_size_max = 0
+    integer, allocatable, dimension(:,:) :: Re_idx
+    $:GPU_DECLARE(create='[Re_size, Re_size_max, Re_idx]')
+    !> @}
+
+    !> @name Working-direction index mapping
+    !> @{
+    integer, dimension(3)  :: dir_idx
+    real(wp), dimension(3) :: dir_flg
+    integer, dimension(3)  :: dir_idx_tau
+    $:GPU_DECLARE(create='[dir_idx, dir_flg, dir_idx_tau]')
+    !> @}
+
 #ifdef MFC_SIMULATION
     $:GPU_DECLARE(create='[sys_size, eqn_idx, b_size, tensor_size]')
     $:GPU_DECLARE(create='[shear_num, shear_indices, shear_BC_flip_num, shear_BC_flip_indices]')
@@ -434,6 +457,8 @@ contains
             igr_order = dflt_int
             mhd = .false.
             relativity = .false.
+            viscous = .false.
+            riemann_solver = dflt_int
         #:endif
 
         ! Tait EOS
@@ -464,6 +489,12 @@ contains
         down_sample = .false.
         fft_wrt = .false.
 
+        ! Mixture conversion and sound-speed behavior
+        avg_state = dflt_int
+        alt_soundspeed = .false.
+        mixture_err = .false.
+        sigR = dflt_real
+
     end subroutine s_assign_common_defaults
 
 end module m_global_parameters_common
diff --git a/src/common/m_variables_conversion.fpp b/src/common/m_variables_conversion.fpp
diff --git a/src/post_process/m_global_parameters.fpp b/src/post_process/m_global_parameters.fpp
@@ -190,10 +190,6 @@ contains
         t_save = dflt_real
         t_stop = dflt_real
 
-        ! Simulation algorithm parameters (post-specific)
-        mixture_err = .false.
-        alt_soundspeed = .false.
-
         bc_io = .false.
         num_bc_patches = dflt_int
 
@@ -298,11 +294,9 @@ contains
         schlieren_alpha = dflt_real
 
         fd_order = dflt_int
-        avg_state = dflt_int
 
         ! Bubble modeling (post-specific)
         nb = dflt_int
-        sigR = dflt_real
 
         ! Output partial domain (post-specific)
         output_partial_domain = .false.
diff --git a/src/post_process/m_start_up.fpp b/src/post_process/m_start_up.fpp
@@ -781,7 +781,7 @@ contains
             call s_initialize_mpi_common_module()
         end if
         call s_initialize_boundary_common_module()
-        call s_initialize_variables_conversion_module()
+        call s_initialize_variables_conversion_module(store_mixture_fields=.true., lagrange_beta_index=beta_idx)
         call s_initialize_data_input_module()
         call s_initialize_derived_variables_module()
         call s_initialize_data_output_module()
diff --git a/src/pre_process/m_global_parameters.fpp b/src/pre_process/m_global_parameters.fpp
@@ -184,7 +184,6 @@ contains
         pre_stress = .false.
 
         precision = 2
-        viscous = .false.
         mixlayer_vel_profile = .false.
         mixlayer_vel_coef = 1._wp
         mixlayer_perturb = .false.
@@ -318,7 +317,6 @@ contains
         Web = dflt_real
 
         nmom = 1
-        sigR = dflt_real
         sigV = dflt_real
         rhoRV = 0._wp
         dist_type = dflt_int
diff --git a/src/simulation/m_bubbles_EL.fpp b/src/simulation/m_bubbles_EL.fpp
@@ -659,7 +659,7 @@ contains
 
             ! Obtain liquid density and computing speed of sound from pinf
             call s_compute_species_fraction(q_prim_vf, cell(1), cell(2), cell(3), myalpha_rho, myalpha)
-            call s_convert_species_to_mixture_variables_acc(myRho, gamma, pi_inf, qv, myalpha, myalpha_rho, Re)
+            call s_convert_species_to_mixture_variables_kernel(myRho, gamma, pi_inf, qv, myalpha, myalpha_rho, Re)
             call s_compute_cson_from_pinf(q_prim_vf, myPinf, cell, myRho, gamma, pi_inf, myCson)
 
             ! Adaptive time stepping
diff --git a/src/simulation/m_cbc.fpp b/src/simulation/m_cbc.fpp
@@ -624,7 +624,7 @@ contains
                             adv_local(i) = q_prim_rs${XYZ}$_vf(0, k, r, eqn_idx%E + i)
                         end do
 
-                        call s_convert_species_to_mixture_variables_acc(rho, gamma, pi_inf, qv, adv_local, alpha_rho, Re_cbc)
+                        call s_convert_species_to_mixture_variables_kernel(rho, gamma, pi_inf, qv, adv_local, alpha_rho, Re_cbc)
 
                         $:GPU_LOOP(parallelism='[seq]')
                         do i = 1, eqn_idx%cont%end
diff --git a/src/simulation/m_global_parameters.fpp b/src/simulation/m_global_parameters.fpp
@@ -150,16 +150,6 @@ module m_global_parameters
     type(int_bounds_info) :: idwbuff(1:3)
     $:GPU_DECLARE(create='[idwbuff]')
 
-    !> @name The number of fluids, along with their identifying indexes, respectively, for which viscous effects, e.g. the shear
-    !! and/or the volume Reynolds (Re) numbers, will be non-negligible.
-    !> @{
-    integer, dimension(2)                :: Re_size
-    integer                              :: Re_size_max
-    integer, allocatable, dimension(:,:) :: Re_idx
-    !> @}
-
-    $:GPU_DECLARE(create='[Re_size, Re_size_max, Re_idx]')
-
     !> @name Herschel-Bulkley non-Newtonian viscosity: per-fluid flags and parameter arrays.
     !> @{
     logical                             :: any_non_newtonian  !< .true. if any fluid is non-Newtonian
@@ -178,17 +168,6 @@ module m_global_parameters
 
     $:GPU_DECLARE(create='[wa_flg]')
 
-    !> @name The coordinate direction indexes and flags (flg), respectively, for which the configurations will be determined with
-    !! respect to a working direction and that will be used to isolate the contributions, in that direction, in the dimensionally
-    !! split system of equations.
-    !> @{
-    integer, dimension(3)  :: dir_idx
-    real(wp), dimension(3) :: dir_flg
-    integer, dimension(3)  :: dir_idx_tau  !< used for hypoelasticity=true
-    !> @}
-
-    $:GPU_DECLARE(create='[dir_idx, dir_flg, dir_idx_tau]')
-
     integer :: buff_size  !< Number of ghost cells for boundary condition storage
     $:GPU_DECLARE(create='[buff_size]')
 
@@ -280,9 +259,6 @@ module m_global_parameters
     !> @{
     !> @}
 
-    real(wp), allocatable, dimension(:) :: gammas, gs_min, pi_infs, ps_inf, cvs, qvs, qvps
-    $:GPU_DECLARE(create='[gammas, gs_min, pi_infs, ps_inf, cvs, qvs, qvps]')
-
     real(wp)                                    :: mytime     !< Current simulation time
     real(wp)                                    :: finaltime  !< Final simulation time
     type(pres_field), allocatable, dimension(:) :: pb_ts
@@ -378,13 +354,9 @@ contains
         mp_weno = .false.
         weno_avg = .false.
         weno_Re_flux = .false.
-        riemann_solver = dflt_int
         low_Mach = 0
         wave_speeds = dflt_int
-        avg_state = dflt_int
-        alt_soundspeed = .false.
         null_weights = .false.
-        mixture_err = .false.
         precision = 2
         palpha_eps = dflt_real
         ptgalpha_eps = dflt_real
@@ -407,7 +379,6 @@ contains
             wenoz_q = dflt_real
             igr_order = dflt_int
             igr_pres_lim = .false.
-            viscous = .false.
             igr_iter_solver = 1
         #:endif
 
diff --git a/src/simulation/m_hyperelastic.fpp b/src/simulation/m_hyperelastic.fpp
@@ -101,7 +101,7 @@ contains
                     call s_compute_species_fraction(q_cons_vf, j, k, l, alpha_rho_k, alpha_k)
 
                     ! If in simulation, use acc mixture subroutines
-                    call s_convert_species_to_mixture_variables_acc(rho, gamma, pi_inf, qv, alpha_k, alpha_rho_k, Re, G_local, &
+                    call s_convert_species_to_mixture_variables_kernel(rho, gamma, pi_inf, qv, alpha_k, alpha_rho_k, Re, G_local, &
                         & Gs_hyper)
                     rho = max(rho, sgm_eps)
                     G_local = max(G_local, sgm_eps)
diff --git a/src/simulation/m_ibm.fpp b/src/simulation/m_ibm.fpp
@@ -296,10 +296,10 @@ contains
                 if (model_eqns /= model_eqns_4eq) then
                     ! If in simulation, use acc mixture subroutines
                     if (elasticity) then
-                        call s_convert_species_to_mixture_variables_acc(rho, gamma, pi_inf, qv_K, alpha_IP, alpha_rho_IP, Re_K, &
-                            & G_K, Gs)
+                        call s_convert_species_to_mixture_variables_kernel(rho, gamma, pi_inf, qv_K, alpha_IP, alpha_rho_IP, &
+                            & Re_K, G_K, Gs)
                     else
-                        call s_convert_species_to_mixture_variables_acc(rho, gamma, pi_inf, qv_K, alpha_IP, alpha_rho_IP, Re_K)
+                        call s_convert_species_to_mixture_variables_kernel(rho, gamma, pi_inf, qv_K, alpha_IP, alpha_rho_IP, Re_K)
                     end if
                 end if
 
diff --git a/src/simulation/m_sim_helpers.fpp b/src/simulation/m_sim_helpers.fpp
@@ -97,9 +97,9 @@ contains
         call s_compute_species_fraction(q_prim_vf, j, k, l, alpha_rho, alpha)
 
         if (elasticity) then
-            call s_convert_species_to_mixture_variables_acc(rho, gamma, pi_inf, qv, alpha, alpha_rho, Re, G_local, Gs)
+            call s_convert_species_to_mixture_variables_kernel(rho, gamma, pi_inf, qv, alpha, alpha_rho, Re, G_local, Gs)
         else
-            call s_convert_species_to_mixture_variables_acc(rho, gamma, pi_inf, qv, alpha, alpha_rho, Re)
+            call s_convert_species_to_mixture_variables_kernel(rho, gamma, pi_inf, qv, alpha, alpha_rho, Re)
         end if
 
         if (igr) then
diff --git a/src/simulation/m_start_up.fpp b/src/simulation/m_start_up.fpp
@@ -816,7 +816,7 @@ contains
         end if
         call s_initialize_mpi_common_module()
         call s_initialize_mpi_proxy_module()
-        call s_initialize_variables_conversion_module()
+        call s_initialize_variables_conversion_module(enforce_density_floor=.true., preserve_qbmm_number=.true.)
         if (grid_geometry == 3) call s_initialize_fftw_module()
 
         if (bubbles_euler) call s_initialize_bubbles_EE_module()
diff --git a/toolchain/mfc/params/definitions.py b/toolchain/mfc/params/definitions.py
@@ -1160,6 +1160,11 @@ def _init_registry():
 
 NAMELIST_VARS: dict[str, set[str]] = {}
 
+# Some common modules are compiled into every executable even though the
+# corresponding user input remains meaningful in only a subset of namelists.
+# Keep declaration visibility separate from input acceptance.
+DECLARATION_TARGETS: dict[str, set[str]] = {}
+
 # Maps indexed-family base names to their Fortran dimension expression.
 # The generator emits `{type}, dimension({dim}) :: {name}` for each entry.
 # Add here whenever a new array param needs no manual Fortran declaration.
@@ -1207,12 +1212,19 @@ def _nv(targets: set, *names: str) -> None:
         NAMELIST_VARS[n] = set(targets)
 
 
+def _decl(targets: set, *names: str) -> None:
+    for n in names:
+        DECLARATION_TARGETS[n] = set(targets)
+
+
 _ALL, _PRE_SIM, _SIM_POST = {"pre", "sim", "post"}, {"pre", "sim"}, {"sim", "post"}
 _PRE_POST = {"pre", "post"}
 _SIM = {"sim"}
 _PRE = {"pre"}
 _POST = {"post"}
 
+_decl(_ALL, "avg_state", "alt_soundspeed", "mixture_err", "sigR", "viscous", "riemann_solver")
+
 _nv(
     _ALL,
     "m",
@@ -1271,12 +1283,12 @@ def _nv(targets: set, *names: str) -> None:
     "t_stop",
     "t_save",
     "cfl_target",
-    "avg_state",
     "prim_vars_wrt",
-    "alt_soundspeed",
-    "mixture_err",
     "fd_order",
     "ib_state_wrt",
+    "avg_state",
+    "alt_soundspeed",
+    "mixture_err",
 )
 _nv(
     _PRE_SIM,
@@ -1286,7 +1298,7 @@ def _nv(targets: set, *names: str) -> None:
     "patch_ib",
     "pi_fac",
 )
-_nv(_PRE_POST, "num_fluids", "weno_order", "recon_type", "muscl_order", "mhd", "nb", "sigR", "igr", "igr_order")
+_nv(_PRE_POST, "num_fluids", "weno_order", "recon_type", "muscl_order", "mhd", "nb", "igr", "igr_order", "sigR")
 _nv(_ALL, "reactive_burn", "rburn")
 _nv(_PRE_SIM, "ib_airfoil")
 _nv(_PRE_SIM, "stl_models", "num_stl_models")
@@ -1309,7 +1321,6 @@ def _nv(targets: set, *names: str) -> None:
     "int_comp",
     "ic_eps",
     "ic_beta",
-    "riemann_solver",
     "wave_speeds",
     "low_Mach",
     "hyper_cleaning_speed",
@@ -1374,6 +1385,7 @@ def _nv(targets: set, *names: str) -> None:
     "nv_uvm_out_of_core",
     "nv_uvm_igr_temps_on_gpu",
     "nv_uvm_pref_gpu",
+    "riemann_solver",
 )
 _nv(
     _PRE,
@@ -1402,7 +1414,6 @@ def _nv(targets: set, *names: str) -> None:
     "sigV",
     "dist_type",
     "rhoRV",
-    "viscous",
     "old_grid",
     "old_ic",
     "perturb_flow",
@@ -1423,6 +1434,7 @@ def _nv(targets: set, *names: str) -> None:
     "simplex_params",
     "files_dir",
     "file_extension",
+    "viscous",
 )
 _nv(
     _POST,
diff --git a/toolchain/mfc/params/generators/fortran_gen.py b/toolchain/mfc/params/generators/fortran_gen.py
@@ -3,7 +3,7 @@
 from pathlib import Path
 from typing import List, Tuple
 
-from ..definitions import CASE_OPT_PARAMS, FORTRAN_ARRAY_DIMS, NAMELIST_VARS, TYPED_DECLS  # noqa: F401 - triggers registry population
+from ..definitions import CASE_OPT_PARAMS, DECLARATION_TARGETS, FORTRAN_ARRAY_DIMS, NAMELIST_VARS, TYPED_DECLS  # noqa: F401 - triggers registry population
 from ..registry import REGISTRY
 from ..schema import ParamDef, ParamType
 
@@ -59,6 +59,12 @@ def _vars_for_target(target: str) -> List[str]:
     return sorted(v for v, ts in NAMELIST_VARS.items() if target in ts)
 
 
+def _decl_vars_for_target(target: str) -> List[str]:
+    namelist_vars = {v for v, targets in NAMELIST_VARS.items() if target in targets}
+    common_module_vars = {v for v, targets in DECLARATION_TARGETS.items() if target in targets}
+    return sorted(namelist_vars | common_module_vars)
+
+
 def _pack_namelist(vars_list: List[str], first_prefix: str, cont_prefix: str, max_line: int) -> List[str]:
     """Pack variable names into Fortran continuation lines; all but last end with ', &'."""
     if not vars_list:
@@ -111,7 +117,7 @@ def generate_decls_fpp(target: str) -> str:
     """Return Fortran declarations (scalars + known arrays) for a target."""
     _check_target(target)
     lines = [_HEADER.rstrip()]
-    for name in _vars_for_target(target):
+    for name in _decl_vars_for_target(target):
         if not _is_simple_scalar(name):
             continue
         if target == "sim" and name in CASE_OPT_PARAMS:
diff --git a/toolchain/mfc/params_tests/test_fortran_gen.py b/toolchain/mfc/params_tests/test_fortran_gen.py
@@ -117,6 +117,31 @@ def test_decls_dt_for_sim():
     assert "real(wp)                :: dt" in generate_decls_fpp("sim")
 
 
+def test_common_module_decls_do_not_expand_namelists():
+    from mfc.params.definitions import NAMELIST_VARS
+    from mfc.params.generators.fortran_gen import generate_decls_fpp, generate_namelist_fpp
+
+    common_decls = ("avg_state", "alt_soundspeed", "mixture_err", "sigR", "riemann_solver")
+    for target in ("pre", "sim", "post"):
+        declarations = generate_decls_fpp(target)
+        for name in common_decls:
+            assert f":: {name}" in declarations
+
+    # Viscous is a case-optimization parameter, so simulation declares it in
+    # generated_case_opt_decls.fpp instead of generated_decls.fpp.
+    assert ":: viscous" in generate_decls_fpp("pre")
+    assert ":: viscous" in generate_decls_fpp("post")
+
+    assert "riemann_solver" not in generate_namelist_fpp("pre")
+    assert "riemann_solver" not in generate_namelist_fpp("post")
+    assert NAMELIST_VARS["avg_state"] == {"sim", "post"}
+    assert NAMELIST_VARS["alt_soundspeed"] == {"sim", "post"}
+    assert NAMELIST_VARS["mixture_err"] == {"sim", "post"}
+    assert NAMELIST_VARS["sigR"] == {"pre", "post"}
+    assert NAMELIST_VARS["viscous"] == {"pre", "sim"}
+    assert NAMELIST_VARS["riemann_solver"] == {"sim"}
+
+
 def test_decls_no_percent_vars():
     from mfc.params.generators.fortran_gen import generate_decls_fpp
 
