Docs @ 36fc04c

Author: MFC Action

documentation/architecture.html

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

documentation/case_constraints.html

@@ -1135,6 +1135,10 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 <p><b>Requirements</b> (errors):</p><ul>
 <li>int_comp (THINC interface compression) requires recon_type = 2 (MUSCL)</li>
 </ul>
+<p><b>Valid values</b> (errors):</p><ul>
+<li>recon_type must be 1 (WENO) or 2 (MUSCL)</li>
+<li>recon_type must be 1 (WENO) or 2 (MUSCL)</li>
+</ul>
 <p></p>
 </details>
 <details >
@@ -1416,9 +1420,9 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
 <li>Choices: <span class="tt">0</span> = MUSCL mode, <span class="tt">1</span> = 1st order, <span class="tt">3</span> = WENO3, <span class="tt">5</span> = WENO5, <span class="tt">7</span> = WENO7</li>
 </ul>
 <p><b>Requirements</b> (errors):</p><ul>
+<li>recon_type = 2 (MUSCL) requires weno_order unset or 0, but got weno_order</li>
 <li>weno_order != 1 requires weno_eps to be set. A typical value is 1e-6</li>
 <li>wenoz at 7th order requires wenoz_q to be set (should be 2, 3, or 4)</li>
-<li>teno requires weno_order = 5 or 7</li>
 </ul>
 <p><b>Incompatibilities</b> (errors):</p><ul>
 <li>mapped_weno is not compatible with weno_order = 1</li>
@@ -1446,7 +1450,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-02</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-03</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-02</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-03</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-02</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-03</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/parameters.html

@@ -1362,9 +1362,9 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><span class="tt">muscl_eps</span>  </td><td class="markdownTableBodyNone">Real  </td><td class="markdownTableBodyNone">MUSCL limiter slope-product threshold  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">Min: 0; <span class="tt">muscl_eps</span> must be &gt;= 0 (use 0 for textbook limiter behavior)  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">muscl_lim</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">MUSCL limiter type  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">1=minmod, 2=MC, 3=Van Albada, 4=Van Leer, 5=SUPERBEE; <span class="tt">muscl_lim</span> must be 1, 2, 3, 4, or 5  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">muscl_lim</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">MUSCL limiter type  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">1=minmod, 2=MC, 3=Van Albada, 4=Van Leer, 5=SUPERBEE; <span class="tt">muscl_lim</span> must be 1, 2, 3, 4, or 5; <span class="tt">muscl_lim</span> must be defined if using <span class="tt">muscl_order</span> = 2  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">muscl_order</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">Order of MUSCL reconstruction  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">1=1st order, 2=2nd order; <span class="tt">muscl_lim</span> must be defined if using <span class="tt">muscl_order</span> = 2  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">muscl_order</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">Order of MUSCL reconstruction  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">1=1st order, 2=2nd order; <span class="tt">muscl_order</span> must be 1 or 2; m must be at least <span class="tt">muscl_order</span> - 1 (= <span class="tt">muscl_order</span> - 1); For 2D simulation, n must be at least <span class="tt">muscl_order</span> - 1 (= <span class="tt">muscl_order</span> - 1)  </td></tr>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyNone"><span class="tt">n</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">Number of grid cells in the y-direction  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">Min: 0; down sample requires n divisible by 3; <span class="tt">omega_wrt</span> requires n &gt; 0 (at least 2D); <span class="tt">mom_wrt</span>(2) requires n &gt; 0  </td></tr>
 <tr class="markdownTableRowEven">
@@ -1462,7 +1462,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><span class="tt">rdma_mpi</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Enable RDMA for MPI communication (GPUs)  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"></td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">recon_type</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">Reconstruction type  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">1=WENO, 2=MUSCL; <span class="tt">int_comp</span> (THINC interface compression) requires <span class="tt">recon_type</span> = 2 (MUSCL); <span class="tt">weno_order</span> must be 1, 3, 5, or 7; m must be at least <span class="tt">weno_order</span> - 1 (= <span class="tt">weno_order</span> - 1)  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">recon_type</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">Reconstruction type  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">1=WENO, 2=MUSCL; <span class="tt">int_comp</span> (THINC interface compression) requires <span class="tt">recon_type</span> = 2 (MUSCL); <span class="tt">recon_type</span> = 2 (MUSCL) requires <span class="tt">weno_order</span> unset or 0, but got <span class="tt">weno_order</span>; <span class="tt">weno_order</span> != 1 requires <span class="tt">weno_eps</span> to be set. A typical value is 1e-6  </td></tr>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><span class="tt">relativity</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Enable special relativity  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">relativity</span> requires <span class="tt">mhd</span> to be enabled; HLLD is not available for RMHD (<span class="tt">relativity</span>)  </td></tr>
 <tr class="markdownTableRowOdd">
@@ -1540,11 +1540,11 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyNone"><span class="tt">weno_Re_flux</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Enable WENO for viscous fluxes  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">weno_Re_flux</span> requires <span class="tt">viscous</span> to be enabled  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">weno_avg</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Enable WENO averaging  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">weno_avg</span> is not compatible with <span class="tt">model_eqns</span> = 1  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">weno_avg</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Enable WENO averaging  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">weno_avg</span> is not compatible with <span class="tt">model_eqns</span> = 1; <span class="tt">weno_order</span> = 1 without <span class="tt">weno_avg</span> does not support <span class="tt">fluid_pp(i)Re(j)</span>  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">weno_eps</span>  </td><td class="markdownTableBodyNone">Real  </td><td class="markdownTableBodyNone">WENO epsilon parameter for smoothness  </td><td class="markdownTableBodyNone">\(\varepsilon\)  </td><td class="markdownTableBodyNone">Min: 0; <span class="tt">weno_eps</span> must be positive. A typical value is 1e-6  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">weno_eps</span>  </td><td class="markdownTableBodyNone">Real  </td><td class="markdownTableBodyNone">WENO epsilon parameter for smoothness  </td><td class="markdownTableBodyNone">\(\varepsilon\)  </td><td class="markdownTableBodyNone">Min: 0; <span class="tt">weno_order</span> != 1 requires <span class="tt">weno_eps</span> to be set. A typical value is 1e-6; <span class="tt">weno_eps</span> must be positive. A typical value is 1e-6  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyNone"><span class="tt">weno_order</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">Order of WENO reconstruction  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">0=MUSCL mode, 1=1st order, 3=WENO3, 5=WENO5, 7=WENO7; <span class="tt">weno_order</span> != 1 requires <span class="tt">weno_eps</span> to be set. A typical value is 1e-6; <span class="tt">weno_order</span> = 1 without <span class="tt">weno_avg</span> does not support <span class="tt">fluid_pp(i)Re(j)</span>  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">weno_order</span>  </td><td class="markdownTableBodyNone">Integer  </td><td class="markdownTableBodyNone">Order of WENO reconstruction  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">0=MUSCL mode, 1=1st order, 3=WENO3, 5=WENO5, 7=WENO7; <span class="tt">weno_order</span> = 1 without <span class="tt">weno_avg</span> does not support <span class="tt">fluid_pp(i)Re(j)</span>  </td></tr>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyNone"><span class="tt">wenoz</span>  </td><td class="markdownTableBodyNone">Logical (T/F)  </td><td class="markdownTableBodyNone">Enable WENO-Z scheme  </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">wenoz</span> at 7th order requires <span class="tt">wenoz_q</span> to be set (should be 2, 3, or 4); <span class="tt">wenoz</span> is not compatible with <span class="tt">weno_order</span> = 1; <span class="tt">wenoz_q</span> must be either 2, 3, or 4)  </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-02</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-03</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

@@ -490,6 +490,9 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md433"></a>
 <p><b>Stage:</b> common, pre_process, simulation, post_process | <b>Severity:</b> error</p>
 <p><b>Enforced checks:</b></p>
 <ul>
+<li><span class="tt">recon_type</span> = 1 (WENO) is not compatible with <span class="tt">muscl_order</span></li>
+<li><span class="tt">recon_type</span> = 1 (WENO) is not compatible with <span class="tt">muscl_lim</span></li>
+<li><span class="tt">recon_type</span> must be 1 (WENO) or 2 (MUSCL)</li>
 <li><span class="tt">weno_order</span> must be 1, 3, 5, or 7</li>
 <li><span class="tt">m</span> must be at least <span class="tt">weno_order</span> - 1 (= <span class="tt">weno_order</span> - 1)</li>
 <li>For 2D simulation, <span class="tt">n</span> must be at least <span class="tt">weno_order</span> - 1 (= <span class="tt">weno_order</span> - 1)</li>
@@ -501,7 +504,11 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md434"></a>
 <p><b>Stage:</b> common, pre_process, simulation, post_process | <b>Severity:</b> error</p>
 <p><b>Enforced checks:</b></p>
 <ul>
+<li><span class="tt">recon_type</span> must be 1 (WENO) or 2 (MUSCL)</li>
 <li><span class="tt">int_comp</span> (THINC interface compression) requires <span class="tt">recon_type</span> = 2 (MUSCL)</li>
+<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with param = T</li>
+<li><span class="tt">recon_type</span> = 2 (MUSCL) is not compatible with param</li>
+<li><span class="tt">recon_type</span> = 2 (MUSCL) requires <span class="tt">weno_order</span> unset or 0, but got <span class="tt">weno_order</span></li>
 <li><span class="tt">muscl_order</span> must be 1 or 2</li>
 <li><span class="tt">m</span> must be at least <span class="tt">muscl_order</span> - 1 (= <span class="tt">muscl_order</span> - 1)</li>
 <li>For 2D simulation, <span class="tt">n</span> must be at least <span class="tt">muscl_order</span> - 1 (= <span class="tt">muscl_order</span> - 1)</li>
@@ -624,7 +631,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-02</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-03</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">