Docs @ 3639574

Author: MFC Action

documentation/case.html

@@ -128,20 +128,20 @@
   <div class="headertitle"><div class="title">Case Creator Guide </div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><h1 class="doxsection"><a class="anchor" id="autotoc_md39"></a>
+<div class="textblock"><h1 class="doxsection"><a class="anchor" id="autotoc_md24"></a>
 Case Creator Guide</h1>
 <blockquote class="doxtable">
 <p><b>Quick reference</b> for building MFC cases: working examples, compatibility rules, and configuration requirements. </p>
 </blockquote>
 <blockquote class="doxtable">
 <p>Auto-generated from <span class="tt">case_validator.py</span> and <span class="tt">examples/</span>. </p>
 </blockquote>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md40"></a>
+<h2 class="doxsection"><a class="anchor" id="case-design-playbook"></a>
 🧩 Case Design Playbook</h2>
 <blockquote class="doxtable">
 <p><b>Learn by example:</b> The cases below are curated from MFC's <span class="tt">examples/</span> directory and are validated, working configurations. Use them as blueprints for building your own simulations. </p>
 </blockquote>
-<h3 class="doxsection"><a class="anchor" id="autotoc_md41"></a>
+<h3 class="doxsection"><a class="anchor" id="autotoc_md25"></a>
 🟢 Beginner Examples</h3>
 <details >
 <summary >
@@ -162,12 +162,12 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md41"></a>
 <li><b>Time stepping:</b> RK3 (SSP)</li>
 </ul>
 <p><b>Related Documentation:</b></p><ul>
-<li>Model Equations (model_eqns = 2)</li>
-<li>Riemann Solvers</li>
+<li><a class="el" href="#model-equations" title="🔢 Model Equations">Model Equations (model_eqns = 2)</a></li>
+<li><a class="el" href="#riemann-solvers" title="⚙️ Riemann Solvers">Riemann Solvers</a></li>
 </ul>
 <p></p>
 </details>
-<h3 class="doxsection"><a class="anchor" id="autotoc_md42"></a>
+<h3 class="doxsection"><a class="anchor" id="autotoc_md26"></a>
 🟡 Intermediate Examples</h3>
 <details >
 <summary >
@@ -189,9 +189,9 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md42"></a>
 <li><b>Time stepping:</b> RK3 (SSP)</li>
 </ul>
 <p><b>Related Documentation:</b></p><ul>
-<li>Model Equations (model_eqns = 2)</li>
-<li>Riemann Solvers</li>
-<li>Bubble Models</li>
+<li><a class="el" href="#model-equations" title="🔢 Model Equations">Model Equations (model_eqns = 2)</a></li>
+<li><a class="el" href="#riemann-solvers" title="⚙️ Riemann Solvers">Riemann Solvers</a></li>
+<li><a class="el" href="#bubble-models" title="💧 Bubble Models">Bubble Models</a></li>
 </ul>
 <p></p>
 </details>
@@ -215,10 +215,10 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md42"></a>
 <li><b>Time stepping:</b> RK3 (SSP)</li>
 </ul>
 <p><b>Related Documentation:</b></p><ul>
-<li>Model Equations (model_eqns = 2)</li>
-<li>Riemann Solvers</li>
-<li>Bubble Models</li>
-<li>Viscosity</li>
+<li><a class="el" href="#model-equations" title="🔢 Model Equations">Model Equations (model_eqns = 2)</a></li>
+<li><a class="el" href="#riemann-solvers" title="⚙️ Riemann Solvers">Riemann Solvers</a></li>
+<li><a class="el" href="#bubble-models" title="💧 Bubble Models">Bubble Models</a></li>
+<li><a class="el" href="#compat-physics-models" title="Physics Models">Viscosity</a></li>
 </ul>
 <p></p>
 </details>
@@ -242,9 +242,9 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md42"></a>
 <li><b>Time stepping:</b> RK3 (SSP)</li>
 </ul>
 <p><b>Related Documentation:</b></p><ul>
-<li>Model Equations (model_eqns = 2)</li>
-<li>Riemann Solvers</li>
-<li>MHD</li>
+<li><a class="el" href="#model-equations" title="🔢 Model Equations">Model Equations (model_eqns = 2)</a></li>
+<li><a class="el" href="#riemann-solvers" title="⚙️ Riemann Solvers">Riemann Solvers</a></li>
+<li><a class="el" href="#compat-physics-models" title="Physics Models">MHD</a></li>
 </ul>
 <p></p>
 </details>
@@ -268,9 +268,9 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md42"></a>
 <li><b>Time stepping:</b> RK3 (SSP)</li>
 </ul>
 <p><b>Related Documentation:</b></p><ul>
-<li>Model Equations (model_eqns = 2)</li>
-<li>Riemann Solvers</li>
-<li>Immersed Boundaries</li>
+<li><a class="el" href="#model-equations" title="🔢 Model Equations">Model Equations (model_eqns = 2)</a></li>
+<li><a class="el" href="#riemann-solvers" title="⚙️ Riemann Solvers">Riemann Solvers</a></li>
+<li><a class="el" href="#compat-geometry" title="Geometry">Immersed Boundaries</a></li>
 </ul>
 <p></p>
 </details>
@@ -294,13 +294,13 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md42"></a>
 <li><b>Time stepping:</b> RK3 (SSP)</li>
 </ul>
 <p><b>Related Documentation:</b></p><ul>
-<li>Model Equations (model_eqns = 2)</li>
-<li>Riemann Solvers</li>
-<li>Viscosity</li>
+<li><a class="el" href="#model-equations" title="🔢 Model Equations">Model Equations (model_eqns = 2)</a></li>
+<li><a class="el" href="#riemann-solvers" title="⚙️ Riemann Solvers">Riemann Solvers</a></li>
+<li><a class="el" href="#compat-physics-models" title="Physics Models">Viscosity</a></li>
 </ul>
 <p></p>
 </details>
-<h3 class="doxsection"><a class="anchor" id="autotoc_md43"></a>
+<h3 class="doxsection"><a class="anchor" id="autotoc_md27"></a>
 🔴 Advanced Examples</h3>
 <details >
 <summary >
@@ -323,8 +323,8 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md43"></a>
 <li><b>Time stepping:</b> RK3 (SSP)</li>
 </ul>
 <p><b>Related Documentation:</b></p><ul>
-<li>Model Equations (model_eqns = 3)</li>
-<li>Riemann Solvers</li>
+<li><a class="el" href="#model-equations" title="🔢 Model Equations">Model Equations (model_eqns = 3)</a></li>
+<li><a class="el" href="#riemann-solvers" title="⚙️ Riemann Solvers">Riemann Solvers</a></li>
 </ul>
 <p></p>
 </details>
@@ -348,9 +348,9 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md43"></a>
 <li><b>Time stepping:</b> RK3 (SSP)</li>
 </ul>
 <p><b>Related Documentation:</b></p><ul>
-<li>Model Equations (model_eqns = 2)</li>
-<li>Riemann Solvers</li>
-<li>Viscosity</li>
+<li><a class="el" href="#model-equations" title="🔢 Model Equations">Model Equations (model_eqns = 2)</a></li>
+<li><a class="el" href="#riemann-solvers" title="⚙️ Riemann Solvers">Riemann Solvers</a></li>
+<li><a class="el" href="#compat-physics-models" title="Physics Models">Viscosity</a></li>
 </ul>
 <p></p>
 </details>
@@ -372,11 +372,11 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md43"></a>
 <li><b>Time stepping:</b> RK3 (SSP)</li>
 </ul>
 <p><b>Related Documentation:</b></p><ul>
-<li>Model Equations (model_eqns = 2)</li>
+<li><a class="el" href="#model-equations" title="🔢 Model Equations">Model Equations (model_eqns = 2)</a></li>
 </ul>
 <p></p>
 </details>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md44"></a>
+<h2 class="doxsection"><a class="anchor" id="common-configuration-patterns"></a>
 🚀 Common Configuration Patterns</h2>
 <p>Start with these proven combinations:</p>
 <details  open="true">
@@ -415,10 +415,10 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md44"></a>
 <div class="line"><span class="stringliteral">&#39;hypoelasticity&#39;</span>: <span class="stringliteral">&#39;T&#39;</span>,        <span class="comment"># Elastic solids</span></div>
 <div class="line"><span class="stringliteral">&#39;riemann_solver&#39;</span>: 1,          <span class="comment"># HLL</span></div>
 </div><!-- fragment --> </details>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md45"></a>
+<h2 class="doxsection"><a class="anchor" id="feature-compatibility"></a>
 📊 Feature Compatibility</h2>
 <p>What works together:</p>
-<h3 class="doxsection"><a class="anchor" id="autotoc_md46"></a>
+<h3 class="doxsection"><a class="anchor" id="compat-physics-models"></a>
 Physics Models</h3>
 <table class="markdownTable">
 <tr class="markdownTableHead">
@@ -438,7 +438,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md46"></a>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyNone">Acoustic Sources  </td><td class="markdownTableBodyNone">—  </td><td class="markdownTableBodyNone">✓ General use  </td></tr>
 </table>
-<h3 class="doxsection"><a class="anchor" id="autotoc_md47"></a>
+<h3 class="doxsection"><a class="anchor" id="compat-bubble-models"></a>
 Bubble Models</h3>
 <table class="markdownTable">
 <tr class="markdownTableHead">
@@ -454,7 +454,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md47"></a>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyNone">adv_n  </td><td class="markdownTableBodyNone">—  </td><td class="markdownTableBodyNone">✓ General use  </td></tr>
 </table>
-<h3 class="doxsection"><a class="anchor" id="autotoc_md48"></a>
+<h3 class="doxsection"><a class="anchor" id="compat-numerics"></a>
 Numerics</h3>
 <table class="markdownTable">
 <tr class="markdownTableHead">
@@ -466,7 +466,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md48"></a>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyNone">MUSCL Order  </td><td class="markdownTableBodyNone">—  </td><td class="markdownTableBodyNone">✓ General use  </td></tr>
 </table>
-<h3 class="doxsection"><a class="anchor" id="autotoc_md49"></a>
+<h3 class="doxsection"><a class="anchor" id="compat-geometry"></a>
 Geometry</h3>
 <table class="markdownTable">
 <tr class="markdownTableHead">
@@ -476,7 +476,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md49"></a>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone">Cylindrical Coordinates  </td><td class="markdownTableBodyNone">—  </td><td class="markdownTableBodyNone">✓ General use  </td></tr>
 </table>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md50"></a>
+<h2 class="doxsection"><a class="anchor" id="model-equations"></a>
 🔢 Model Equations</h2>
 <p>Choose your governing equations:</p>
 <details >
@@ -521,7 +521,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md50"></a>
 <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="autotoc_md51"></a>
+<h2 class="doxsection"><a class="anchor" id="riemann-solvers"></a>
 ⚙️ Riemann Solvers</h2>
 <table class="markdownTable">
 <tr class="markdownTableHead">
@@ -537,7 +537,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md51"></a>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyNone"><b>Lax-Friedrichs</b>  </td><td class="markdownTableBodyNone"><span class="tt">5</span>  </td><td class="markdownTableBodyNone">Robust fallback  </td><td class="markdownTableBodyNone">Not with cylindrical+viscous  </td></tr>
 </table>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md52"></a>
+<h2 class="doxsection"><a class="anchor" id="bubble-models"></a>
 💧 Bubble Models</h2>
 <details >
 <summary >
@@ -566,7 +566,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md52"></a>
 </ul>
 <p><b>Note:</b> Tracks individual bubbles </p>
 </details>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md53"></a>
+<h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 📖 Quick Parameter Reference</h2>
 <p>Key parameters and their constraints:</p>
 <details >