Skip to content

Commit e441379

Browse files
author
MFC Action
committed
Docs @ a6add01
1 parent fddfb9f commit e441379

44 files changed

Lines changed: 3635 additions & 3149 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-09</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-10</div> </div></div><!-- contents -->
437437
</div><!-- PageDoc -->
438438
</div><!-- doc-content -->
439439
<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-09</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-10</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-09</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-10</div> </div></div><!-- contents -->
997997
</div><!-- PageDoc -->
998998
</div><!-- doc-content -->
999999
<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-09</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-10</div> </div></div><!-- contents -->
978978
</div><!-- PageDoc -->
979979
</div><!-- doc-content -->
980980
<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
@@ -1870,7 +1870,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md490"></a>
18701870
<div class="line"> </div>
18711871
<div class="line"># Filter by type</div>
18721872
<div class="line">./mfc.sh params -t real weno</div>
1873-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-09</div> </div></div><!-- contents -->
1873+
</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 -->
18741874
</div><!-- PageDoc -->
18751875
</div><!-- doc-content -->
18761876
<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
@@ -819,7 +819,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md553"></a>
819819
<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>
820820
<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>
821821
</ul>
822-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-09</div> </div></div><!-- contents -->
822+
<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 -->
823823
</div><!-- PageDoc -->
824824
</div><!-- doc-content -->
825825
<div id="page-nav" class="page-nav-panel">

‎simulation/doxygen_crawl.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1677,6 +1677,7 @@
16771677
<a href="namespacem__time__steppers.html#a54bbce0f63af75d4f6caca272a675a17"/>
16781678
<a href="namespacem__time__steppers.html#a575aa7f95bf96994f49d81d71d19c192"/>
16791679
<a href="namespacem__time__steppers.html#a60788902b510a52b5353d35b96c03884"/>
1680+
<a href="namespacem__time__steppers.html#a642d35df6fdabfeca26587ac4ffa1941"/>
16801681
<a href="namespacem__time__steppers.html#a72d421d80bf4592428f20416cc2047f5"/>
16811682
<a href="namespacem__time__steppers.html#a9b1ba77bd20d4a08f515cc6b247f3263"/>
16821683
<a href="namespacem__time__steppers.html#aa8e209d6747df776d818d3d4320ccf4d"/>

‎simulation/m__time__steppers_8fpp_8f90.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,8 @@
178178
<tr class="memdesc:a478ee89172580cccd27e418731bc09b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bubble source part in Strang operator splitting scheme. <br /></td></tr>
179179
<tr class="memitem:ac56d2ccae6e6dbce231569d173aae88a" id="r_ac56d2ccae6e6dbce231569d173aae88a"><td class="memItemLeft">impure subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__time__steppers.html#ac56d2ccae6e6dbce231569d173aae88a">m_time_steppers::s_compute_dt</a> ()</td></tr>
180180
<tr class="memdesc:ac56d2ccae6e6dbce231569d173aae88a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the global time step size from CFL stability constraints across all cells. <br /></td></tr>
181+
<tr class="memitem:a642d35df6fdabfeca26587ac4ffa1941" id="r_a642d35df6fdabfeca26587ac4ffa1941"><td class="memItemLeft">impure subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__time__steppers.html#a642d35df6fdabfeca26587ac4ffa1941">m_time_steppers::s_abort_on_bad_dt_cell</a> (idx)</td></tr>
182+
<tr class="memdesc:a642d35df6fdabfeca26587ac4ffa1941"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abort with the location of a fluid cell whose state admits no valid time step (NaN or non-positive inviscid dt). <br /></td></tr>
181183
<tr class="memitem:a2238f553b1b6228709f9e3387d41cb01" id="r_a2238f553b1b6228709f9e3387d41cb01"><td class="memItemLeft">subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__time__steppers.html#a2238f553b1b6228709f9e3387d41cb01">m_time_steppers::s_apply_bodyforces</a> (<a class="el" href="m__phase__change_8fpp_8f90.html#a6d2af1366163bbea81771912d405abfa">q_cons_vf</a>, q_prim_vf_in, rhs_vf_in, ldt)</td></tr>
182184
<tr class="memdesc:a2238f553b1b6228709f9e3387d41cb01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply the body forces source term at each Runge-Kutta stage. <br /></td></tr>
183185
<tr class="memitem:a19b72196160438bd0c5f88c7ac4e6684" id="r_a19b72196160438bd0c5f88c7ac4e6684"><td class="memItemLeft">subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__time__steppers.html#a19b72196160438bd0c5f88c7ac4e6684">m_time_steppers::s_apply_synthetic_turbulence_force</a> (<a class="el" href="m__phase__change_8fpp_8f90.html#a6d2af1366163bbea81771912d405abfa">q_cons_vf</a>, q_prim_vf_in, rhs_vf_in, ldt)</td></tr>

‎simulation/m__time__steppers_8fpp_8f90.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
var m__time__steppers_8fpp_8f90 =
22
[
3+
[ "m_time_steppers::s_abort_on_bad_dt_cell", "namespacem__time__steppers.html#a642d35df6fdabfeca26587ac4ffa1941", null ],
34
[ "m_time_steppers::s_adaptive_dt_bubble", "namespacem__time__steppers.html#a478ee89172580cccd27e418731bc09b6", null ],
45
[ "m_time_steppers::s_apply_bodyforces", "namespacem__time__steppers.html#a2238f553b1b6228709f9e3387d41cb01", null ],
56
[ "m_time_steppers::s_apply_synthetic_turbulence_force", "namespacem__time__steppers.html#a19b72196160438bd0c5f88c7ac4e6684", null ],

0 commit comments

Comments
 (0)