Skip to content

Commit 303bdbd

Browse files
author
MFC Action
committed
Docs @ bfdc8f5
1 parent da92bca commit 303bdbd

484 files changed

Lines changed: 60280 additions & 64742 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: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -289,20 +289,18 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md7"></a>
289289
<tr class="markdownTableRowOdd">
290290
<td class="markdownTableBodyNone"><span class="tt">m_qbmm</span> </td><td class="markdownTableBodyNone">Quadrature-based moment methods (QBMM) for polydisperse bubble moment inversion and transport </td></tr>
291291
<tr class="markdownTableRowEven">
292-
<td class="markdownTableBodyNone"><span class="tt">m_hyperelastic</span> </td><td class="markdownTableBodyNone">Computes the left Cauchy&ndash;Green deformation tensor and hyperelastic stress source terms </td></tr>
293-
<tr class="markdownTableRowOdd">
294292
<td class="markdownTableBodyNone"><span class="tt">m_hypoelastic</span> </td><td class="markdownTableBodyNone">Computes hypoelastic stress-rate source terms and damage-state evolution </td></tr>
295-
<tr class="markdownTableRowEven">
296-
<td class="markdownTableBodyNone"><span class="tt">m_phase_change</span> </td><td class="markdownTableBodyNone">Phase transition relaxation solvers for liquid-vapor flows with cavitation and boiling </td></tr>
297293
<tr class="markdownTableRowOdd">
298-
<td class="markdownTableBodyNone"><span class="tt">m_chemistry</span> </td><td class="markdownTableBodyNone">Multi-species chemistry interface for thermodynamic properties, reaction rates, and transport coefficients </td></tr>
294+
<td class="markdownTableBodyNone"><span class="tt">m_phase_change</span> </td><td class="markdownTableBodyNone">Phase transition relaxation solvers for liquid-vapor flows with cavitation and boiling </td></tr>
299295
<tr class="markdownTableRowEven">
300-
<td class="markdownTableBodyNone"><span class="tt">m_acoustic_src</span> </td><td class="markdownTableBodyNone">One-way acoustic source injection, Maeda and Colonius JCP (2017) </td></tr>
296+
<td class="markdownTableBodyNone"><span class="tt">m_chemistry</span> </td><td class="markdownTableBodyNone">Multi-species chemistry interface for thermodynamic properties, reaction rates, and transport coefficients </td></tr>
301297
<tr class="markdownTableRowOdd">
302-
<td class="markdownTableBodyNone"><span class="tt">m_body_forces</span> </td><td class="markdownTableBodyNone">Computes gravitational and body force source terms for the momentum equations </td></tr>
298+
<td class="markdownTableBodyNone"><span class="tt">m_acoustic_src</span> </td><td class="markdownTableBodyNone">One-way acoustic source injection, Maeda and Colonius JCP (2017) </td></tr>
303299
<tr class="markdownTableRowEven">
304-
<td class="markdownTableBodyNone"><span class="tt">m_pressure_relaxation</span> </td><td class="markdownTableBodyNone">Pressure relaxation for the six-equation multi-component model via Newton&ndash;Raphson equilibration and volume-fraction correction </td></tr>
300+
<td class="markdownTableBodyNone"><span class="tt">m_body_forces</span> </td><td class="markdownTableBodyNone">Computes gravitational and body force source terms for the momentum equations </td></tr>
305301
<tr class="markdownTableRowOdd">
302+
<td class="markdownTableBodyNone"><span class="tt">m_pressure_relaxation</span> </td><td class="markdownTableBodyNone">Pressure relaxation for the six-equation multi-component model via Newton&ndash;Raphson equilibration and volume-fraction correction </td></tr>
303+
<tr class="markdownTableRowEven">
306304
<td class="markdownTableBodyNone"><span class="tt">m_collisions</span> </td><td class="markdownTableBodyNone">Ghost-node immersed boundary method: locates ghost/image points, computes interpolation coefficients, and corrects the flow state </td></tr>
307305
</table>
308306
<h2 class="doxsection"><a class="anchor" id="autotoc_md8"></a>
@@ -429,7 +427,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
429427
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
430428
</ol>
431429
<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-07-26</div> </div></div><!-- contents -->
430+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-27</div> </div></div><!-- contents -->
433431
</div><!-- PageDoc -->
434432
</div><!-- doc-content -->
435433
<div id="page-nav" class="page-nav-panel">

‎documentation/case.html‎

Lines changed: 38 additions & 42 deletions
Large diffs are not rendered by default.

‎documentation/case_constraints.html‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -461,12 +461,10 @@ <h3 class="doxsection"><a class="anchor" id="compat-physics-models"></a>
461461
<tr class="markdownTableRowOdd">
462462
<td class="markdownTableBodyNone">Hypoelasticity </td><td class="markdownTableBodyNone">— </td><td class="markdownTableBodyNone">✓ General use </td></tr>
463463
<tr class="markdownTableRowEven">
464-
<td class="markdownTableBodyNone">Hyperelasticity </td><td class="markdownTableBodyNone">— </td><td class="markdownTableBodyNone">✓ General use </td></tr>
465-
<tr class="markdownTableRowOdd">
466464
<td class="markdownTableBodyNone">Phase Change (Relaxation) </td><td class="markdownTableBodyNone">— </td><td class="markdownTableBodyNone">✓ General use </td></tr>
467-
<tr class="markdownTableRowEven">
468-
<td class="markdownTableBodyNone">Viscosity </td><td class="markdownTableBodyNone">— </td><td class="markdownTableBodyNone">✓ General use </td></tr>
469465
<tr class="markdownTableRowOdd">
466+
<td class="markdownTableBodyNone">Viscosity </td><td class="markdownTableBodyNone">— </td><td class="markdownTableBodyNone">✓ General use </td></tr>
467+
<tr class="markdownTableRowEven">
470468
<td class="markdownTableBodyNone">Acoustic Sources </td><td class="markdownTableBodyNone">— </td><td class="markdownTableBodyNone">✓ General use </td></tr>
471469
</table>
472470
<h3 class="doxsection"><a class="anchor" id="compat-bubble-models"></a>
@@ -1462,7 +1460,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14621460
</table>
14631461
<hr />
14641462
<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>
1465-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-26</div> </div></div><!-- contents -->
1463+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-27</div> </div></div><!-- contents -->
14661464
</div><!-- PageDoc -->
14671465
</div><!-- doc-content -->
14681466
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)