Skip to content

Commit ba21d7e

Browse files
author
MFC Action
committed
Docs @ 4e14d3d
1 parent 42bb1f0 commit ba21d7e

11 files changed

+1042
-1038
lines changed

documentation/architecture.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
401401
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
402402
</ol>
403403
<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>
404-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
404+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-16</div> </div></div><!-- contents -->
405405
</div><!-- PageDoc -->
406406
</div><!-- doc-content -->
407407
<div id="page-nav" class="page-nav-panel">

documentation/case_constraints.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1349,6 +1349,9 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
13491349
<p><b>Dependencies:</b></p><ul>
13501350
<li>When enabled, recommends: <span class="tt">fluid_pp(1)Re(1)</span></li>
13511351
</ul>
1352+
<p><b>Requirements</b> (errors):</p><ul>
1353+
<li>weno_Re_flux requires viscous to be enabled</li>
1354+
</ul>
13521355
<p></p>
13531356
</details>
13541357
<details >
@@ -1424,7 +1427,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14241427
</table>
14251428
<hr />
14261429
<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>
1427-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
1430+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-16</div> </div></div><!-- contents -->
14281431
</div><!-- PageDoc -->
14291432
</div><!-- doc-content -->
14301433
<div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -952,7 +952,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md78"></a>
952952
<h3 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
953953
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
954954
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
955-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
955+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-16</div> </div></div><!-- contents -->
956956
</div><!-- PageDoc -->
957957
</div><!-- doc-content -->
958958
<div id="page-nav" class="page-nav-panel">

documentation/examples.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md273"></a>
388388
<h3 class="doxsection"><a class="anchor" id="autotoc_md274"></a>
389389
Final Condition (Density)</h3>
390390
<p><img src="final-2D_forward_facing_step-example.png" alt="" class="inline"/></p>
391-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
391+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-16</div> </div></div><!-- contents -->
392392
</div><!-- PageDoc -->
393393
</div><!-- doc-content -->
394394
<div id="page-nav" class="page-nav-panel">

documentation/parameters.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1527,7 +1527,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
15271527
<tr class="markdownTableRowOdd">
15281528
<td class="markdownTableBodyNone"><span class="tt">wave_speeds</span> </td><td class="markdownTableBodyNone">Integer </td><td class="markdownTableBodyNone">Wave speed estimates </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">1=direct, 2=pressure; <span class="tt">wave_speeds</span> must be 1 or 2 </td></tr>
15291529
<tr class="markdownTableRowEven">
1530-
<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">WENO parameter </td></tr>
1530+
<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>
15311531
<tr class="markdownTableRowOdd">
15321532
<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>
15331533
<tr class="markdownTableRowEven">
@@ -1566,7 +1566,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></a>
15661566
<div class="line"> </div>
15671567
<div class="line"># Filter by type</div>
15681568
<div class="line">./mfc.sh params -t real weno</div>
1569-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
1569+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-16</div> </div></div><!-- contents -->
15701570
</div><!-- PageDoc -->
15711571
</div><!-- doc-content -->
15721572
<div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -541,6 +541,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md436"></a>
541541
<li><span class="tt">weno_order</span> = 1 without <span class="tt">weno_avg</span> does not support <code class="f90l">fluid_pp(i)%</code><code class="f90r">Re(j)</code></li>
542542
<li><span class="tt">Re(j)</span> is specified, but <span class="tt">viscous</span> is not set to true</li>
543543
<li><span class="tt">viscous</span> is set to true, but <code class="f90l">fluid_pp(i)%</code><code class="f90r">Re(1)</code> is not specified</li>
544+
<li><span class="tt">weno_Re_flux</span> requires <span class="tt">viscous</span> to be enabled</li>
544545
</ul>
545546
<hr />
546547
<h2 class="doxsection"><a class="anchor" id="autotoc_md438"></a>
@@ -623,7 +624,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
623624
<li>FFT WRT incompatible with cylindrical coordinates</li>
624625
<li>FFT WRT requires global dimensions divisible by 2</li>
625626
</ul>
626-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-15</div> </div></div><!-- contents -->
627+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-16</div> </div></div><!-- contents -->
627628
</div><!-- PageDoc -->
628629
</div><!-- doc-content -->
629630
<div id="page-nav" class="page-nav-panel">

simulation/m__global__parameters_8fpp_8f90.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -309,18 +309,18 @@
309309
<tr class="memitem:aabad0b5732baec4916c15bd01cb7f9b7" id="r_aabad0b5732baec4916c15bd01cb7f9b7"><td class="memItemLeft">logical&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#aabad0b5732baec4916c15bd01cb7f9b7">m_global_parameters::bf_y</a></td></tr>
310310
<tr class="memitem:a8f189b60d9f8aa4b5cfb8451d9bacd73" id="r_a8f189b60d9f8aa4b5cfb8451d9bacd73"><td class="memItemLeft">logical&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a8f189b60d9f8aa4b5cfb8451d9bacd73">m_global_parameters::bf_z</a></td></tr>
311311
<tr class="memdesc:a8f189b60d9f8aa4b5cfb8451d9bacd73"><td class="mdescLeft">&#160;</td><td class="mdescRight">body force toggle in three directions amplitude, frequency, and phase shift sinusoid in each direction <br /></td></tr>
312-
<tr class="memitem:ac5836965fc47e3cda0ac04bd3f33e347" id="r_ac5836965fc47e3cda0ac04bd3f33e347"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#ac5836965fc47e3cda0ac04bd3f33e347">m_global_parameters::w_y</a></td></tr>
313-
<tr class="memitem:a72371679cecccecfbc2b291dcd726228" id="r_a72371679cecccecfbc2b291dcd726228"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a72371679cecccecfbc2b291dcd726228">m_global_parameters::k_y</a></td></tr>
314-
<tr class="memitem:a82a4a61004712d4ded68b1018d796fae" id="r_a82a4a61004712d4ded68b1018d796fae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a82a4a61004712d4ded68b1018d796fae">m_global_parameters::g_y</a></td></tr>
315-
<tr class="memitem:a86fb50483af0d51af7adb848daa8a4ae" id="r_a86fb50483af0d51af7adb848daa8a4ae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a86fb50483af0d51af7adb848daa8a4ae">m_global_parameters::p_y</a></td></tr>
316-
<tr class="memitem:aa11528d15dfa6e313e1298dee5ca42cd" id="r_aa11528d15dfa6e313e1298dee5ca42cd"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#aa11528d15dfa6e313e1298dee5ca42cd">m_global_parameters::w_z</a></td></tr>
317-
<tr class="memitem:a2b4bee61739d582d3f9d9538c6100c02" id="r_a2b4bee61739d582d3f9d9538c6100c02"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a2b4bee61739d582d3f9d9538c6100c02">m_global_parameters::k_z</a></td></tr>
318-
<tr class="memitem:a444ad421d11df63042d50c0ecae450c9" id="r_a444ad421d11df63042d50c0ecae450c9"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a444ad421d11df63042d50c0ecae450c9">m_global_parameters::g_z</a></td></tr>
319-
<tr class="memitem:a1f924d5ee4e2910cffe8e756a0c8657b" id="r_a1f924d5ee4e2910cffe8e756a0c8657b"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1f924d5ee4e2910cffe8e756a0c8657b">m_global_parameters::p_z</a></td></tr>
320-
<tr class="memitem:a04316d272b181c3c8496d1b0ce088c64" id="r_a04316d272b181c3c8496d1b0ce088c64"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a04316d272b181c3c8496d1b0ce088c64">m_global_parameters::w_x</a></td></tr>
321-
<tr class="memitem:a1671373492ac31693c8698500f095ff4" id="r_a1671373492ac31693c8698500f095ff4"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1671373492ac31693c8698500f095ff4">m_global_parameters::k_x</a></td></tr>
322312
<tr class="memitem:a1b2b0f3b66e4aef04d872e7550735df5" id="r_a1b2b0f3b66e4aef04d872e7550735df5"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1b2b0f3b66e4aef04d872e7550735df5">m_global_parameters::g_x</a></td></tr>
323313
<tr class="memitem:a1b662ab55a2226686cc9e8a9ab95ada3" id="r_a1b662ab55a2226686cc9e8a9ab95ada3"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1b662ab55a2226686cc9e8a9ab95ada3">m_global_parameters::p_x</a></td></tr>
314+
<tr class="memitem:a04316d272b181c3c8496d1b0ce088c64" id="r_a04316d272b181c3c8496d1b0ce088c64"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a04316d272b181c3c8496d1b0ce088c64">m_global_parameters::w_x</a></td></tr>
315+
<tr class="memitem:a1671373492ac31693c8698500f095ff4" id="r_a1671373492ac31693c8698500f095ff4"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1671373492ac31693c8698500f095ff4">m_global_parameters::k_x</a></td></tr>
316+
<tr class="memitem:a444ad421d11df63042d50c0ecae450c9" id="r_a444ad421d11df63042d50c0ecae450c9"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a444ad421d11df63042d50c0ecae450c9">m_global_parameters::g_z</a></td></tr>
317+
<tr class="memitem:a1f924d5ee4e2910cffe8e756a0c8657b" id="r_a1f924d5ee4e2910cffe8e756a0c8657b"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1f924d5ee4e2910cffe8e756a0c8657b">m_global_parameters::p_z</a></td></tr>
318+
<tr class="memitem:aa11528d15dfa6e313e1298dee5ca42cd" id="r_aa11528d15dfa6e313e1298dee5ca42cd"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#aa11528d15dfa6e313e1298dee5ca42cd">m_global_parameters::w_z</a></td></tr>
319+
<tr class="memitem:a2b4bee61739d582d3f9d9538c6100c02" id="r_a2b4bee61739d582d3f9d9538c6100c02"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a2b4bee61739d582d3f9d9538c6100c02">m_global_parameters::k_z</a></td></tr>
320+
<tr class="memitem:a82a4a61004712d4ded68b1018d796fae" id="r_a82a4a61004712d4ded68b1018d796fae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a82a4a61004712d4ded68b1018d796fae">m_global_parameters::g_y</a></td></tr>
321+
<tr class="memitem:a86fb50483af0d51af7adb848daa8a4ae" id="r_a86fb50483af0d51af7adb848daa8a4ae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a86fb50483af0d51af7adb848daa8a4ae">m_global_parameters::p_y</a></td></tr>
322+
<tr class="memitem:ac5836965fc47e3cda0ac04bd3f33e347" id="r_ac5836965fc47e3cda0ac04bd3f33e347"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#ac5836965fc47e3cda0ac04bd3f33e347">m_global_parameters::w_y</a></td></tr>
323+
<tr class="memitem:a72371679cecccecfbc2b291dcd726228" id="r_a72371679cecccecfbc2b291dcd726228"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a72371679cecccecfbc2b291dcd726228">m_global_parameters::k_y</a></td></tr>
324324
<tr class="memitem:a4d953db2f36f05624766c42cc9851362" id="r_a4d953db2f36f05624766c42cc9851362"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>), dimension(3)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a4d953db2f36f05624766c42cc9851362">m_global_parameters::accel_bf</a></td></tr>
325325
<tr class="memitem:a5422a3820409740b5c3b0b2e88bdb2b0" id="r_a5422a3820409740b5c3b0b2e88bdb2b0"><td class="memItemLeft">integer&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a5422a3820409740b5c3b0b2e88bdb2b0">m_global_parameters::cpu_start</a></td></tr>
326326
<tr class="memitem:a8ed3dee47bbaa5de7ae564ca9d770404" id="r_a8ed3dee47bbaa5de7ae564ca9d770404"><td class="memItemLeft">integer&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a8ed3dee47bbaa5de7ae564ca9d770404">m_global_parameters::cpu_end</a></td></tr>

0 commit comments

Comments
 (0)