Skip to content

Commit 2c5a851

Browse files
author
MFC Action
committed
Docs @ 336487c
1 parent 8a75f24 commit 2c5a851

13 files changed

+1084
-1048
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-31</div> </div></div><!-- contents -->
404+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-01</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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1420,7 +1420,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14201420
</table>
14211421
<hr />
14221422
<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>
1423-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-31</div> </div></div><!-- contents -->
1423+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-01</div> </div></div><!-- contents -->
14241424
</div><!-- PageDoc -->
14251425
</div><!-- doc-content -->
14261426
<div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -240,11 +240,15 @@ <h3 class="doxsection"><a class="anchor" id="build"></a>
240240
<tr class="markdownTableRowEven">
241241
<td class="markdownTableBodyNone"><span class="tt">--case-optimization</span> </td><td class="markdownTableBodyNone">(GPU Optimization) Compile MFC targets with some case parameters hard-coded (requires &ndash;input). </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
242242
<tr class="markdownTableRowOdd">
243-
<td class="markdownTableBodyNone"><span class="tt">--mpi</span>, <span class="tt">--no-mpi</span> </td><td class="markdownTableBodyNone">Enable/disable MPI </td><td class="markdownTableBodyNone"><span class="tt">true</span> </td></tr>
243+
<td class="markdownTableBodyNone"><span class="tt">--deps-only</span> </td><td class="markdownTableBodyNone">Only fetch and build dependencies, do not build MFC targets. </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
244244
<tr class="markdownTableRowEven">
245+
<td class="markdownTableBodyNone"><span class="tt">--mpi</span>, <span class="tt">--no-mpi</span> </td><td class="markdownTableBodyNone">Enable/disable MPI </td><td class="markdownTableBodyNone"><span class="tt">true</span> </td></tr>
246+
<tr class="markdownTableRowOdd">
245247
<td class="markdownTableBodyNone"><span class="tt">--gpu [acc/mp]</span>, <span class="tt">--no-gpu</span> </td><td class="markdownTableBodyNone">Enable GPU (OpenACC/OpenMP) </td><td class="markdownTableBodyNone"><span class="tt">no</span> </td></tr>
248+
<tr class="markdownTableRowEven">
249+
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with full debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
246250
<tr class="markdownTableRowOdd">
247-
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
251+
<td class="markdownTableBodyNone"><span class="tt">--reldebug</span>, <span class="tt">--no-reldebug</span> </td><td class="markdownTableBodyNone">Build with lightweight debug flags (CI) </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
248252
</table>
249253
<p><b>Examples:</b></p>
250254
<div class="fragment"><div class="line"># Build all default targets (CPU)</div>
@@ -331,7 +335,9 @@ <h3 class="doxsection"><a class="anchor" id="run"></a>
331335
<tr class="markdownTableRowOdd">
332336
<td class="markdownTableBodyNone"><span class="tt">--gpu [acc/mp]</span>, <span class="tt">--no-gpu</span> </td><td class="markdownTableBodyNone">Enable GPU (OpenACC/OpenMP) </td><td class="markdownTableBodyNone"><span class="tt">no</span> </td></tr>
333337
<tr class="markdownTableRowEven">
334-
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
338+
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with full debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
339+
<tr class="markdownTableRowOdd">
340+
<td class="markdownTableBodyNone"><span class="tt">--reldebug</span>, <span class="tt">--no-reldebug</span> </td><td class="markdownTableBodyNone">Build with lightweight debug flags (CI) </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
335341
</table>
336342
<p><b>Examples:</b></p>
337343
<div class="fragment"><div class="line"># Run interactively with 1 rank</div>
@@ -406,7 +412,9 @@ <h3 class="doxsection"><a class="anchor" id="test"></a>
406412
<tr class="markdownTableRowOdd">
407413
<td class="markdownTableBodyNone"><span class="tt">--gpu [acc/mp]</span>, <span class="tt">--no-gpu</span> </td><td class="markdownTableBodyNone">Enable GPU (OpenACC/OpenMP) </td><td class="markdownTableBodyNone"><span class="tt">no</span> </td></tr>
408414
<tr class="markdownTableRowEven">
409-
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
415+
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with full debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
416+
<tr class="markdownTableRowOdd">
417+
<td class="markdownTableBodyNone"><span class="tt">--reldebug</span>, <span class="tt">--no-reldebug</span> </td><td class="markdownTableBodyNone">Build with lightweight debug flags (CI) </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
410418
</table>
411419
<p><b>Examples:</b></p>
412420
<div class="fragment"><div class="line"># Run all tests</div>
@@ -449,7 +457,9 @@ <h3 class="doxsection"><a class="anchor" id="clean"></a>
449457
<tr class="markdownTableRowEven">
450458
<td class="markdownTableBodyNone"><span class="tt">--gpu [acc/mp]</span>, <span class="tt">--no-gpu</span> </td><td class="markdownTableBodyNone">Enable GPU (OpenACC/OpenMP) </td><td class="markdownTableBodyNone"><span class="tt">no</span> </td></tr>
451459
<tr class="markdownTableRowOdd">
452-
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
460+
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with full debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
461+
<tr class="markdownTableRowEven">
462+
<td class="markdownTableBodyNone"><span class="tt">--reldebug</span>, <span class="tt">--no-reldebug</span> </td><td class="markdownTableBodyNone">Build with lightweight debug flags (CI) </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
453463
</table>
454464
<p><b>Examples:</b></p>
455465
<div class="fragment"><div class="line"># Clean all build files</div>
@@ -813,7 +823,9 @@ <h3 class="doxsection"><a class="anchor" id="count"></a>
813823
<tr class="markdownTableRowEven">
814824
<td class="markdownTableBodyNone"><span class="tt">--gpu [acc/mp]</span>, <span class="tt">--no-gpu</span> </td><td class="markdownTableBodyNone">Enable GPU (OpenACC/OpenMP) </td><td class="markdownTableBodyNone"><span class="tt">no</span> </td></tr>
815825
<tr class="markdownTableRowOdd">
816-
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
826+
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with full debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
827+
<tr class="markdownTableRowEven">
828+
<td class="markdownTableBodyNone"><span class="tt">--reldebug</span>, <span class="tt">--no-reldebug</span> </td><td class="markdownTableBodyNone">Build with lightweight debug flags (CI) </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
817829
</table>
818830
<p><b>Examples:</b></p>
819831
<div class="fragment"><div class="line"># Show LOC statistics</div>
@@ -840,7 +852,9 @@ <h3 class="doxsection"><a class="anchor" id="count_diff"></a>
840852
<tr class="markdownTableRowEven">
841853
<td class="markdownTableBodyNone"><span class="tt">--gpu [acc/mp]</span>, <span class="tt">--no-gpu</span> </td><td class="markdownTableBodyNone">Enable GPU (OpenACC/OpenMP) </td><td class="markdownTableBodyNone"><span class="tt">no</span> </td></tr>
842854
<tr class="markdownTableRowOdd">
843-
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
855+
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with full debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
856+
<tr class="markdownTableRowEven">
857+
<td class="markdownTableBodyNone"><span class="tt">--reldebug</span>, <span class="tt">--no-reldebug</span> </td><td class="markdownTableBodyNone">Build with lightweight debug flags (CI) </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
844858
</table>
845859
<hr />
846860
<h2 class="doxsection"><a class="anchor" id="autotoc_md70"></a>
@@ -872,7 +886,9 @@ <h3 class="doxsection"><a class="anchor" id="bench"></a>
872886
<tr class="markdownTableRowOdd">
873887
<td class="markdownTableBodyNone"><span class="tt">--gpu [acc/mp]</span>, <span class="tt">--no-gpu</span> </td><td class="markdownTableBodyNone">Enable GPU (OpenACC/OpenMP) </td><td class="markdownTableBodyNone"><span class="tt">no</span> </td></tr>
874888
<tr class="markdownTableRowEven">
875-
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
889+
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with full debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
890+
<tr class="markdownTableRowOdd">
891+
<td class="markdownTableBodyNone"><span class="tt">--reldebug</span>, <span class="tt">--no-reldebug</span> </td><td class="markdownTableBodyNone">Build with lightweight debug flags (CI) </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
876892
</table>
877893
<p><b>Examples:</b></p>
878894
<div class="fragment"><div class="line"># Run benchmarks and save results</div>
@@ -902,7 +918,9 @@ <h3 class="doxsection"><a class="anchor" id="bench_diff"></a>
902918
<tr class="markdownTableRowOdd">
903919
<td class="markdownTableBodyNone"><span class="tt">--gpu [acc/mp]</span>, <span class="tt">--no-gpu</span> </td><td class="markdownTableBodyNone">Enable GPU (OpenACC/OpenMP) </td><td class="markdownTableBodyNone"><span class="tt">no</span> </td></tr>
904920
<tr class="markdownTableRowEven">
905-
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
921+
<td class="markdownTableBodyNone"><span class="tt">--debug</span>, <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with full debug compiler flags </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
922+
<tr class="markdownTableRowOdd">
923+
<td class="markdownTableBodyNone"><span class="tt">--reldebug</span>, <span class="tt">--no-reldebug</span> </td><td class="markdownTableBodyNone">Build with lightweight debug flags (CI) </td><td class="markdownTableBodyNone"><span class="tt">false</span> </td></tr>
906924
</table>
907925
<hr />
908926
<h2 class="doxsection"><a class="anchor" id="autotoc_md73"></a>
@@ -945,12 +963,14 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md78"></a>
945963
<tr class="markdownTableRowEven">
946964
<td class="markdownTableBodyNone"><span class="tt">--gpu [acc/mp]</span> / <span class="tt">--no-gpu</span> </td><td class="markdownTableBodyNone">Enable GPU with OpenACC or OpenMP </td></tr>
947965
<tr class="markdownTableRowOdd">
948-
<td class="markdownTableBodyNone"><span class="tt">--debug</span> / <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with debug compiler flags </td></tr>
966+
<td class="markdownTableBodyNone"><span class="tt">--debug</span> / <span class="tt">--no-debug</span> </td><td class="markdownTableBodyNone">Build with full debug compiler flags </td></tr>
949967
<tr class="markdownTableRowEven">
950-
<td class="markdownTableBodyNone"><span class="tt">--gcov</span> / <span class="tt">--no-gcov</span> </td><td class="markdownTableBodyNone">Enable code coverage </td></tr>
968+
<td class="markdownTableBodyNone"><span class="tt">--reldebug</span> / <span class="tt">--no-reldebug</span> </td><td class="markdownTableBodyNone">Build with lightweight debug flags (CI) </td></tr>
951969
<tr class="markdownTableRowOdd">
952-
<td class="markdownTableBodyNone"><span class="tt">--single</span> / <span class="tt">--no-single</span> </td><td class="markdownTableBodyNone">Single precision </td></tr>
970+
<td class="markdownTableBodyNone"><span class="tt">--gcov</span> / <span class="tt">--no-gcov</span> </td><td class="markdownTableBodyNone">Enable code coverage </td></tr>
953971
<tr class="markdownTableRowEven">
972+
<td class="markdownTableBodyNone"><span class="tt">--single</span> / <span class="tt">--no-single</span> </td><td class="markdownTableBodyNone">Single precision </td></tr>
973+
<tr class="markdownTableRowOdd">
954974
<td class="markdownTableBodyNone"><span class="tt">--mixed</span> / <span class="tt">--no-mixed</span> </td><td class="markdownTableBodyNone">Mixed precision </td></tr>
955975
</table>
956976
<h3 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
@@ -964,7 +984,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
964984
<h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
965985
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
966986
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
967-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-31</div> </div></div><!-- contents -->
987+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-01</div> </div></div><!-- contents -->
968988
</div><!-- PageDoc -->
969989
</div><!-- doc-content -->
970990
<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_md274"></a>
388388
<h3 class="doxsection"><a class="anchor" id="autotoc_md275"></a>
389389
Final Condition and Linear Theory</h3>
390390
<p><img src="final_condition-3D_rayleigh_taylor-example.png" alt="" height="400" class="inline"/> <img src="linear_theory-3D_rayleigh_taylor-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-03-31</div> </div></div><!-- contents -->
391+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-01</div> </div></div><!-- contents -->
392392
</div><!-- PageDoc -->
393393
</div><!-- doc-content -->
394394
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)