Skip to content

Commit e5fa0fb

Browse files
author
MFC Action
committed
Docs @ 30e7004
1 parent aa03f72 commit e5fa0fb

9 files changed

Lines changed: 2206 additions & 2212 deletions

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-31</div> </div></div><!-- contents -->
432+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-01</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-31</div> </div></div><!-- contents -->
1503+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-01</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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -991,7 +991,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
991991
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
992992
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
993993
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
994-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-31</div> </div></div><!-- contents -->
994+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-01</div> </div></div><!-- contents -->
995995
</div><!-- PageDoc -->
996996
</div><!-- doc-content -->
997997
<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-31</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-01</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
@@ -1758,7 +1758,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md448"></a>
17581758
<div class="line"> </div>
17591759
<div class="line"># Filter by type</div>
17601760
<div class="line">./mfc.sh params -t real weno</div>
1761-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-31</div> </div></div><!-- contents -->
1761+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-01</div> </div></div><!-- contents -->
17621762
</div><!-- PageDoc -->
17631763
</div><!-- doc-content -->
17641764
<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_md507"></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-31</div> </div></div><!-- contents -->
743+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-01</div> </div></div><!-- contents -->
744744
</div><!-- PageDoc -->
745745
</div><!-- doc-content -->
746746
<div id="page-nav" class="page-nav-panel">

simulation/m__bubbles__EL_8fpp_8f90_source.html

Lines changed: 2179 additions & 2185 deletions
Large diffs are not rendered by default.

simulation/m__start__up_8fpp_8f90_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2683,8 +2683,8 @@
26832683
<div class="ttc" id="anamespacem__bubbles__ee_html"><div class="ttname"><a href="namespacem__bubbles__ee.html">m_bubbles_ee</a></div><div class="ttdoc">Computes ensemble-averaged (Euler–Euler) bubble source terms for radius, velocity,...</div><div class="ttdef"><b>Definition</b> <a href="m__bubbles__EE_8fpp_8f90_source.html#l00323">m_bubbles_EE.fpp.f90:323</a></div></div>
26842684
<div class="ttc" id="anamespacem__bubbles__ee_html_acdf857ad6b9f389ee1bd4dd81bbc23a5"><div class="ttname"><a href="namespacem__bubbles__ee.html#acdf857ad6b9f389ee1bd4dd81bbc23a5">m_bubbles_ee::s_initialize_bubbles_ee_module</a></div><div class="ttdeci">impure subroutine s_initialize_bubbles_ee_module</div><div class="ttdoc">Initialize the Euler-Euler bubble module.</div><div class="ttdef"><b>Definition</b> <a href="m__bubbles__EE_8fpp_8f90_source.html#l00376">m_bubbles_EE.fpp.f90:377</a></div></div>
26852685
<div class="ttc" id="anamespacem__bubbles__el_html"><div class="ttname"><a href="namespacem__bubbles__el.html">m_bubbles_el</a></div><div class="ttdoc">Tracks Lagrangian bubbles and couples their dynamics to the Eulerian flow via volume averaging.</div><div class="ttdef"><b>Definition</b> <a href="m__bubbles__EL_8fpp_8f90_source.html#l00323">m_bubbles_EL.fpp.f90:323</a></div></div>
2686-
<div class="ttc" id="anamespacem__bubbles__el_html_a00f224f76db49025f0c974450db5fb2f"><div class="ttname"><a href="namespacem__bubbles__el.html#a00f224f76db49025f0c974450db5fb2f">m_bubbles_el::s_write_lag_bubble_stats</a></div><div class="ttdeci">impure subroutine s_write_lag_bubble_stats()</div><div class="ttdoc">Write the maximum and minimum radius of each bubble.</div><div class="ttdef"><b>Definition</b> <a href="m__bubbles__EL_8fpp_8f90_source.html#l04759">m_bubbles_EL.fpp.f90:4760</a></div></div>
2687-
<div class="ttc" id="anamespacem__bubbles__el_html_a380e92c53e3fc9298b7443a4fe7ac7af"><div class="ttname"><a href="namespacem__bubbles__el.html#a380e92c53e3fc9298b7443a4fe7ac7af">m_bubbles_el::s_write_restart_lag_bubbles</a></div><div class="ttdeci">impure subroutine s_write_restart_lag_bubbles(t_step)</div><div class="ttdoc">Write restart files for the Lagrangian bubble solver.</div><div class="ttdef"><b>Definition</b> <a href="m__bubbles__EL_8fpp_8f90_source.html#l04547">m_bubbles_EL.fpp.f90:4548</a></div></div>
2686+
<div class="ttc" id="anamespacem__bubbles__el_html_a00f224f76db49025f0c974450db5fb2f"><div class="ttname"><a href="namespacem__bubbles__el.html#a00f224f76db49025f0c974450db5fb2f">m_bubbles_el::s_write_lag_bubble_stats</a></div><div class="ttdeci">impure subroutine s_write_lag_bubble_stats()</div><div class="ttdoc">Write the maximum and minimum radius of each bubble.</div><div class="ttdef"><b>Definition</b> <a href="m__bubbles__EL_8fpp_8f90_source.html#l04753">m_bubbles_EL.fpp.f90:4754</a></div></div>
2687+
<div class="ttc" id="anamespacem__bubbles__el_html_a380e92c53e3fc9298b7443a4fe7ac7af"><div class="ttname"><a href="namespacem__bubbles__el.html#a380e92c53e3fc9298b7443a4fe7ac7af">m_bubbles_el::s_write_restart_lag_bubbles</a></div><div class="ttdeci">impure subroutine s_write_restart_lag_bubbles(t_step)</div><div class="ttdoc">Write restart files for the Lagrangian bubble solver.</div><div class="ttdef"><b>Definition</b> <a href="m__bubbles__EL_8fpp_8f90_source.html#l04541">m_bubbles_EL.fpp.f90:4542</a></div></div>
26882688
<div class="ttc" id="anamespacem__bubbles__el_html_ac2feec1265bc9137083e18e9990f84d5"><div class="ttname"><a href="namespacem__bubbles__el.html#ac2feec1265bc9137083e18e9990f84d5">m_bubbles_el::q_beta</a></div><div class="ttdeci">type(scalar_field), dimension(:), allocatable q_beta</div><div class="ttdoc">Projection of the lagrangian particles in the Eulerian framework.</div><div class="ttdef"><b>Definition</b> <a href="m__bubbles__EL_8fpp_8f90_source.html#l00441">m_bubbles_EL.fpp.f90:441</a></div></div>
26892689
<div class="ttc" id="anamespacem__bubbles__el_html_ad918924d606b49b86b473bf86143e233"><div class="ttname"><a href="namespacem__bubbles__el.html#ad918924d606b49b86b473bf86143e233">m_bubbles_el::intfc_rad</a></div><div class="ttdeci">real(wp), dimension(:,:), allocatable intfc_rad</div><div class="ttdoc">Bubble radius.</div><div class="ttdef"><b>Definition</b> <a href="m__bubbles__EL_8fpp_8f90_source.html#l00378">m_bubbles_EL.fpp.f90:378</a></div></div>
26902690
<div class="ttc" id="anamespacem__cbc_html"><div class="ttname"><a href="namespacem__cbc.html">m_cbc</a></div><div class="ttdoc">Characteristic boundary conditions (CBC) for slip walls, non-reflecting subsonic inflow/outflow,...</div><div class="ttdef"><b>Definition</b> <a href="m__cbc_8fpp_8f90_source.html#l00334">m_cbc.fpp.f90:334</a></div></div>

0 commit comments

Comments
 (0)