Docs @ 13a0dec

Author: MFC Action

documentation/architecture.html

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

documentation/case_constraints.html

@@ -398,10 +398,12 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md43"></a>
 </ul>
 <p><b>Numerical Methods:</b></p>
 <ul>
+<li><b>Riemann solver:</b> Lax-Friedrichs (<span class="tt">riemann_solver = 5</span>)</li>
 <li><b>Time stepping:</b> RK3 (SSP)</li>
 </ul>
 <p><b>Related Documentation:</b></p><ul>
 <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>
@@ -560,10 +562,8 @@ <h2 class="doxsection"><a class="anchor" id="riemann-solvers"></a>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><b>HLLC</b>  </td><td class="markdownTableBodyNone"><span class="tt">2</span>  </td><td class="markdownTableBodyNone">Bubbles, phase change, multiphase  </td><td class="markdownTableBodyNone"><span class="tt">avg_state=2</span> for bubbles  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><b>Exact</b>  </td><td class="markdownTableBodyNone"><span class="tt">3</span>  </td><td class="markdownTableBodyNone">High accuracy (expensive)  </td><td class="markdownTableBodyNone">—  </td></tr>
-<tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><b>HLLD</b>  </td><td class="markdownTableBodyNone"><span class="tt">4</span>  </td><td class="markdownTableBodyNone">MHD (advanced)  </td><td class="markdownTableBodyNone">MHD only, no relativity  </td></tr>
-<tr class="markdownTableRowOdd">
+<tr class="markdownTableRowEven">
 <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="bubble-models"></a>
@@ -624,7 +624,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 <li>Choices: <span class="tt">1</span> = Roe, <span class="tt">2</span> = arithmetic</li>
 </ul>
 <p><b>Requirements</b> (errors):</p><ul>
-<li>avg_state must be set if riemann_solver != 3,5</li>
+<li>avg_state must be set for riemann_solver 1, 2, or 4</li>
 <li>6-equation model (model_eqns = 3) requires avg_state = 2</li>
 <li>Bubble modeling requires arithmetic average (avg_state = 2)</li>
 </ul>
@@ -831,6 +831,9 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 <li>int_comp = 2 (MTHINC) requires at least 2D (n &gt; 0)</li>
 <li>int_comp &gt; 0 requires num_fluids = 2</li>
 </ul>
+<p><b>Incompatibilities</b> (errors):</p><ul>
+<li>int_comp &gt; 0 is not supported with model_eqns = 3: THINC does not update per-fluid internal energies, leaving thermodynamically inconsistent face states</li>
+</ul>
 <p></p>
 </details>
 <details >
@@ -1171,19 +1174,18 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 <b>Riemann Solver</b> (<span class="tt">riemann_solver</span>)</summary>
 <p></p>
 <p><b>Schema constraints:</b></p><ul>
-<li>Choices: <span class="tt">1</span> = HLL, <span class="tt">2</span> = HLLC, <span class="tt">3</span> = Exact, <span class="tt">4</span> = HLLD, <span class="tt">5</span> = Lax-Friedrichs</li>
+<li>Choices: <span class="tt">1</span> = HLL, <span class="tt">2</span> = HLLC, <span class="tt">4</span> = HLLD, <span class="tt">5</span> = Lax-Friedrichs</li>
 </ul>
 <p><b>Requirements</b> (errors):</p><ul>
 <li>hypoelasticity requires HLL Riemann solver (riemann_solver = 1)</li>
+<li>riemann_solver must be specified (1=HLL, 2=HLLC, 4=HLLD, 5=Lax-Friedrichs)</li>
 <li>6-equation model (model_eqns = 3) requires riemann_solver = 2 (HLLC)</li>
-<li>wave_speeds must be set if riemann_solver != 3,5</li>
 </ul>
 <p><b>Incompatibilities</b> (errors):</p><ul>
-<li>Exact Riemann (riemann_solver = 3) does not support wave_speeds</li>
 <li>HLLD is not available for RMHD (relativity)</li>
 </ul>
 <p><b>Valid values</b> (errors):</p><ul>
-<li>riemann_solver must be 1, 2, 3, 4 or 5</li>
+<li>riemann_solver must be 1 (HLL), 2 (HLLC), 4 (HLLD), or 5 (Lax-Friedrichs)</li>
 </ul>
 <p></p>
 </details>
@@ -1395,13 +1397,10 @@ <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>wave_speeds must be set if riemann_solver != 3,5</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>
 <li>MHD requires wave_speeds = 1</li>
 </ul>
-<p><b>Incompatibilities</b> (errors):</p><ul>
-<li>Exact Riemann (riemann_solver = 3) does not support wave_speeds</li>
-</ul>
 <p><b>Valid values</b> (errors):</p><ul>
 <li>wave_speeds must be 1 or 2</li>
 </ul>
@@ -1460,7 +1459,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-05-09</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-10</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

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

documentation/examples.html

@@ -388,7 +388,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md276"></a>
 Final Condition</h3>
 <p>This figure shows the isosurface with zero q-criterion.</p>
 <p><img src="result-3D_TaylorGreenVortex-example.png" alt="" height="400" class="inline"/></p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-09</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-10</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/parameters.html

@@ -1278,7 +1278,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><span class="tt">igr_pres_lim</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Enable IGR pressure limiting  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">igr_pres_lim</span> requires <span class="tt">igr</span> to be enabled  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">int_comp</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">Interface compression: 0=off, 1=THINC, 2=MTHINC  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">0=off, 1=THINC, 2=MTHINC; <span class="tt">int_comp</span> = 2 (MTHINC) requires at least 2D (n &gt; 0); <span class="tt">int_comp</span> &gt; 0 requires <span class="tt">num_fluids</span> = 2; <span class="tt">int_comp</span> must be 0 (off), 1 (THINC), or 2 (MTHINC)  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">int_comp</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">Interface compression: 0=off, 1=THINC, 2=MTHINC  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">0=off, 1=THINC, 2=MTHINC; <span class="tt">int_comp</span> = 2 (MTHINC) requires at least 2D (n &gt; 0); <span class="tt">int_comp</span> &gt; 0 requires <span class="tt">num_fluids</span> = 2; <span class="tt">int_comp</span> &gt; 0 is not supported with <span class="tt">model_eqns</span> = 3: THINC does not update per-fluid internal energies, leaving thermodynamically inconsistent face states  </td></tr>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><span class="tt">integral_wrt</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Write integral data  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">fd_order</span> must be specified for <span class="tt">integral_wrt</span>; <span class="tt">integral_wrt</span> requires <span class="tt">bubbles_euler</span> to be enabled  </td></tr>
 <tr class="markdownTableRowOdd">
@@ -1476,7 +1476,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyNone"><span class="tt">rhoref</span>  </td><td class="markdownTableBodyNone">Real  </td><td class="markdownTableBodyNone">Reference density  </td><td class="markdownTableBodyNone">\(\rho_\text{ref}\)  </td><td class="markdownTableBodyNone"><span class="tt">rhoref</span> must be set if using <span class="tt">bubbles_euler</span> with <span class="tt">model_eqns</span> = 4; <span class="tt">rhoref</span> (reference density) must be positive  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">riemann_solver</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">Riemann solver  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">1=HLL, 2=HLLC, 3=Exact, 4=HLLD, 5=Lax-Friedrichs; 6-equation model (<span class="tt">model_eqns</span> = 3) requires <span class="tt">riemann_solver</span> = 2 (HLLC); <span class="tt">wave_speeds</span> must be set if <span class="tt">riemann_solver</span> != 3,5; <span class="tt">avg_state</span> must be set if <span class="tt">riemann_solver</span> != 3,5  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">riemann_solver</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">Riemann solver  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">1=HLL, 2=HLLC, 4=HLLD, 5=Lax-Friedrichs; <span class="tt">riemann_solver</span> must be specified (1=HLL, 2=HLLC, 4=HLLD, 5=Lax-Friedrichs); 6-equation model (<span class="tt">model_eqns</span> = 3) requires <span class="tt">riemann_solver</span> = 2 (HLLC); <span class="tt">wave_speeds</span> must be set for <span class="tt">riemann_solver</span> 1, 2, or 4  </td></tr>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyNone"><span class="tt">run_time_info</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Output run-time information  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">Post-processing output flag  </td></tr>
 <tr class="markdownTableRowEven">
@@ -1577,7 +1577,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></a>
 <div class="line"> </div>
 <div class="line"># Filter by type</div>
 <div class="line">./mfc.sh params -t real weno</div>
-</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-09</div> </div></div><!-- contents -->
+</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-10</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
 <li>FFT WRT incompatible with cylindrical coordinates</li>
 <li>FFT WRT requires global dimensions divisible by 2</li>
 </ul>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-09</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-10</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

post_process/m__global__parameters_8fpp_8f90_source.html

@@ -514,15 +514,15 @@
 <div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="preprocessor"></span><span class="preprocessor"># 338 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
 <div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="preprocessor"></span> </div>
 <div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="preprocessor"># 340 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
-<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="preprocessor"></span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
-<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
-<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
-<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
+<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="preprocessor"></span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
+<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
+<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
+<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
 <div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="preprocessor"># 340 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
-<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="preprocessor"></span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
-<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
-<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
-<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
+<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="preprocessor"></span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
+<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
+<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
+<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
 <div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><span class="preprocessor"># 340 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
 <div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="preprocessor"></span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_in = .false.</div>
 <div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span>            <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_out = .false.</div>