Skip to content

Commit e3f2188

Browse files
author
MFC Action
committed
Docs @ 55fb1b1
1 parent a2081d2 commit e3f2188

178 files changed

Lines changed: 7373 additions & 11472 deletions

File tree

Some content is hidden

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

‎documentation/architecture.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
429429
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
430430
</ol>
431431
<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>
432-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-18</div> </div></div><!-- contents -->
432+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-19</div> </div></div><!-- contents -->
433433
</div><!-- PageDoc -->
434434
</div><!-- doc-content -->
435435
<div id="page-nav" class="page-nav-panel">

‎documentation/case_constraints.html‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -755,6 +755,10 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
755755
<li>HLLD hypoelasticity does not support chemistry</li>
756756
<li>riemann_hypo_ADC does not support bubbles, surface tension, chemistry, or continuum damage (the ADC HLL blend omits their flux components)</li>
757757
</ul>
758+
<p><b>Valid values</b> (errors):</p><ul>
759+
<li>chem_paramsreaction_substeps must be &gt;= 0 (0 = reaction source in the flow RHS; &gt; 0 = operator-split sub-stepping)</li>
760+
<li>chem_paramsreaction_substeps_max must be &gt;= reaction_substeps when adap_substeps = T</li>
761+
</ul>
758762
<p></p>
759763
</details>
760764
<details >
@@ -806,6 +810,8 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
806810
</ul>
807811
<p><b>Incompatibilities</b> (errors):</p><ul>
808812
<li>HLL Method 2 does not support MHD (the MHD path zeroes the shared interface-velocity trace)</li>
813+
<li>HLL Method 2 is not supported for 3D cylindrical geometry</li>
814+
<li>alt_soundspeed with HLL Method 1 is not supported for 2D axisymmetric geometry</li>
809815
</ul>
810816
<p></p>
811817
</details>
@@ -1073,7 +1079,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
10731079
<p><b>Incompatibilities</b> (errors):</p><ul>
10741080
<li>6-equation model (model_eqns = 3) does not support cylindrical coordinates (cyl_coord = T and p != 0)</li>
10751081
<li>3D cylindrical hypoelasticity is not supported</li>
1076-
<li>Fully 3D cylindrical geometry (cyl_coord = T, p &gt; 0) is not supported in single precision (&ndash;single)</li>
1082+
<li>HLL Method 2 is not supported for 3D cylindrical geometry</li>
10771083
</ul>
10781084
<p><b>Valid values</b> (errors):</p><ul>
10791085
<li>p must be non-negative</li>
@@ -1494,7 +1500,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14941500
</table>
14951501
<hr />
14961502
<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>
1497-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-18</div> </div></div><!-- contents -->
1503+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-19</div> </div></div><!-- contents -->
14981504
</div><!-- PageDoc -->
14991505
</div><!-- doc-content -->
15001506
<div id="page-nav" class="page-nav-panel">

‎documentation/cli-reference.html‎

Lines changed: 14 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -192,21 +192,17 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md49"></a>
192192
<tr class="markdownTableRowEven">
193193
<td class="markdownTableBodyNone"><a class="el" href="#completion" title="completion"><code>completion</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Install shell tab-completion. </td></tr>
194194
<tr class="markdownTableRowOdd">
195-
<td class="markdownTableBodyNone"><a class="el" href="#help" title="help"><code>help</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Show help on a topic. </td></tr>
196-
<tr class="markdownTableRowEven">
197195
<td class="markdownTableBodyNone"><a class="el" href="#generate" title="generate"><code>generate</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Regenerate completion scripts from CLI schema. </td></tr>
198-
<tr class="markdownTableRowOdd">
199-
<td class="markdownTableBodyNone"><a class="el" href="#load" title="load"><code>load</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Loads the MFC environment with source. </td></tr>
200196
<tr class="markdownTableRowEven">
201-
<td class="markdownTableBodyNone"><a class="el" href="#lint" title="lint"><code>lint</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Lints and tests all toolchain code. </td></tr>
197+
<td class="markdownTableBodyNone"><a class="el" href="#load" title="load"><code>load</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Loads the MFC environment with source. </td></tr>
202198
<tr class="markdownTableRowOdd">
203-
<td class="markdownTableBodyNone"><a class="el" href="#format" title="format"><code>format</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Formats all code after editing. </td></tr>
199+
<td class="markdownTableBodyNone"><a class="el" href="#lint" title="lint"><code>lint</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Lints and tests all toolchain code. </td></tr>
204200
<tr class="markdownTableRowEven">
205-
<td class="markdownTableBodyNone"><a class="el" href="#spelling" title="spelling"><code>spelling</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Runs the spell checker after editing. </td></tr>
201+
<td class="markdownTableBodyNone"><a class="el" href="#format" title="format"><code>format</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Formats all code after editing. </td></tr>
206202
<tr class="markdownTableRowOdd">
207-
<td class="markdownTableBodyNone"><a class="el" href="#precheck" title="precheck"><code>precheck</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Run CI lint checks locally before committing. </td></tr>
203+
<td class="markdownTableBodyNone"><a class="el" href="#spelling" title="spelling"><code>spelling</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Runs the spell checker after editing. </td></tr>
208204
<tr class="markdownTableRowEven">
209-
<td class="markdownTableBodyNone"><a class="el" href="#interactive" title="interactive"><code>interactive</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Launch interactive menu-driven interface. </td></tr>
205+
<td class="markdownTableBodyNone"><a class="el" href="#precheck" title="precheck"><code>precheck</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Run CI lint checks locally before committing. </td></tr>
210206
<tr class="markdownTableRowOdd">
211207
<td class="markdownTableBodyNone"><a class="el" href="#bench" title="bench"><code>bench</code></a> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Benchmark MFC (for CI). </td></tr>
212208
<tr class="markdownTableRowEven">
@@ -728,15 +724,6 @@ <h3 class="doxsection"><a class="anchor" id="completion"></a>
728724
<div class="line"># Check completion installation status</div>
729725
<div class="line">./mfc.sh completion status</div>
730726
</div><!-- fragment --><hr />
731-
<h3 class="doxsection"><a class="anchor" id="help"></a>
732-
help</h3>
733-
<p>Show help on a topic.</p>
734-
<p><b>Usage:</b> <span class="tt">./mfc.sh help [TOPIC] [OPTIONS]</span></p>
735-
<p><b>Arguments:</b></p>
736-
<ul>
737-
<li><span class="tt">TOPIC</span> - Help topic: gpu, clusters, batch, debugging, performance</li>
738-
</ul>
739-
<hr />
740727
<h3 class="doxsection"><a class="anchor" id="generate"></a>
741728
generate</h3>
742729
<p>Regenerate shell completion scripts, documentation, and JSON schema from the CLI schema.</p>
@@ -760,7 +747,7 @@ <h3 class="doxsection"><a class="anchor" id="generate"></a>
760747
<div class="line"># Generate JSON Schema for IDE support</div>
761748
<div class="line">./mfc.sh generate --json-schema</div>
762749
</div><!-- fragment --><hr />
763-
<h2 class="doxsection"><a class="anchor" id="autotoc_md66"></a>
750+
<h2 class="doxsection"><a class="anchor" id="autotoc_md65"></a>
764751
Development Commands</h2>
765752
<h3 class="doxsection"><a class="anchor" id="lint"></a>
766753
lint</h3>
@@ -872,7 +859,7 @@ <h3 class="doxsection"><a class="anchor" id="count_diff"></a>
872859
<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>
873860
</table>
874861
<hr />
875-
<h2 class="doxsection"><a class="anchor" id="autotoc_md73"></a>
862+
<h2 class="doxsection"><a class="anchor" id="autotoc_md72"></a>
876863
CI Commands</h2>
877864
<h3 class="doxsection"><a class="anchor" id="bench"></a>
878865
bench</h3>
@@ -938,7 +925,7 @@ <h3 class="doxsection"><a class="anchor" id="bench_diff"></a>
938925
<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>
939926
</table>
940927
<hr />
941-
<h2 class="doxsection"><a class="anchor" id="autotoc_md76"></a>
928+
<h2 class="doxsection"><a class="anchor" id="autotoc_md75"></a>
942929
Other Commands</h2>
943930
<h3 class="doxsection"><a class="anchor" id="load"></a>
944931
load</h3>
@@ -951,15 +938,10 @@ <h3 class="doxsection"><a class="anchor" id="load"></a>
951938
<div class="line"># Load Frontier CPU modules</div>
952939
<div class="line">source ./mfc.sh load -c f -m c</div>
953940
</div><!-- fragment --><hr />
954-
<h3 class="doxsection"><a class="anchor" id="interactive"></a>
955-
interactive</h3>
956-
<p>Launch an interactive menu for MFC operations.</p>
957-
<p><b>Usage:</b> <span class="tt">./mfc.sh interactive [OPTIONS]</span></p>
958-
<hr />
959-
<h2 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
941+
<h2 class="doxsection"><a class="anchor" id="autotoc_md77"></a>
960942
Common Options</h2>
961943
<p>Many commands share common option sets:</p>
962-
<h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
944+
<h3 class="doxsection"><a class="anchor" id="autotoc_md78"></a>
963945
Target Selection (<span class="tt">-t, --targets</span>)</h3>
964946
<p>Available targets:</p><ul>
965947
<li><span class="tt">pre_process</span> - Pre-processor</li>
@@ -968,7 +950,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
968950
<li><span class="tt">syscheck</span> - System check utility</li>
969951
<li><span class="tt">documentation</span> - Build documentation</li>
970952
</ul>
971-
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
953+
<h3 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
972954
Build Configuration Flags</h3>
973955
<table class="markdownTable">
974956
<tr class="markdownTableHead">
@@ -988,18 +970,18 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
988970
<tr class="markdownTableRowOdd">
989971
<td class="markdownTableBodyNone"><span class="tt">--mixed</span> / <span class="tt">--no-mixed</span> </td><td class="markdownTableBodyNone">Mixed precision </td></tr>
990972
</table>
991-
<h3 class="doxsection"><a class="anchor" id="autotoc_md82"></a>
973+
<h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
992974
Verbosity (<span class="tt">-v, --verbose</span>)</h3>
993975
<p>Controls output verbosity level:</p>
994976
<ul>
995977
<li><span class="tt">-v</span> - Basic verbose output</li>
996978
<li><span class="tt">-vv</span> - Show build commands</li>
997979
<li><span class="tt">-vvv</span> - Full verbose output including CMake details</li>
998980
</ul>
999-
<h3 class="doxsection"><a class="anchor" id="autotoc_md83"></a>
981+
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
1000982
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
1001983
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
1002-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-18</div> </div></div><!-- contents -->
984+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-19</div> </div></div><!-- contents -->
1003985
</div><!-- PageDoc -->
1004986
</div><!-- doc-content -->
1005987
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)