Skip to content

Commit 1af13b7

Browse files
author
MFC Action
committed
Docs @ febffab
1 parent f966592 commit 1af13b7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+4969
-4930
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-19</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-20</div> </div></div><!-- contents -->
405405
</div><!-- PageDoc -->
406406
</div><!-- doc-content -->
407407
<div id="page-nav" class="page-nav-panel">

documentation/case.html

Lines changed: 137 additions & 68 deletions
Large diffs are not rendered by default.

documentation/case_constraints.html

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@
157157
<div class="headertitle"><div class="title">Case Creator Guide </div></div>
158158
</div><!--header-->
159159
<div class="contents">
160-
<div class="textblock"><h1 class="doxsection"><a class="anchor" id="autotoc_md38"></a>
160+
<div class="textblock"><h1 class="doxsection"><a class="anchor" id="autotoc_md39"></a>
161161
Case Creator Guide</h1>
162162
<blockquote class="doxtable">
163163
<p><b>Quick reference</b> for building MFC cases: working examples, compatibility rules, and configuration requirements. </p>
@@ -170,7 +170,7 @@ <h2 class="doxsection"><a class="anchor" id="case-design-playbook"></a>
170170
<blockquote class="doxtable">
171171
<p><b>Learn by example:</b> The cases below are curated from MFC's <span class="tt">examples/</span> directory and are validated, working configurations. Use them as blueprints for building your own simulations. </p>
172172
</blockquote>
173-
<h3 class="doxsection"><a class="anchor" id="autotoc_md39"></a>
173+
<h3 class="doxsection"><a class="anchor" id="autotoc_md40"></a>
174174
🟢 Beginner Examples</h3>
175175
<details >
176176
<summary >
@@ -196,7 +196,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md39"></a>
196196
</ul>
197197
<p></p>
198198
</details>
199-
<h3 class="doxsection"><a class="anchor" id="autotoc_md40"></a>
199+
<h3 class="doxsection"><a class="anchor" id="autotoc_md41"></a>
200200
🟡 Intermediate Examples</h3>
201201
<details >
202202
<summary >
@@ -329,7 +329,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md40"></a>
329329
</ul>
330330
<p></p>
331331
</details>
332-
<h3 class="doxsection"><a class="anchor" id="autotoc_md41"></a>
332+
<h3 class="doxsection"><a class="anchor" id="autotoc_md42"></a>
333333
🔴 Advanced Examples</h3>
334334
<details >
335335
<summary >
@@ -743,15 +743,6 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
743743
</details>
744744
<details >
745745
<summary >
746-
<b>cfl_max</b> (<span class="tt">cfl_max</span>)</summary>
747-
<p></p>
748-
<p><b>Schema constraints:</b></p><ul>
749-
<li>Min: 0</li>
750-
</ul>
751-
<p></p>
752-
</details>
753-
<details >
754-
<summary >
755746
<b>cfl_target</b> (<span class="tt">cfl_target</span>)</summary>
756747
<p></p>
757748
<p><b>Schema constraints:</b></p><ul>
@@ -1429,7 +1420,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14291420
</table>
14301421
<hr />
14311422
<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>
1432-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-19</div> </div></div><!-- contents -->
1423+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-20</div> </div></div><!-- contents -->
14331424
</div><!-- PageDoc -->
14341425
</div><!-- doc-content -->
14351426
<div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -157,16 +157,16 @@
157157
<div class="headertitle"><div class="title">CLI Reference </div></div>
158158
</div><!--header-->
159159
<div class="contents">
160-
<div class="textblock"><h1 class="doxsection"><a class="anchor" id="autotoc_md43"></a>
160+
<div class="textblock"><h1 class="doxsection"><a class="anchor" id="autotoc_md44"></a>
161161
CLI Reference</h1>
162162
<blockquote class="doxtable">
163163
<p><b>Auto-generated</b> from <span class="tt">toolchain/mfc/cli/commands.py</span></p>
164164
<p>Regenerate with: <span class="tt">./mfc.sh generate</span> </p>
165165
</blockquote>
166-
<h2 class="doxsection"><a class="anchor" id="autotoc_md44"></a>
166+
<h2 class="doxsection"><a class="anchor" id="autotoc_md45"></a>
167167
Overview</h2>
168168
<p>Welcome to the MFC master script. This tool automates and manages building, testing, running, and cleaning of MFC in various configurations on all supported platforms. The README documents this tool and its various commands in more detail. To get started, run <span class="tt">./mfc.sh build -h</span>.</p>
169-
<h2 class="doxsection"><a class="anchor" id="autotoc_md45"></a>
169+
<h2 class="doxsection"><a class="anchor" id="autotoc_md46"></a>
170170
Quick Reference</h2>
171171
<table class="markdownTable">
172172
<tr class="markdownTableHead">
@@ -216,7 +216,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md45"></a>
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>
218218
</table>
219-
<h2 class="doxsection"><a class="anchor" id="autotoc_md46"></a>
219+
<h2 class="doxsection"><a class="anchor" id="autotoc_md47"></a>
220220
Commands</h2>
221221
<h3 class="doxsection"><a class="anchor" id="build"></a>
222222
build</h3>
@@ -478,7 +478,7 @@ <h3 class="doxsection"><a class="anchor" id="validate"></a>
478478
<div class="line"># Validate with toolchain debug output</div>
479479
<div class="line">./mfc.sh validate case.py -d</div>
480480
</div><!-- fragment --><hr />
481-
<h2 class="doxsection"><a class="anchor" id="autotoc_md52"></a>
481+
<h2 class="doxsection"><a class="anchor" id="autotoc_md53"></a>
482482
Utility Commands</h2>
483483
<h3 class="doxsection"><a class="anchor" id="new"></a>
484484
new</h3>
@@ -654,7 +654,7 @@ <h3 class="doxsection"><a class="anchor" id="packer"></a>
654654
<div class="line"># Compare two packed files</div>
655655
<div class="line">./mfc.sh packer compare a.pack b.pack</div>
656656
</div><!-- fragment --><p><b>Subcommands:</b></p>
657-
<h4 class="doxsection"><a class="anchor" id="autotoc_md56"></a>
657+
<h4 class="doxsection"><a class="anchor" id="autotoc_md57"></a>
658658
packer pack</h4>
659659
<p>Pack a case into a single file.</p>
660660
<p>Arguments:</p><ul>
@@ -667,7 +667,7 @@ <h4 class="doxsection"><a class="anchor" id="autotoc_md56"></a>
667667
<tr class="markdownTableRowOdd">
668668
<td class="markdownTableBodyNone"><span class="tt">-o</span>, <span class="tt">--output</span> </td><td class="markdownTableBodyNone">Base name of output file. </td><td class="markdownTableBodyNone">- </td></tr>
669669
</table>
670-
<h4 class="doxsection"><a class="anchor" id="autotoc_md57"></a>
670+
<h4 class="doxsection"><a class="anchor" id="autotoc_md58"></a>
671671
packer compare</h4>
672672
<p>Compare two cases.</p>
673673
<p>Arguments:</p><ul>
@@ -735,7 +735,7 @@ <h3 class="doxsection"><a class="anchor" id="generate"></a>
735735
<div class="line"># Generate JSON Schema for IDE support</div>
736736
<div class="line">./mfc.sh generate --json-schema</div>
737737
</div><!-- fragment --><hr />
738-
<h2 class="doxsection"><a class="anchor" id="autotoc_md62"></a>
738+
<h2 class="doxsection"><a class="anchor" id="autotoc_md63"></a>
739739
Development Commands</h2>
740740
<h3 class="doxsection"><a class="anchor" id="lint"></a>
741741
lint</h3>
@@ -843,7 +843,7 @@ <h3 class="doxsection"><a class="anchor" id="count_diff"></a>
843843
<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>
844844
</table>
845845
<hr />
846-
<h2 class="doxsection"><a class="anchor" id="autotoc_md69"></a>
846+
<h2 class="doxsection"><a class="anchor" id="autotoc_md70"></a>
847847
CI Commands</h2>
848848
<h3 class="doxsection"><a class="anchor" id="bench"></a>
849849
bench</h3>
@@ -905,7 +905,7 @@ <h3 class="doxsection"><a class="anchor" id="bench_diff"></a>
905905
<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>
906906
</table>
907907
<hr />
908-
<h2 class="doxsection"><a class="anchor" id="autotoc_md72"></a>
908+
<h2 class="doxsection"><a class="anchor" id="autotoc_md73"></a>
909909
Other Commands</h2>
910910
<h3 class="doxsection"><a class="anchor" id="load"></a>
911911
load</h3>
@@ -923,10 +923,10 @@ <h3 class="doxsection"><a class="anchor" id="interactive"></a>
923923
<p>Launch an interactive menu for MFC operations.</p>
924924
<p><b>Usage:</b> <span class="tt">./mfc.sh interactive [OPTIONS]</span></p>
925925
<hr />
926-
<h2 class="doxsection"><a class="anchor" id="autotoc_md75"></a>
926+
<h2 class="doxsection"><a class="anchor" id="autotoc_md76"></a>
927927
Common Options</h2>
928928
<p>Many commands share common option sets:</p>
929-
<h3 class="doxsection"><a class="anchor" id="autotoc_md76"></a>
929+
<h3 class="doxsection"><a class="anchor" id="autotoc_md77"></a>
930930
Target Selection (<span class="tt">-t, --targets</span>)</h3>
931931
<p>Available targets:</p><ul>
932932
<li><span class="tt">pre_process</span> - Pre-processor</li>
@@ -935,7 +935,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md76"></a>
935935
<li><span class="tt">syscheck</span> - System check utility</li>
936936
<li><span class="tt">documentation</span> - Build documentation</li>
937937
</ul>
938-
<h3 class="doxsection"><a class="anchor" id="autotoc_md77"></a>
938+
<h3 class="doxsection"><a class="anchor" id="autotoc_md78"></a>
939939
Build Configuration Flags</h3>
940940
<table class="markdownTable">
941941
<tr class="markdownTableHead">
@@ -953,18 +953,18 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md77"></a>
953953
<tr class="markdownTableRowEven">
954954
<td class="markdownTableBodyNone"><span class="tt">--mixed</span> / <span class="tt">--no-mixed</span> </td><td class="markdownTableBodyNone">Mixed precision </td></tr>
955955
</table>
956-
<h3 class="doxsection"><a class="anchor" id="autotoc_md78"></a>
956+
<h3 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
957957
Verbosity (<span class="tt">-v, --verbose</span>)</h3>
958958
<p>Controls output verbosity level:</p>
959959
<ul>
960960
<li><span class="tt">-v</span> - Basic verbose output</li>
961961
<li><span class="tt">-vv</span> - Show build commands</li>
962962
<li><span class="tt">-vvv</span> - Full verbose output including CMake details</li>
963963
</ul>
964-
<h3 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
964+
<h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
965965
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
966966
<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-19</div> </div></div><!-- contents -->
967+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-20</div> </div></div><!-- contents -->
968968
</div><!-- PageDoc -->
969969
</div><!-- doc-content -->
970970
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)