Skip to content

Commit da92bca

Browse files
author
MFC Action
committed
Docs @ aaecc47
1 parent b2397b4 commit da92bca

392 files changed

Lines changed: 51581 additions & 47191 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: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -277,30 +277,32 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md7"></a>
277277
<tr class="markdownTableRowOdd">
278278
<td class="markdownTableBodyNone"><span class="tt">m_surface_tension</span> </td><td class="markdownTableBodyNone">Computes capillary source fluxes and color-function gradients for the diffuse-interface surface tension model </td></tr>
279279
<tr class="markdownTableRowEven">
280-
<td class="markdownTableBodyNone"><span class="tt">m_bubbles</span> </td><td class="markdownTableBodyNone">Bubble-dynamics procedures for ensemble- and volume-averaged model </td></tr>
280+
<td class="markdownTableBodyNone"><span class="tt">m_reactive_burn</span> </td><td class="markdownTableBodyNone">Condensed-phase reactive burn: a pressure-driven programmed-burn source that converts a "reactant" fluid into a "product" fluid on the multi-fluid model (num_fluids=2, chemistry='F') </td></tr>
281281
<tr class="markdownTableRowOdd">
282-
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EE</span> </td><td class="markdownTableBodyNone">Computes ensemble-averaged (Euler&ndash;Euler) bubble source terms for radius, velocity, pressure, and mass transfer </td></tr>
282+
<td class="markdownTableBodyNone"><span class="tt">m_bubbles</span> </td><td class="markdownTableBodyNone">Bubble-dynamics procedures for ensemble- and volume-averaged model </td></tr>
283283
<tr class="markdownTableRowEven">
284-
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL</span> </td><td class="markdownTableBodyNone">Tracks Lagrangian bubbles and couples their dynamics to the Eulerian flow via volume averaging </td></tr>
284+
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EE</span> </td><td class="markdownTableBodyNone">Computes ensemble-averaged (Euler&ndash;Euler) bubble source terms for radius, velocity, pressure, and mass transfer </td></tr>
285285
<tr class="markdownTableRowOdd">
286-
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL_kernels</span> </td><td class="markdownTableBodyNone">Kernel functions (Gaussian, delta) that smear Lagrangian bubble effects onto the Eulerian grid </td></tr>
286+
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL</span> </td><td class="markdownTableBodyNone">Tracks Lagrangian bubbles and couples their dynamics to the Eulerian flow via volume averaging </td></tr>
287287
<tr class="markdownTableRowEven">
288-
<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>
288+
<td class="markdownTableBodyNone"><span class="tt">m_bubbles_EL_kernels</span> </td><td class="markdownTableBodyNone">Kernel functions (Gaussian, delta) that smear Lagrangian bubble effects onto the Eulerian grid </td></tr>
289289
<tr class="markdownTableRowOdd">
290-
<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>
290+
<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_hypoelastic</span> </td><td class="markdownTableBodyNone">Computes hypoelastic stress-rate source terms and damage-state evolution </td></tr>
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>
293293
<tr class="markdownTableRowOdd">
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>
294+
<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>
295295
<tr class="markdownTableRowEven">
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>
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>
297297
<tr class="markdownTableRowOdd">
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>
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>
299299
<tr class="markdownTableRowEven">
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>
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>
301301
<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>
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>
303303
<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>
305+
<tr class="markdownTableRowOdd">
304306
<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>
305307
</table>
306308
<h2 class="doxsection"><a class="anchor" id="autotoc_md8"></a>
@@ -427,7 +429,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
427429
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
428430
</ol>
429431
<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>
430-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-25</div> </div></div><!-- contents -->
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 -->
431433
</div><!-- PageDoc -->
432434
</div><!-- doc-content -->
433435
<div id="page-nav" class="page-nav-panel">

documentation/case.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1349,9 +1349,22 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md32"></a>
13491349
<td class="markdownTableBodyRight"><span class="tt">cont_damage_s</span> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Power <span class="tt">s</span> for continuum damage model </td></tr>
13501350
<tr class="markdownTableRowEven">
13511351
<td class="markdownTableBodyRight"><span class="tt">alpha_bar</span> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Damage factor (rate) for continuum damage model </td></tr>
1352+
<tr class="markdownTableRowOdd">
1353+
<td class="markdownTableBodyRight"><span class="tt">reactive_burn</span> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Enable condensed-phase reactive burn </td></tr>
1354+
<tr class="markdownTableRowEven">
1355+
<td class="markdownTableBodyRight"><span class="tt">rburn%k</span> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Reactive-burn rate coefficient [1/s] </td></tr>
1356+
<tr class="markdownTableRowOdd">
1357+
<td class="markdownTableBodyRight"><span class="tt">rburn%pign</span> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Reactive-burn ignition pressure threshold [Pa] </td></tr>
1358+
<tr class="markdownTableRowEven">
1359+
<td class="markdownTableBodyRight"><span class="tt">rburn%pref</span> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Reactive-burn reference pressure for the drive [Pa] </td></tr>
1360+
<tr class="markdownTableRowOdd">
1361+
<td class="markdownTableBodyRight"><span class="tt">rburn%n</span> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Reactive-burn pressure-drive exponent </td></tr>
1362+
<tr class="markdownTableRowEven">
1363+
<td class="markdownTableBodyRight"><span class="tt">rburn%ta</span> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Reactive-burn activation temperature [K] (0 = off) </td></tr>
13521364
</table>
13531365
<ul>
13541366
<li><span class="tt">cont_damage</span> activates continuum damage model for solid materials. Requires <span class="tt">tau_star</span>, <span class="tt">cont_damage_s</span>, and <span class="tt">alpha_bar</span> to be set (empirically determined) (Cao et al. <a class="el" href="citelist.html#CITEREF_cao19">[10]</a>).</li>
1367+
<li><span class="tt">reactive_burn</span> converts a "reactant" fluid into a "product" fluid (<span class="tt">num_fluids = 2</span>, <span class="tt">chemistry = 'F'</span>) via a programmed pressure burn <span class="tt">dlambda/dt = rburn%k (1 - lambda) ((p - rburn%pign)/rburn%pref)^rburn%n</span>. The two fluids share the same <span class="tt">gamma</span>/<span class="tt">pi_inf</span> and differ only in <span class="tt">qv</span>, so the conversion releases <span class="tt">qv</span> through the mixture EOS — a reactive-Euler/ZND detonation model on the diffuse-interface framework. It runs on the 5-equation (<span class="tt">model_eqns = 2</span>) and 6-equation (<span class="tt">model_eqns = 3</span>) multi-fluid models. Setting <span class="tt">rburn%ta &gt; 0</span> multiplies the rate by an Arrhenius factor <span class="tt">exp(-rburn%ta/T)</span>, where <span class="tt">T</span> is the reactant phasic temperature, giving temperature-driven ignition instead of a pure pressure switch.</li>
13551368
</ul>
13561369
<h3 class="doxsection"><a class="anchor" id="autotoc_md33"></a>
13571370
16. Cylindrical Coordinates</h3>

documentation/case_constraints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1462,7 +1462,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14621462
</table>
14631463
<hr />
14641464
<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-25</div> </div></div><!-- contents -->
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 -->
14661466
</div><!-- PageDoc -->
14671467
</div><!-- doc-content -->
14681468
<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
@@ -999,7 +999,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md82"></a>
999999
<h3 class="doxsection"><a class="anchor" id="autotoc_md83"></a>
10001000
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
10011001
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
1002-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-25</div> </div></div><!-- contents -->
1002+
<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 -->
10031003
</div><!-- PageDoc -->
10041004
</div><!-- doc-content -->
10051005
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)