Skip to content

Commit 19b6274

Browse files
author
MFC Action
committed
Docs @ ce6194e
1 parent 6082446 commit 19b6274

175 files changed

Lines changed: 2904 additions & 2905 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
@@ -433,7 +433,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
433433
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
434434
</ol>
435435
<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>
436-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-11</div> </div></div><!-- contents -->
436+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-12</div> </div></div><!-- contents -->
437437
</div><!-- PageDoc -->
438438
</div><!-- doc-content -->
439439
<div id="page-nav" class="page-nav-panel">

‎documentation/authors.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@
160160
<div class="textblock"><h2 class="doxsection"><a class="anchor" id="autotoc_md14"></a>
161161
Authors</h2>
162162
<p>Contributors to MFC since 2019 can be <a href="https://github.com/MFlowCode/MFC/graphs/contributors">viewed here</a>.</p>
163-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-04</div> </div></div><!-- contents -->
163+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-10</div> </div></div><!-- contents -->
164164
</div><!-- PageDoc -->
165165
</div><!-- doc-content -->
166166
<div id="page-nav" class="page-nav-panel">

‎documentation/case.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md19"></a>
207207
<li>Requirements for each model equation and Riemann solver</li>
208208
</ul>
209209
<p><b>Parameter Lookup:</b></p><ul>
210-
<li>CLI search: <span class="tt">./mfc.sh params &lt;query&gt;</span> - Search ~3,300 parameters from the command line</li>
210+
<li>CLI search: <span class="tt">./mfc.sh params &lt;query&gt;</span> - Search parameters from the command line</li>
211211
<li>Full reference: <b><a class="el" href="parameters.html" title="Case Parameters">Case Parameters</a></b> - Complete parameter documentation</li>
212212
</ul>
213213
<p>There are multiple sets of parameters that must be specified in the python input file:</p><ol type="1">
@@ -1871,7 +1871,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md41"></a>
18711871
<td class="markdownTableBodyNone">hypoelastic variables </td><td class="markdownTableBodyNone">N/A </td></tr>
18721872
</table>
18731873
<p>The above variables correspond to optional physics.</p>
1874-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-15</div> </div></div><!-- contents -->
1874+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-10</div> </div></div><!-- contents -->
18751875
</div><!-- PageDoc -->
18761876
</div><!-- doc-content -->
18771877
<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
@@ -1618,7 +1618,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
16181618
</table>
16191619
<hr />
16201620
<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>
1621-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-11</div> </div></div><!-- contents -->
1621+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-12</div> </div></div><!-- contents -->
16221622
</div><!-- PageDoc -->
16231623
</div><!-- doc-content -->
16241624
<div id="page-nav" class="page-nav-panel">

‎documentation/cli-reference.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -993,7 +993,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
993993
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
994994
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
995995
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
996-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-11</div> </div></div><!-- contents -->
996+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-12</div> </div></div><!-- contents -->
997997
</div><!-- PageDoc -->
998998
</div><!-- doc-content -->
999999
<div id="page-nav" class="page-nav-panel">

‎documentation/contributing.html‎

Lines changed: 79 additions & 105 deletions
Large diffs are not rendered by default.

‎documentation/docker.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md139"></a>
279279
<div class="line">linux/loong64</div>
280280
<div class="line">linux/arm/v7</div>
281281
<div class="line">linux/arm/v6</div>
282-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-04</div> </div></div><!-- contents -->
282+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-10</div> </div></div><!-- contents -->
283283
</div><!-- PageDoc -->
284284
</div><!-- doc-content -->
285285
<div id="page-nav" class="page-nav-panel">

‎documentation/doxygen_crawl.html‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -659,20 +659,20 @@
659659
<a href="troubleshooting.html#autotoc_md631"/>
660660
<a href="troubleshooting.html#autotoc_md632"/>
661661
<a href="troubleshooting.html#autotoc_md633"/>
662-
<a href="troubleshooting.html#autotoc_md635"/>
662+
<a href="troubleshooting.html#autotoc_md634"/>
663663
<a href="troubleshooting.html#autotoc_md636"/>
664664
<a href="troubleshooting.html#autotoc_md637"/>
665665
<a href="troubleshooting.html#autotoc_md638"/>
666666
<a href="troubleshooting.html#autotoc_md639"/>
667-
<a href="troubleshooting.html#autotoc_md641"/>
667+
<a href="troubleshooting.html#autotoc_md640"/>
668668
<a href="troubleshooting.html#autotoc_md642"/>
669669
<a href="troubleshooting.html#autotoc_md643"/>
670670
<a href="troubleshooting.html#autotoc_md644"/>
671671
<a href="troubleshooting.html#autotoc_md645"/>
672-
<a href="troubleshooting.html#autotoc_md647"/>
672+
<a href="troubleshooting.html#autotoc_md646"/>
673+
<a href="troubleshooting.html#autotoc_md648"/>
673674
<a href="visualization.html"/>
674-
<a href="visualization.html#autotoc_md648"/>
675-
<a href="visualization.html#autotoc_md650"/>
675+
<a href="visualization.html#autotoc_md649"/>
676676
<a href="visualization.html#autotoc_md651"/>
677677
<a href="visualization.html#autotoc_md652"/>
678678
<a href="visualization.html#autotoc_md653"/>
@@ -685,13 +685,14 @@
685685
<a href="visualization.html#autotoc_md660"/>
686686
<a href="visualization.html#autotoc_md661"/>
687687
<a href="visualization.html#autotoc_md662"/>
688-
<a href="visualization.html#autotoc_md664"/>
688+
<a href="visualization.html#autotoc_md663"/>
689689
<a href="visualization.html#autotoc_md665"/>
690690
<a href="visualization.html#autotoc_md666"/>
691691
<a href="visualization.html#autotoc_md667"/>
692692
<a href="visualization.html#autotoc_md668"/>
693693
<a href="visualization.html#autotoc_md669"/>
694694
<a href="visualization.html#autotoc_md670"/>
695695
<a href="visualization.html#autotoc_md671"/>
696+
<a href="visualization.html#autotoc_md672"/>
696697
</body>
697698
</html>

‎documentation/equations.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1209,7 +1209,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md217"></a>
12091209
\[\alpha_k \leftarrow \frac{\alpha_k}{\sum_j \alpha_j}\]
12101210
</p>
12111211
<p><b>Advective flux limiting</b> based on local volume fraction gradient \(\chi\) to prevent spurious oscillations near material interfaces.</p>
1212-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-15</div> </div></div><!-- contents -->
1212+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-10</div> </div></div><!-- contents -->
12131213
</div><!-- PageDoc -->
12141214
</div><!-- doc-content -->
12151215
<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
@@ -974,7 +974,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md350"></a>
974974
<h3 class="doxsection"><a class="anchor" id="autotoc_md351"></a>
975975
Density Norms</h3>
976976
<p><img src="density_norms-2D_isentropicvortex-example.png" alt="" height="400" class="inline"/></p>
977-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-11</div> </div></div><!-- contents -->
977+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-12</div> </div></div><!-- contents -->
978978
</div><!-- PageDoc -->
979979
</div><!-- doc-content -->
980980
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)