Merge branch 'master' into ib-collisions

Author: danieljvickers

.claude/rules/common-pitfalls.md

@@ -13,13 +13,15 @@
 
 ## Field Variable Indexing
 - Conserved variables: `q_cons_vf(1:sys_size)`. Primitive: `q_prim_vf(1:sys_size)`.
-- Index ranges depend on `model_eqns` and enabled features (set in `m_global_parameters.fpp`):
-  - `cont_idx` — continuity (partial densities, one per fluid)
-  - `mom_idx` — momentum components
-  - `E_idx` — total energy (scalar)
-  - `adv_idx` — volume fractions (advection equations)
-  - `bub_idx`, `stress_idx`, `xi_idx`, `species_idx`, `B_idx`, `c_idx` — optional
-- Shorthand scalars: `momxb`/`momxe`, `contxb`/`contxe`, `advxb`/`advxe`, etc.
+- All equation indices live in the unified `eqn_idx` struct (`eqn_idx_info` type in `m_derived_types.fpp`).
+  Index ranges depend on `model_eqns` and enabled features (set in `m_global_parameters.fpp`):
+  - `eqn_idx%cont` — continuity range (partial densities, one per fluid)
+  - `eqn_idx%mom` — momentum range
+  - `eqn_idx%E` — total energy (scalar)
+  - `eqn_idx%adv` — volume fractions (advection equations)
+  - `eqn_idx%bub`, `eqn_idx%stress`, `eqn_idx%xi`, `eqn_idx%species`, `eqn_idx%B` — optional
+  - `eqn_idx%gamma`, `eqn_idx%pi_inf`, `eqn_idx%alf`, `eqn_idx%int_en` — additional scalars/ranges
+- Use `eqn_idx%cont%beg`/`eqn_idx%cont%end`, `eqn_idx%mom%beg`/`eqn_idx%mom%end`, etc. (old `contxb`/`contxe`, `momxb`/`momxe` shorthands are gone)
 - `sys_size` = total number of conserved variables (computed at startup)
 - Changing `model_eqns` or enabling features changes ALL index positions
 

docs/documentation/architecture.md.in

@@ -49,8 +49,8 @@ The index layout within `q_cons_vf` depends on the flow model:
 ```
 For model_eqns == 2 (5-equation, multi-fluid):
 
-  Index:    1 .. num_fluids | num_fluids+1 .. +num_vels | E_idx | adv_idx
-  Meaning:  alpha*rho_k     | momentum components       | energy | volume fractions
+  Index:    1 .. num_fluids | num_fluids+1 .. +num_vels | eqn_idx%E | eqn_idx%adv
+  Meaning:  alpha*rho_k     | momentum components       | energy    | volume fractions
 ```
 
 Additional variables are appended for bubbles, elastic stress, magnetic fields, or chemistry species when those models are enabled. The total count is `sys_size`.

docs/documentation/case.md

@@ -235,7 +235,7 @@ In the example above, the following code is generated:
 
 ```f90
 if (patch_id == 2) then
-    q_prim_vf(contxb)%sf(i, 0, 0) = 1 + 0.1*sin(20*x_cc(i)*3.141592653589793)
+    q_prim_vf(eqn_idx%cont%beg)%sf(i, 0, 0) = 1 + 0.1*sin(20*x_cc(i)*3.141592653589793)
 end if
 ```
 

docs/documentation/contributing.md

@@ -334,7 +334,7 @@ do l = 0, p
     do k = 0, n
         do j = 0, m
             rho = q_prim_vf(1)%sf(j, k, l)
-            pres = q_prim_vf(E_idx)%sf(j, k, l)
+            pres = q_prim_vf(eqn_idx%E)%sf(j, k, l)
             ! ... use rho, pres as thread-local ...
         end do
     end do
@@ -369,7 +369,7 @@ do l = 0, p
         do j = 0, m
             $:GPU_LOOP(parallelism='[seq]')
             do i = 1, num_fluids
-                alpha(i) = q_prim_vf(advxb + i - 1)%sf(j, k, l)
+                alpha(i) = q_prim_vf(eqn_idx%adv%beg + i - 1)%sf(j, k, l)
             end do
         end do
     end do

docs/documentation/expectedPerformance.md

@@ -137,6 +137,7 @@ Note:
 | NVIDIA A10                | FP32-only GPU             | GPU           | 1 GPU        | 4.3              | NVHPC 24.1           | TAMU Faster |
 | AMD EPYC 7713             | Milan, Zen3               | CPU           | 64 cores     | 5.0              | GNU 12.3.0           | GT Phoenix  |
 | Intel Xeon 8480CL         | Sapphire Rapids           | CPU           | 56 cores     | 5.0              | NVHPC 24.5           | GT Phoenix  |
+| Apple M5 Pro              |                           | CPU           | 18 cores     | 5.4              | GNU 15.2.0           | N/A         |
 | Intel Xeon 6454S          | Sapphire Rapids           | CPU           | 32 cores     | 5.6              | NVHPC 24.5           | GT Rogues Gallery  |
 | Intel Xeon 8462Y+         | Sapphire Rapids           | CPU           | 32 cores     | 6.2              | GNU 12.3.0           | GT ICE  |
 | Intel Xeon 6548Y+         | Emerald Rapids            | CPU           | 32 cores     | 6.6              | Intel 2021.9         | GT ICE  |

src/common/include/1dHardcodedIC.fpp

@@ -7,12 +7,12 @@
     select case (patch_icpp(patch_id)%hcid)
     case (150)  ! 1D Smooth Alfven Case for MHD
         ! velocity
-        q_prim_vf(momxb + 1)%sf(i, 0, 0) = 0.1_wp*sin(2._wp*pi*x_cc(i))
-        q_prim_vf(momxb + 2)%sf(i, 0, 0) = 0.1_wp*cos(2._wp*pi*x_cc(i))
+        q_prim_vf(eqn_idx%mom%beg + 1)%sf(i, 0, 0) = 0.1_wp*sin(2._wp*pi*x_cc(i))
+        q_prim_vf(eqn_idx%mom%beg + 2)%sf(i, 0, 0) = 0.1_wp*cos(2._wp*pi*x_cc(i))
 
         ! magnetic field
-        q_prim_vf(B_idx%end - 1)%sf(i, 0, 0) = 0.1_wp*sin(2._wp*pi*x_cc(i))
-        q_prim_vf(B_idx%end)%sf(i, 0, 0) = 0.1_wp*cos(2._wp*pi*x_cc(i))
+        q_prim_vf(eqn_idx%B%end - 1)%sf(i, 0, 0) = 0.1_wp*sin(2._wp*pi*x_cc(i))
+        q_prim_vf(eqn_idx%B%end)%sf(i, 0, 0) = 0.1_wp*cos(2._wp*pi*x_cc(i))
     case (170)  ! 1D profile from external data (e.g. Cantera, SDtoolbox)
         ! This hardcoded case can be used to start a simulation with initial conditions given from a known 1D profile (e.g. Cantera,
         ! SDtoolbox)
@@ -21,36 +21,36 @@
         ! This is patch is hard-coded for test suite optimization used in the 1D_shuoser cases: "patch_icpp(2)%alpha_rho(1)": "1 +
         ! 0.2*sin(5*x)"
         if (patch_id == 2) then
-            q_prim_vf(contxb + 0)%sf(i, 0, 0) = 1 + 0.2*sin(5*x_cc(i))
+            q_prim_vf(eqn_idx%cont%beg + 0)%sf(i, 0, 0) = 1 + 0.2*sin(5*x_cc(i))
         end if
     case (181)  ! Titarev-Torro problem
         ! This is patch is hard-coded for test suite optimization used in the 1D_titarevtorro cases: "patch_icpp(2)%alpha_rho(1)":
         ! "1 + 0.1*sin(20*x*pi)"
-        q_prim_vf(contxb + 0)%sf(i, 0, 0) = 1 + 0.1*sin(20*x_cc(i)*pi)
+        q_prim_vf(eqn_idx%cont%beg + 0)%sf(i, 0, 0) = 1 + 0.1*sin(20*x_cc(i)*pi)
     case (182)  ! Multi-component diffusion
         ! This patch is a hard-coded for test suite optimization (multiple component diffusion)
         x_mid_diffu = 0.05_wp/2.0_wp
         width_sq = (2.5_wp*10.0_wp**(-3.0_wp))**2
         profile_shape = 1.0_wp - 0.5_wp*exp(-(x_cc(i) - x_mid_diffu)**2/width_sq)
-        q_prim_vf(momxb)%sf(i, 0, 0) = 0.0_wp
-        q_prim_vf(E_idx)%sf(i, 0, 0) = 1.01325_wp*(10.0_wp)**5
-        q_prim_vf(advxb)%sf(i, 0, 0) = 1.0_wp
+        q_prim_vf(eqn_idx%mom%beg)%sf(i, 0, 0) = 0.0_wp
+        q_prim_vf(eqn_idx%E)%sf(i, 0, 0) = 1.01325_wp*(10.0_wp)**5
+        q_prim_vf(eqn_idx%adv%beg)%sf(i, 0, 0) = 1.0_wp
 
         y1 = (0.195_wp - 0.142_wp)*profile_shape + 0.142_wp
         y2 = (0.0_wp - 0.1_wp)*profile_shape + 0.1_wp
         y3 = (0.214_wp - 0.0_wp)*profile_shape + 0.0_wp
         y4 = (0.591_wp - 0.758_wp)*profile_shape + 0.758_wp
 
-        q_prim_vf(chemxb)%sf(i, 0, 0) = y1
-        q_prim_vf(chemxb + 1)%sf(i, 0, 0) = y2
-        q_prim_vf(chemxb + 2)%sf(i, 0, 0) = y3
-        q_prim_vf(chemxb + 3)%sf(i, 0, 0) = y4
+        q_prim_vf(eqn_idx%species%beg)%sf(i, 0, 0) = y1
+        q_prim_vf(eqn_idx%species%beg + 1)%sf(i, 0, 0) = y2
+        q_prim_vf(eqn_idx%species%beg + 2)%sf(i, 0, 0) = y3
+        q_prim_vf(eqn_idx%species%beg + 3)%sf(i, 0, 0) = y4
 
         temp = (320.0_wp - 1350.0_wp)*profile_shape + 1350.0_wp
 
         molar_mass_inv = y1/31.998_wp + y2/18.01508_wp + y3/16.04256_wp + y4/28.0134_wp
 
-        q_prim_vf(contxb)%sf(i, 0, 0) = 1.01325_wp*(10.0_wp)**5/(temp*8.3144626_wp*1000.0_wp*molar_mass_inv)
+        q_prim_vf(eqn_idx%cont%beg)%sf(i, 0, 0) = 1.01325_wp*(10.0_wp)**5/(temp*8.3144626_wp*1000.0_wp*molar_mass_inv)
     case default
         call s_int_to_str(patch_id, iStr)
         call s_mpi_abort("Invalid hcid specified for patch " // trim(iStr))