Docs @ 8551f17

Author: MFC Action

documentation/architecture.html

@@ -273,38 +273,40 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md7"></a>
 <tr class="markdownTableHead">
 <th class="markdownTableHeadNone">Module  </th><th class="markdownTableHeadNone">Role  </th></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">m_viscous</span>  </td><td class="markdownTableBodyNone">Computes viscous stress tensors and diffusive flux contributions for the Navier&ndash;Stokes equations  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_eos</span>  </td><td class="markdownTableBodyNone">Equations of state in Gamma/Pi form, rho e = Gamma(rho) p + Pi(rho)  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">m_hb_function</span>  </td><td class="markdownTableBodyNone">Herschel-Bulkley non-Newtonian viscosity: formula, shear rate, and mixture inverse-Re  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_viscous</span>  </td><td class="markdownTableBodyNone">Computes viscous stress tensors and diffusive flux contributions for the Navier&ndash;Stokes equations  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">m_surface_tension</span>  </td><td class="markdownTableBodyNone">Computes capillary source fluxes and color-function gradients for the diffuse-interface surface tension model  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_hb_function</span>  </td><td class="markdownTableBodyNone">Herschel-Bulkley non-Newtonian viscosity: formula, shear rate, and mixture inverse-Re  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">m_reactive_burn</span>  </td><td class="markdownTableBodyNone">Condensed-phase reactive burn: a pressure-driven programmed-burn source that converts a "reactant" fluid into a "product" fluid on the multi-fluid model (num_fluids=2, chemistry='F')  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_surface_tension</span>  </td><td class="markdownTableBodyNone">Computes capillary source fluxes and color-function gradients for the diffuse-interface surface tension model  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">m_bubbles</span>  </td><td class="markdownTableBodyNone">Bubble-dynamics procedures for ensemble- and volume-averaged model  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_reactive_burn</span>  </td><td class="markdownTableBodyNone">Condensed-phase reactive burn: a pressure-driven programmed-burn source that converts a "reactant" fluid into a "product" fluid on the multi-fluid model (num_fluids=2, chemistry='F')  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EE</span>  </td><td class="markdownTableBodyNone">Computes ensemble-averaged (Euler&ndash;Euler) bubble source terms for radius, velocity, pressure, and mass transfer  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_bubbles</span>  </td><td class="markdownTableBodyNone">Bubble-dynamics procedures for ensemble- and volume-averaged model  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL</span>  </td><td class="markdownTableBodyNone">Tracks Lagrangian bubbles and couples their dynamics to the Eulerian flow via volume averaging  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EE</span>  </td><td class="markdownTableBodyNone">Computes ensemble-averaged (Euler&ndash;Euler) bubble source terms for radius, velocity, pressure, and mass transfer  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL_kernels</span>  </td><td class="markdownTableBodyNone">Kernel functions (Gaussian, delta) that smear Lagrangian bubble effects onto the Eulerian grid  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL</span>  </td><td class="markdownTableBodyNone">Tracks Lagrangian bubbles and couples their dynamics to the Eulerian flow via volume averaging  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">m_qbmm</span>  </td><td class="markdownTableBodyNone">Quadrature-based moment methods (QBMM) for polydisperse bubble moment inversion and transport  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL_kernels</span>  </td><td class="markdownTableBodyNone">Kernel functions (Gaussian, delta) that smear Lagrangian bubble effects onto the Eulerian grid  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">m_hypoelastic</span>  </td><td class="markdownTableBodyNone">Computes hypoelastic stress-rate source terms and damage-state evolution  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_qbmm</span>  </td><td class="markdownTableBodyNone">Quadrature-based moment methods (QBMM) for polydisperse bubble moment inversion and transport  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">m_phase_change</span>  </td><td class="markdownTableBodyNone">Phase transition relaxation solvers for liquid-vapor flows with cavitation and boiling  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_hypoelastic</span>  </td><td class="markdownTableBodyNone">Computes hypoelastic stress-rate source terms and damage-state evolution  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">m_chemistry</span>  </td><td class="markdownTableBodyNone">Multi-species chemistry interface for thermodynamic properties, reaction rates, and transport coefficients  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_phase_change</span>  </td><td class="markdownTableBodyNone">Phase transition relaxation solvers for liquid-vapor flows with cavitation and boiling  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">m_conduction</span>  </td><td class="markdownTableBodyNone">Fourier heat conduction, div(k grad T), as a face-centered source flux on the energy equation  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_chemistry</span>  </td><td class="markdownTableBodyNone">Multi-species chemistry interface for thermodynamic properties, reaction rates, and transport coefficients  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">m_acoustic_src</span>  </td><td class="markdownTableBodyNone">One-way acoustic source injection, Maeda and Colonius JCP (2017)  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_conduction</span>  </td><td class="markdownTableBodyNone">Fourier heat conduction, div(k grad T), as a face-centered source flux on the energy equation  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">m_body_forces</span>  </td><td class="markdownTableBodyNone">Computes gravitational and body force source terms for the momentum equations  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_acoustic_src</span>  </td><td class="markdownTableBodyNone">One-way acoustic source injection, Maeda and Colonius JCP (2017)  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">m_pressure_relaxation</span>  </td><td class="markdownTableBodyNone">Pressure relaxation for the six-equation multi-component model via Newton&ndash;Raphson equilibration and volume-fraction correction  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_body_forces</span>  </td><td class="markdownTableBodyNone">Computes gravitational and body force source terms for the momentum equations  </td></tr>
 <tr class="markdownTableRowOdd">
+<td class="markdownTableBodyNone"><span class="tt">m_pressure_relaxation</span>  </td><td class="markdownTableBodyNone">Pressure relaxation for the six-equation multi-component model via Newton&ndash;Raphson equilibration and volume-fraction correction  </td></tr>
+<tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><span class="tt">m_collisions</span>  </td><td class="markdownTableBodyNone">Ghost-node immersed boundary method: locates ghost/image points, computes interpolation coefficients, and corrects the flow state  </td></tr>
 </table>
 <h2 class="doxsection"><a class="anchor" id="autotoc_md8"></a>
@@ -431,7 +433,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
 <li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
 </ol>
 <p>Follow the pattern of existing modules like <span class="tt">m_body_forces</span> (simple) or <span class="tt">m_viscous</span> (more involved) as a template.</p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-20</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-21</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/case_constraints.html

@@ -1550,7 +1550,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 <li>Choices: <span class="tt">1</span> = direct, <span class="tt">2</span> = pressure</li>
 </ul>
 <p><b>Requirements</b> (errors):</p><ul>
-<li>a state-dependent eos (mie_gruneisen, jwl, vinet) requires wave_speeds = 1 (the PVRS estimate is stiffened-gas only)</li>
+<li>a state-dependent eos (state_dependent_names) requires wave_speeds = 1 (the PVRS estimate is stiffened-gas only)</li>
 <li>wave_speeds must be set for riemann_solver 1, 2, or 4</li>
 <li>6-equation model (model_eqns = 3) requires wave_speeds = 1</li>
 </ul>
@@ -1616,7 +1616,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
 </table>
 <hr  />
 <p>💡 <b>Tip:</b> If you encounter a validation error, check the relevant section above or review <a href="https://github.com/MFlowCode/MFC/blob/master/toolchain/mfc/case_validator.py"><span class="tt">case_validator.py</span></a> for complete validation logic.</p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-20</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-21</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

@@ -991,7 +991,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
 Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
 <p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-20</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-21</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">