Skip to content

Commit 93221e1

Browse files
author
MFC Action
committed
Docs @ 462cac7
1 parent 4c15a7e commit 93221e1

34 files changed

Lines changed: 32927 additions & 32255 deletions

documentation/architecture.html

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

documentation/case_constraints.html

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -912,10 +912,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
912912
<b>muscl_lim</b> (<span class="tt">muscl_lim</span>)</summary>
913913
<p></p>
914914
<p><b>Schema constraints:</b></p><ul>
915-
<li>Choices: <span class="tt">1</span> = minmod, <span class="tt">2</span> = MC, <span class="tt">3</span> = Van Albada, <span class="tt">4</span> = Van Leer, <span class="tt">5</span> = SUPERBEE</li>
916-
</ul>
917-
<p><b>Valid values</b> (errors):</p><ul>
918-
<li>muscl_lim must be 1, 2, 3, 4, or 5</li>
915+
<li>Choices: <span class="tt">0</span> = unlimited, <span class="tt">1</span> = minmod, <span class="tt">2</span> = MC, <span class="tt">3</span> = Van Albada, <span class="tt">4</span> = Van Leer, <span class="tt">5</span> = SUPERBEE</li>
919916
</ul>
920917
<p></p>
921918
</details>
@@ -1459,7 +1456,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14591456
</table>
14601457
<hr />
14611458
<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>
1462-
<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 -->
1459+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-11</div> </div></div><!-- contents -->
14631460
</div><!-- PageDoc -->
14641461
</div><!-- doc-content -->
14651462
<div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,8 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md47"></a>
215215
<td class="markdownTableBodyNone"><a class="el" href="#count" title="count"><code>count</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Count LOC in MFC. </td></tr>
216216
<tr class="markdownTableRowEven">
217217
<td class="markdownTableBodyNone"><a class="el" href="#count_diff" title="count_diff"><code>count_diff</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Compare LOC between branches. </td></tr>
218+
<tr class="markdownTableRowOdd">
219+
<td class="markdownTableBodyNone"><code>fp-stability</code> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Run floating-point stability tests using Verrou. </td></tr>
218220
</table>
219221
<h2 class="doxsection"><a class="anchor" id="autotoc_md48"></a>
220222
Commands</h2>
@@ -994,7 +996,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
994996
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
995997
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
996998
<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-10</div> </div></div><!-- contents -->
999+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-11</div> </div></div><!-- contents -->
9981000
</div><!-- PageDoc -->
9991001
</div><!-- doc-content -->
10001002
<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-10</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-11</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
@@ -1362,7 +1362,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
13621362
<tr class="markdownTableRowEven">
13631363
<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>
13641364
<tr class="markdownTableRowOdd">
1365-
<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>
1365+
<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">0=unlimited, 1=minmod, 2=MC, 3=Van Albada, 4=Van Leer, 5=SUPERBEE; <span class="tt">muscl_lim</span> must be defined if using <span class="tt">muscl_order</span> = 2; <span class="tt">muscl_lim</span> must be 0 (unlimited), 1, 2, 3, 4, or 5 </td></tr>
13661366
<tr class="markdownTableRowEven">
13671367
<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">int_comp</span> must be 0 (off) when <span class="tt">muscl_order</span> = 1 </td></tr>
13681368
<tr class="markdownTableRowOdd">
@@ -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-10</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-11</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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md433"></a>
500500
</ul>
501501
<h3 class="doxsection"><a class="anchor" id="autotoc_md434"></a>
502502
MUSCL Reconstruction</h3>
503-
<p>muscl_order must be 1 or 2. Second order requires muscl_lim in {1,2,3,4,5}.</p>
503+
<p>muscl_order must be 1 or 2. Second order requires muscl_lim in {0,1,2,3,4,5}.</p>
504504
<p><b>Stage:</b> common, pre_process, simulation, post_process | <b>Severity:</b> error</p>
505505
<p><b>Enforced checks:</b></p>
506506
<ul>
@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
630630
<li>FFT WRT incompatible with cylindrical coordinates</li>
631631
<li>FFT WRT requires global dimensions divisible by 2</li>
632632
</ul>
633-
<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 -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-11</div> </div></div><!-- contents -->
634634
</div><!-- PageDoc -->
635635
</div><!-- doc-content -->
636636
<div id="page-nav" class="page-nav-panel">

pre_process/m__global__parameters_8fpp_8f90_source.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -453,15 +453,15 @@
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#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</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#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</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#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</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#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</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#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</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#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</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#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</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#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</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#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>
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>
466466
<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#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_in = .false.</div>
467467
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno"> 329</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_out = .false.</div>

0 commit comments

Comments
 (0)