Skip to content

Commit 28d439f

Browse files
author
MFC Action
committed
Docs @ 21a4ebe
1 parent a031ee9 commit 28d439f

35 files changed

Lines changed: 7482 additions & 7308 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-20</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-21</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-20</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-21</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
@@ -981,7 +981,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
981981
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
982982
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
983983
<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-20</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-21</div> </div></div><!-- contents -->
985985
</div><!-- PageDoc -->
986986
</div><!-- doc-content -->
987987
<div id="page-nav" class="page-nav-panel">

documentation/equations.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ <h4 class="doxsection"><a class="anchor" id="autotoc_md159"></a>
579579
6.1.1 Method of Classes (Commander and Prosperetti <a class="el" href="citelist.html#CITEREF_commander89">[13]</a>; Ando et al. <a class="el" href="citelist.html#CITEREF_ando11">[2]</a>)</h4>
580580
<p><b>Modified mixture pressure:</b></p>
581581
<p class="formulaDsp">
582-
\[p = (1 - \alpha)\,p_l + \alpha\left(\frac{R^3\,p_{bw}}{\bar{R}^3} - \frac{\rho\,R^3\,\dot{R}^2}{\bar{R}^3}\right)\]
582+
\[p = (1 - \alpha)\,p_l + \alpha\left(\frac{R^3\,p_{bw}}{\bar{R}^3} + \frac{\rho\,R^3\,\dot{R}^2}{\bar{R}^3}\right)\]
583583
</p>
584584
<p><b>Modified stiffened gas for the liquid phase:</b></p>
585585
<p class="formulaDsp">

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-20</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-21</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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1635,7 +1635,7 @@ <h2 class="doxsection"><a class="anchor" id="general"></a>
16351635
<tr class="markdownTableRowOdd">
16361636
<td class="markdownTableBodyNone"><span class="tt">relativity</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Enable special relativity </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone"><span class="tt">relativity</span> requires <span class="tt">mhd</span> to be enabled; HLLD is not available for RMHD (<span class="tt">relativity</span>) </td></tr>
16371637
<tr class="markdownTableRowEven">
1638-
<td class="markdownTableBodyNone"><span class="tt">relax</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Enable relaxation terms </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">phase change requires <span class="tt">model_eqns</span>==2 with <span class="tt">relax_model</span> in [5,6] or <span class="tt">model_eqns</span>==3 with <span class="tt">relax_model</span> in [1,4,5,6]; <span class="tt">palpha_eps</span> must be positive; <span class="tt">palpha_eps</span> must be less than 1 </td></tr>
1638+
<td class="markdownTableBodyNone"><span class="tt">relax</span> </td><td class="markdownTableBodyNone">Logical (T/F) </td><td class="markdownTableBodyNone">Enable relaxation terms </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">phase change requires <span class="tt">num_fluids</span> &gt;= 2 (liquid = 1, vapor = 2); phase change requires <span class="tt">model_eqns</span>==2 with <span class="tt">relax_model</span> in [5,6] or <span class="tt">model_eqns</span>==3 with <span class="tt">relax_model</span> in [1,4,5,6]; <span class="tt">palpha_eps</span> must be positive </td></tr>
16391639
<tr class="markdownTableRowOdd">
16401640
<td class="markdownTableBodyNone"><span class="tt">relax_model</span> </td><td class="markdownTableBodyNone">Integer </td><td class="markdownTableBodyNone">Relaxation model type </td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">phase change requires <span class="tt">model_eqns</span>==2 with <span class="tt">relax_model</span> in [5,6] or <span class="tt">model_eqns</span>==3 with <span class="tt">relax_model</span> in [1,4,5,6] </td></tr>
16411641
<tr class="markdownTableRowEven">
@@ -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-20</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-21</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: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md481"></a>
487487
<p><b>Stage:</b> common, pre_process, simulation, post_process | <b>Severity:</b> error</p>
488488
<p><b>Enforced checks:</b></p>
489489
<ul>
490+
<li>phase change requires <span class="tt">num_fluids</span> &gt;= 2 (liquid = 1, vapor = 2)</li>
490491
<li>phase change requires <span class="tt">model_eqns</span>==2 with <span class="tt">relax_model</span> in [5,6] or <span class="tt">model_eqns</span>==3 with <span class="tt">relax_model</span> in [1,4,5,6]</li>
491492
<li><span class="tt">palpha_eps</span> must be positive</li>
492493
<li><span class="tt">palpha_eps</span> must be less than 1</li>
@@ -739,7 +740,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md504"></a>
739740
<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>
740741
<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>
741742
</ul>
742-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-20</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-21</div> </div></div><!-- contents -->
743744
</div><!-- PageDoc -->
744745
</div><!-- doc-content -->
745746
<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
@@ -345,6 +345,7 @@
345345
<a href="namespacem__bubbles.html#aec95ed87199e71943f283ecbf199ca4c"/>
346346
<a href="namespacem__bubbles.html#afbe3b969f2151f7b5b615f12ee93901e"/>
347347
<a href="namespacem__bubbles__ee.html"/>
348+
<a href="namespacem__bubbles__ee.html#a0a2216eea31da1917887f93bbdcdc5e3"/>
348349
<a href="namespacem__bubbles__ee.html#a523f8112128cbb1d0ec8b2bab674475e"/>
349350
<a href="namespacem__bubbles__ee.html#a74139ae2462f5d45e1834e11d66f5f28"/>
350351
<a href="namespacem__bubbles__ee.html#a75e41b12f290decf36c8317a5df45799"/>

simulation/m__bubbles__EE_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:a95ca95b3f22f62885bf1dd09eda53f3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the right-hand side for Euler-Euler bubble transport. <br /></td></tr>
179179
<tr class="memitem:ab15ff78772125079eec3132ae9a5bea1" id="r_ab15ff78772125079eec3132ae9a5bea1"><td class="memItemLeft">impure subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__bubbles__ee.html#ab15ff78772125079eec3132ae9a5bea1">m_bubbles_ee::s_compute_bubble_ee_source</a> (<a class="el" href="m__phase__change_8fpp_8f90.html#a6d2af1366163bbea81771912d405abfa">q_cons_vf</a>, q_prim_vf, rhs_vf, divu_in)</td></tr>
180180
<tr class="memdesc:ab15ff78772125079eec3132ae9a5bea1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the Euler-Euler bubble source terms. <br /></td></tr>
181+
<tr class="memitem:a0a2216eea31da1917887f93bbdcdc5e3" id="r_a0a2216eea31da1917887f93bbdcdc5e3"><td class="memItemLeft">impure subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__bubbles__ee.html#a0a2216eea31da1917887f93bbdcdc5e3">m_bubbles_ee::s_compute_ptilde</a> (<a class="el" href="m__phase__change_8fpp_8f90.html#a6d2af1366163bbea81771912d405abfa">q_cons_vf</a>, q_prim_vf)</td></tr>
182+
<tr class="memdesc:a0a2216eea31da1917887f93bbdcdc5e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Evaluate the Euler-Euler pressure correction at cell centers and store it in ptil. This mirrors the modified mixture pressure that the HLLC solver applies to the reconstructed face states in m_riemann_solver_hllc.fpp, following Ando (2010), Eq. (2.5). It is a diagnostic: ptil is read only by the probe output path and never feeds back into the solution. <br /></td></tr>
181183
</table><table class="memberdecls">
182184
<tr class="heading"><td colspan="2"><h2 id="header-var-members" class="groupheader"><a id="var-members" name="var-members"></a>
183185
Variables</h2></td></tr>

simulation/m__bubbles__EE_8fpp_8f90.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ var m__bubbles__EE_8fpp_8f90 =
33
[ "m_bubbles_ee::s_comp_alpha_from_n", "namespacem__bubbles__ee.html#a523f8112128cbb1d0ec8b2bab674475e", null ],
44
[ "m_bubbles_ee::s_compute_bubble_ee_source", "namespacem__bubbles__ee.html#ab15ff78772125079eec3132ae9a5bea1", null ],
55
[ "m_bubbles_ee::s_compute_bubbles_ee_rhs", "namespacem__bubbles__ee.html#a95ca95b3f22f62885bf1dd09eda53f3a", null ],
6+
[ "m_bubbles_ee::s_compute_ptilde", "namespacem__bubbles__ee.html#a0a2216eea31da1917887f93bbdcdc5e3", null ],
67
[ "m_bubbles_ee::s_initialize_bubbles_ee_module", "namespacem__bubbles__ee.html#acdf857ad6b9f389ee1bd4dd81bbc23a5", null ],
78
[ "m_bubbles_ee::bub_adv_src", "namespacem__bubbles__ee.html#a75e41b12f290decf36c8317a5df45799", null ],
89
[ "m_bubbles_ee::bub_m_src", "namespacem__bubbles__ee.html#ab3e7e32a515a15bd575b5d1a5583ab11", null ],

0 commit comments

Comments
 (0)