Skip to content

Commit d0eb551

Browse files
author
MFC Action
committed
Docs @ d513442
1 parent 6d0e4fa commit d0eb551

12 files changed

Lines changed: 1039 additions & 1039 deletions

documentation/architecture.html

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

documentation/case_constraints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1450,7 +1450,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14501450
</table>
14511451
<hr />
14521452
<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>
1453-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-04</div> </div></div><!-- contents -->
1453+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-05</div> </div></div><!-- contents -->
14541454
</div><!-- PageDoc -->
14551455
</div><!-- doc-content -->
14561456
<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
@@ -994,7 +994,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
994994
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
995995
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
996996
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
997-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-04</div> </div></div><!-- contents -->
997+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-05</div> </div></div><!-- contents -->
998998
</div><!-- PageDoc -->
999999
</div><!-- doc-content -->
10001000
<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 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md276"></a>
388388
Final Condition</h3>
389389
<p>This figure shows the isosurface with zero q-criterion.</p>
390390
<p><img src="result-3D_TaylorGreenVortex-example.png" alt="" height="400" class="inline"/></p>
391-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-04</div> </div></div><!-- contents -->
391+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-05</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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1577,7 +1577,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></a>
15771577
<div class="line"> </div>
15781578
<div class="line"># Filter by type</div>
15791579
<div class="line">./mfc.sh params -t real weno</div>
1580-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-04</div> </div></div><!-- contents -->
1580+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-05</div> </div></div><!-- contents -->
15811581
</div><!-- PageDoc -->
15821582
</div><!-- doc-content -->
15831583
<div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -631,7 +631,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
631631
<li>FFT WRT incompatible with cylindrical coordinates</li>
632632
<li>FFT WRT requires global dimensions divisible by 2</li>
633633
</ul>
634-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-04</div> </div></div><!-- contents -->
634+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-05</div> </div></div><!-- contents -->
635635
</div><!-- PageDoc -->
636636
</div><!-- doc-content -->
637637
<div id="page-nav" class="page-nav-panel">

pre_process/m__global__parameters_8fpp_8f90_source.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -453,20 +453,20 @@
453453
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno"> 315</span><span class="preprocessor"></span><span class="preprocessor"># 277 &quot;/home/runner/work/MFC/MFC/src/pre_process/m_global_parameters.fpp&quot;</span></div>
454454
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno"> 316</span><span class="preprocessor"></span> </div>
455455
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno"> 317</span><span class="preprocessor"># 279 &quot;/home/runner/work/MFC/MFC/src/pre_process/m_global_parameters.fpp&quot;</span></div>
456-
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno"> 318</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_in = .false.</div>
457-
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno"> 319</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_out = .false.</div>
458-
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno"> 320</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_in = dflt_real</div>
459-
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno"> 321</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_out = dflt_real</div>
456+
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno"> 318</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
457+
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno"> 319</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
458+
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno"> 320</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
459+
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno"> 321</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
460460
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno"> 322</span><span class="preprocessor"># 279 &quot;/home/runner/work/MFC/MFC/src/pre_process/m_global_parameters.fpp&quot;</span></div>
461-
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno"> 323</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
462-
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno"> 324</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
463-
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno"> 325</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
464-
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno"> 326</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
461+
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno"> 323</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_in = .false.</div>
462+
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno"> 324</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_out = .false.</div>
463+
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno"> 325</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_in = dflt_real</div>
464+
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno"> 326</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_out = dflt_real</div>
465465
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno"> 327</span><span class="preprocessor"># 279 &quot;/home/runner/work/MFC/MFC/src/pre_process/m_global_parameters.fpp&quot;</span></div>
466-
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno"> 328</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
467-
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno"> 329</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
468-
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno"> 330</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
469-
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno"> 331</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
466+
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno"> 328</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
467+
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno"> 329</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
468+
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno"> 330</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
469+
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno"> 331</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
470470
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno"> 332</span><span class="preprocessor"># 284 &quot;/home/runner/work/MFC/MFC/src/pre_process/m_global_parameters.fpp&quot;</span></div>
471471
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno"> 333</span><span class="preprocessor"></span> </div>
472472
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno"> 334</span> <a class="code hl_variable" href="namespacem__global__parameters.html#ac127ac2a9036e1cdb7e6c41159cacdfb">parallel_io</a> = .false.</div>

simulation/m__global__parameters_8fpp_8f90.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -312,18 +312,18 @@
312312
<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>
313313
<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>
314314
<tr class="memdesc:a8f189b60d9f8aa4b5cfb8451d9bacd73"><td class="mdescLeft">&#160;</td><td class="mdescRight">body force toggle in three directions <br /></td></tr>
315+
<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>
316+
<tr class="memdesc:a1b662ab55a2226686cc9e8a9ab95ada3"><td class="mdescLeft">&#160;</td><td class="mdescRight">amplitude, frequency, and phase shift sinusoid in each direction <br /></td></tr>
315317
<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>
316-
<tr class="memdesc:a1b2b0f3b66e4aef04d872e7550735df5"><td class="mdescLeft">&#160;</td><td class="mdescRight">amplitude, frequency, and phase shift sinusoid in each direction <br /></td></tr>
317318
<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>
318-
<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>
319319
<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>
320+
<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>
320321
<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>
321322
<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>
322-
<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>
323323
<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>
324+
<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>
324325
<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>
325326
<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>
326-
<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>
327327
<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>
328328
<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>
329329
<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>

0 commit comments

Comments
 (0)