Skip to content

Commit 015a7fc

Browse files
author
MFC Action
committed
Docs @ 17c16b6
1 parent ab58eff commit 015a7fc

6 files changed

Lines changed: 23 additions & 13 deletions

File tree

‎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-23</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-24</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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1500,7 +1500,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
15001500
</table>
15011501
<hr />
15021502
<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>
1503-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-23</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-24</div> </div></div><!-- contents -->
15041504
</div><!-- PageDoc -->
15051505
</div><!-- doc-content -->
15061506
<div id="page-nav" class="page-nav-panel">

‎documentation/cli-reference.html‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md49"></a>
210210
<tr class="markdownTableRowOdd">
211211
<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>
212212
<tr class="markdownTableRowEven">
213-
<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>
213+
<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 two MFC source trees. </td></tr>
214214
<tr class="markdownTableRowOdd">
215215
<td class="markdownTableBodyNone"><code>fp-stability</code> </td><td class="markdownTableBodyNone">- </td><td class="markdownTableBodyNone">Run floating-point stability tests using Verrou. </td></tr>
216216
</table>
@@ -835,8 +835,13 @@ <h3 class="doxsection"><a class="anchor" id="count"></a>
835835
</div><!-- fragment --><hr />
836836
<h3 class="doxsection"><a class="anchor" id="count_diff"></a>
837837
count_diff</h3>
838-
<p>Compare LOC between branches.</p>
839-
<p><b>Usage:</b> <span class="tt">./mfc.sh count_diff [OPTIONS]</span></p>
838+
<p>Compare LOC between two MFC source trees.</p>
839+
<p><b>Usage:</b> <span class="tt">./mfc.sh count_diff BASE PR [OPTIONS]</span></p>
840+
<p><b>Arguments:</b></p>
841+
<ul>
842+
<li><span class="tt">BASE</span> - Path to the baseline MFC source tree.</li>
843+
<li><span class="tt">PR</span> - Path to the MFC source tree to compare against the baseline.</li>
844+
</ul>
840845
<p><b>Options:</b></p>
841846
<table class="markdownTable">
842847
<tr class="markdownTableHead">
@@ -850,15 +855,20 @@ <h3 class="doxsection"><a class="anchor" id="count_diff"></a>
850855
<tr class="markdownTableRowEven">
851856
<td class="markdownTableBodyNone"><span class="tt">-d</span>, <span class="tt">--debug-log</span> </td><td class="markdownTableBodyNone">Enable Python toolchain debug logging (not MFC code). </td><td class="markdownTableBodyNone">- </td></tr>
852857
<tr class="markdownTableRowOdd">
853-
<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>
858+
<td class="markdownTableBodyNone"><span class="tt">--markdown</span> </td><td class="markdownTableBodyNone">Also write the diff as GitHub-flavored Markdown to PATH (empty if nothing changed). </td><td class="markdownTableBodyNone">- </td></tr>
854859
<tr class="markdownTableRowEven">
855-
<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>
860+
<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>
856861
<tr class="markdownTableRowOdd">
857-
<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>
862+
<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>
858863
<tr class="markdownTableRowEven">
864+
<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>
865+
<tr class="markdownTableRowOdd">
859866
<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>
860867
</table>
861-
<hr />
868+
<p><b>Examples:</b></p>
869+
<div class="fragment"><div class="line"># Compare this tree&#39;s LOC against another checkout</div>
870+
<div class="line">./mfc.sh count_diff ../master .</div>
871+
</div><!-- fragment --><hr />
862872
<h2 class="doxsection"><a class="anchor" id="autotoc_md72"></a>
863873
CI Commands</h2>
864874
<h3 class="doxsection"><a class="anchor" id="bench"></a>
@@ -981,7 +991,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
981991
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
982992
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
983993
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
984-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-23</div> </div></div><!-- contents -->
994+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-24</div> </div></div><!-- contents -->
985995
</div><!-- PageDoc -->
986996
</div><!-- doc-content -->
987997
<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
@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md311"></a>
630630
<ul>
631631
<li>Papanastasiou, T. C. (1987). Flows of materials with yield. <em>J. Rheol.</em> 31, 385.</li>
632632
</ul>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-23</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-24</div> </div></div><!-- contents -->
634634
</div><!-- PageDoc -->
635635
</div><!-- doc-content -->
636636
<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
@@ -1750,7 +1750,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md445"></a>
17501750
<div class="line"> </div>
17511751
<div class="line"># Filter by type</div>
17521752
<div class="line">./mfc.sh params -t real weno</div>
1753-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-23</div> </div></div><!-- contents -->
1753+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-24</div> </div></div><!-- contents -->
17541754
</div><!-- PageDoc -->
17551755
</div><!-- doc-content -->
17561756
<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
@@ -740,7 +740,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md504"></a>
740740
<li><code class="f90l">patch_icpp(i)%</code><code class="f90r">hcid</code>=hcid requires <span class="tt">files_dir</span> to be set</li>
741741
<li><code class="f90l">patch_icpp(i)%</code><code class="f90r">hcid</code>=hcid requires <span class="tt">file_extension</span> to be set</li>
742742
</ul>
743-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-23</div> </div></div><!-- contents -->
743+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-24</div> </div></div><!-- contents -->
744744
</div><!-- PageDoc -->
745745
</div><!-- doc-content -->
746746
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)