Docs @ a125c4c

Author: MFC Action

documentation/architecture.html

@@ -427,7 +427,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-08-09</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-10</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/case.html

@@ -275,10 +275,6 @@ <h3 class="doxsection"><a class="anchor" id="sec-computational-domain"></a>
 <td class="markdownTableBodyRight"><span class="tt">n</span>  </td><td class="markdownTableBodyCenter">Integer  </td><td class="markdownTableBodyLeft">Number of grid cells in the $y$-coordinate direction  </td></tr>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyRight"><span class="tt">p</span>  </td><td class="markdownTableBodyCenter">Integer  </td><td class="markdownTableBodyLeft">Number of grid cells in the $z$-coordinate direction  </td></tr>
-<tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight"><span class="tt">pref</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Reference pressure  </td></tr>
-<tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight"><span class="tt">rhoref</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Reference density  </td></tr>
 </table>
 <p>The parameters define the boundaries of the spatial and temporal domains, and their discretization that are used in simulation.</p>
 <ul>
@@ -606,7 +602,7 @@ <h3 class="doxsection"><a class="anchor" id="sec-simulation-algorithm"></a>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%ve[1,2,3]</span>‡  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Velocity in the (x,1), (y, 2), (z,3) direction applied to <span class="tt">bc_[x,y,z]%end</span>  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight"><span class="tt">model_eqns</span>  </td><td class="markdownTableBodyCenter">Integer  </td><td class="markdownTableBodyLeft">Multicomponent model: [1] \(\Gamma/\Pi_\infty\); [2] 5-equation; [3] 6-equation; [4] 4-equation  </td></tr>
+<td class="markdownTableBodyRight"><span class="tt">model_eqns</span>  </td><td class="markdownTableBodyCenter">Integer  </td><td class="markdownTableBodyLeft">Multicomponent model: [1] \(\Gamma/\Pi_\infty\); [2] 5-equation; [3] 6-equation  </td></tr>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyRight"><span class="tt">alt_soundspeed</span> *  </td><td class="markdownTableBodyCenter">Logical  </td><td class="markdownTableBodyLeft">Alternate sound speed and \(K \nabla \cdot u\) for 5-equation model  </td></tr>
 <tr class="markdownTableRowEven">
@@ -1036,10 +1032,6 @@ <h3 class="doxsection"><a class="anchor" id="sec-bubble-models"></a>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyRight"><span class="tt">Re_inv</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Inverse Reynolds number  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight"><span class="tt">pref</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Reference pressure for bubble models  </td></tr>
-<tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight"><span class="tt">rhoref</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Reference density for bubble models  </td></tr>
-<tr class="markdownTableRowOdd">
 <td class="markdownTableBodyRight"><span class="tt">fluid_rho</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Reference fluid density  </td></tr>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyRight"><span class="tt">bub_pp%R0ref</span>*†‡  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Reference bubble radius  </td></tr>

documentation/case_constraints.html

@@ -540,16 +540,6 @@ <h2 class="doxsection"><a class="anchor" id="model-equations"></a>
 <li><b>Note:</b> Not compatible with bubbles or 3D cylindrical </li>
 </ul>
 </details>
-<details >
-<summary >
-<b>Model 4: 4-Equation</b></summary>
-<p></p>
-<ul>
-<li><b>Use for:</b> Single-component flows with bubbles</li>
-<li><b>Value:</b> <span class="tt">model_eqns = 4</span></li>
-<li><b>Requirements:</b> Set <span class="tt">rhoref</span>, Set <span class="tt">pref</span>, <span class="tt">num_fluids</span> = <span class="tt">1</span> (1) </li>
-</ul>
-</details>
 <h2 class="doxsection"><a class="anchor" id="riemann-solvers"></a>
 ⚙️ Riemann Solvers</h2>
 <table class="markdownTable">
@@ -571,7 +561,7 @@ <h2 class="doxsection"><a class="anchor" id="bubble-models"></a>
 <b>Euler-Euler (<span class="tt">bubbles_euler</span>)</b></summary>
 <p></p>
 <p><b>Requirements:</b></p><ul>
-<li><span class="tt">model_eqns</span> = <span class="tt">2</span> (5-Equation) or <span class="tt">4</span> (4-Equation)</li>
+<li><span class="tt">model_eqns</span> = <span class="tt">2</span> (5-Equation)</li>
 <li><span class="tt">riemann_solver</span> = <span class="tt">2</span> (HLLC)</li>
 <li><span class="tt">avg_state</span> = <span class="tt">2</span> (arithmetic)</li>
 <li>Recommended to also set: <span class="tt">nb</span>, <span class="tt">polytropic</span></li>
@@ -690,7 +680,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 <b>Euler-Euler Bubble Model</b> (<span class="tt">bubbles_euler</span>)</summary>
 <p></p>
 <p><b>Dependencies:</b></p><ul>
-<li>When enabled, requires <span class="tt">model_eqns</span> = <span class="tt">2</span> (5-Equation) or <span class="tt">4</span> (4-Equation), <span class="tt">riemann_solver</span> = <span class="tt">2</span> (HLLC), <span class="tt">avg_state</span> = <span class="tt">2</span> (arithmetic)</li>
+<li>When enabled, requires <span class="tt">model_eqns</span> = <span class="tt">2</span> (5-Equation), <span class="tt">riemann_solver</span> = <span class="tt">2</span> (HLLC), <span class="tt">avg_state</span> = <span class="tt">2</span> (arithmetic)</li>
 <li>When enabled, recommends: <span class="tt">nb</span>, <span class="tt">polytropic</span></li>
 </ul>
 <p><b>Requirements</b> (errors):</p><ul>
@@ -880,26 +870,24 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 <b>Model Equations</b> (<span class="tt">model_eqns</span>)</summary>
 <p></p>
 <p><b>Schema constraints:</b></p><ul>
-<li>Choices: <span class="tt">1</span> = Gamma-law, <span class="tt">2</span> = 5-Equation, <span class="tt">3</span> = 6-Equation, <span class="tt">4</span> = 4-Equation</li>
+<li>Choices: <span class="tt">1</span> = Gamma-law, <span class="tt">2</span> = 5-Equation, <span class="tt">3</span> = 6-Equation</li>
 </ul>
 <p><b>Dependencies:</b></p><ul>
 <li>When = 2, requires: <span class="tt">num_fluids</span></li>
 <li>When = 3, requires <span class="tt">riemann_solver</span> = <span class="tt">2</span> (HLLC), <span class="tt">avg_state</span> = <span class="tt">2</span> (arithmetic), <span class="tt">wave_speeds</span> = <span class="tt">1</span> (direct)</li>
-<li>When = 4, requires: <span class="tt">rhoref</span>, <span class="tt">pref</span></li>
-<li>When = 4, requires <span class="tt">num_fluids</span> = <span class="tt">1</span> (1)</li>
 </ul>
 <p><b>Requirements</b> (errors):</p><ul>
 <li>5-equation model (model_eqns = 2) requires num_fluids to be set</li>
 <li>6-equation model (model_eqns = 3) requires num_fluids to be set</li>
-<li>4-equation model (model_eqns = 4) requires num_fluids to be set</li>
+<li>hypoelasticity requires model_eqns = 2</li>
 </ul>
 <p><b>Incompatibilities</b> (errors):</p><ul>
 <li>num_fluids is not supported for model_eqns = 1</li>
 <li>model_eqns = 1 does not support mpp_lim</li>
 <li>6-equation model (model_eqns = 3) does not support cylindrical coordinates (cyl_coord = T and p != 0)</li>
 </ul>
 <p><b>Valid values</b> (errors):</p><ul>
-<li>model_eqns must be 1, 2, 3, or 4</li>
+<li>model_eqns must be 1, 2, or 3</li>
 </ul>
 <p></p>
 </details>
@@ -985,7 +973,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 <p><b>Requirements</b> (errors):</p><ul>
 <li>5-equation model (model_eqns = 2) requires num_fluids to be set</li>
 <li>6-equation model (model_eqns = 3) requires num_fluids to be set</li>
-<li>4-equation model (model_eqns = 4) requires num_fluids to be set</li>
+<li>int_comp &gt; 0 requires num_fluids = 2</li>
 </ul>
 <p><b>Incompatibilities</b> (errors):</p><ul>
 <li>num_fluids is not supported for model_eqns = 1</li>
@@ -1460,7 +1448,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-08-09</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-10</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

@@ -999,7 +999,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md82"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md83"></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-08-09</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-10</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/contributing.html

@@ -348,7 +348,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md101"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md102"></a>
 Physics and Model Consistency</h3>
 <ul>
-<li><b>Pressure formula</b> must match <span class="tt">model_eqns</span> value. Model 2/3 (multi-fluid), model 4 (bubbles), MHD, and hypoelastic each use different EOS formulations. Wrong formula = wrong physics.</li>
+<li><b>Pressure formula</b> must match <span class="tt">model_eqns</span> value. Model 2/3 (multi-fluid), MHD, and hypoelastic each use different EOS formulations. Wrong formula = wrong physics.</li>
 <li><b>Conservative-primitive conversion:</b> Density recovery, kinetic energy, and pressure each have model-specific paths. Verify the correct branch is taken.</li>
 <li><b>Volume fractions</b> must sum to 1. <span class="tt">alpha_rho_K</span> must be non-negative. Species mass fractions should be clipped to [0,1].</li>
 <li><b>Boundary conditions:</b> Periodic BCs must match at both ends (<span class="tt">bc_x%beg</span> and <span class="tt">bc_x%end</span>). Cylindrical coordinates have special requirements (<span class="tt">bc_y%beg = -14</span> for axis in 3D).</li>

documentation/equations.html

@@ -175,7 +175,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md143"></a>
 <li>\(\mathbf{h}(\mathbf{q})\,\nabla \cdot \mathbf{u}\) contains non-conservative terms (volume fraction advection),</li>
 <li>\(\mathbf{s}(\mathbf{q})\) is the source vector (bubbles, body forces, chemistry, etc.).</li>
 </ul>
-<p>The parameter <span class="tt">model_eqns</span> (1, 2, 3, or 4) selects the governing equation set.</p>
+<p>The parameter <span class="tt">model_eqns</span> (1, 2, or 3) selects the governing equation set.</p>
 <p><b>Key source files:</b> <span class="tt">src/simulation/m_rhs.fpp</span> (RHS evaluation), <span class="tt">src/common/m_variables_conversion.fpp</span> (EOS and variable conversion).</p>
 <hr  />
 <h2 class="doxsection"><a class="anchor" id="sec-units-dimensions"></a>
@@ -468,7 +468,6 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md149"></a>
 2.3 Other Model Variants</h3>
 <ul>
 <li><span class="tt">model_eqns = 1</span>: <b>Gamma/pi_inf model</b> — simplified single-fluid formulation using mixture \(\gamma\) and \(\pi_\infty\) directly without tracking individual volume fractions (Johnsen <a class="el" href="citelist.html#CITEREF_johnsen08">[24]</a>).</li>
-<li><span class="tt">model_eqns = 4</span>: <b>Four-equation model</b> — reduced model from the six-equation system after full pressure-temperature equilibrium relaxation (Tait-like compressible liquid).</li>
 </ul>
 <hr  />
 <h2 class="doxsection"><a class="anchor" id="autotoc_md151"></a>

documentation/examples.html

@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md312"></a>
 <ul>
 <li>Papanastasiou, T. C. (1987). Flows of materials with yield. <em>J. Rheol.</em> 31, 385.</li>
 </ul>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-09</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-10</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">