Skip to content

Commit 18eb786

Browse files
author
MFC Action
committed
Docs @ ab93016
1 parent 45ec70a commit 18eb786

66 files changed

Lines changed: 867 additions & 867 deletions

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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md6"></a>
241241
<tr class="markdownTableHead">
242242
<th class="markdownTableHeadNone">Module </th><th class="markdownTableHeadNone">Role </th></tr>
243243
<tr class="markdownTableRowOdd">
244-
<td class="markdownTableBodyNone"><span class="tt">m_rhs</span> </td><td class="markdownTableBodyNone">Assembles the right-hand side of the governing equations using finite-volume flux differencing, Riemann solvers, and physical source terms </td></tr>
244+
<td class="markdownTableBodyNone"><span class="tt">m_rhs</span> </td><td class="markdownTableBodyNone">Assemble the right-hand side of the governing equations using finite-volume flux differencing, Riemann solvers, and physical source terms </td></tr>
245245
<tr class="markdownTableRowEven">
246246
<td class="markdownTableBodyNone"><span class="tt">m_time_steppers</span> </td><td class="markdownTableBodyNone">Total-variation-diminishing (TVD) Runge&ndash;Kutta time integrators (1st-, 2nd-, and 3rd-order SSP) </td></tr>
247247
<tr class="markdownTableRowOdd">
@@ -427,7 +427,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
427427
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
428428
</ol>
429429
<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-23</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-24</div> </div></div><!-- contents -->
431431
</div><!-- PageDoc -->
432432
</div><!-- doc-content -->
433433
<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
@@ -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-23</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-24</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-23</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-24</div> </div></div><!-- contents -->
10031003
</div><!-- PageDoc -->
10041004
</div><!-- doc-content -->
10051005
<div id="page-nav" class="page-nav-panel">

‎documentation/examples.html‎

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

‎documentation/navtreedata.js‎

Lines changed: 101 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -333,125 +333,125 @@ var NAVTREE =
333333
] ],
334334
[ "Example Cases", "examples.html", [
335335
[ "Example Cases", "examples.html#autotoc_md216", [
336-
[ "Kelvin-Helmholtz Instability (2D)", "examples.html#autotoc_md217", null ],
337-
[ "IBM Bow Shock (3D)", "examples.html#autotoc_md220", [
338-
[ "Final Condition", "examples.html#autotoc_md221", null ]
339-
] ],
340-
[ "2D Power-Law (Shear-Thickening) Poiseuille Channel", "examples.html#autotoc_md222", [
341-
[ "Regime and parameters", "examples.html#autotoc_md223", null ],
342-
[ "Governing physics and analytic solution", "examples.html#autotoc_md224", null ],
343-
[ "How to run", "examples.html#autotoc_md225", null ],
344-
[ "Validation result", "examples.html#autotoc_md226", null ],
345-
[ "References", "examples.html#autotoc_md227", null ]
346-
] ],
347-
[ "2D General Herschel-Bulkley Poiseuille Channel", "examples.html#autotoc_md228", [
336+
[ "2D IBM-Walled Power-Law Poiseuille Channel", "examples.html#autotoc_md217", [
337+
[ "Geometry and parameters", "examples.html#autotoc_md218", null ],
338+
[ "Analytic solution", "examples.html#autotoc_md219", null ],
339+
[ "How to run", "examples.html#autotoc_md220", null ],
340+
[ "Validation results", "examples.html#autotoc_md221", null ],
341+
[ "References", "examples.html#autotoc_md222", null ]
342+
] ],
343+
[ "Rayleigh-Taylor Instability (3D)", "examples.html#autotoc_md223", [
344+
[ "Final Condition and Linear Theory", "examples.html#autotoc_md224", null ]
345+
] ],
346+
[ "Titarev-Toro problem (1D)", "examples.html#autotoc_md225", [
347+
[ "Initial Condition", "examples.html#autotoc_md226", null ],
348+
[ "Result", "examples.html#autotoc_md227", null ]
349+
] ],
350+
[ "2D Power-Law (Shear-Thinning) Poiseuille Channel", "examples.html#autotoc_md228", [
348351
[ "Regime and parameters", "examples.html#autotoc_md229", null ],
349352
[ "Governing physics and analytic solution", "examples.html#autotoc_md230", null ],
350353
[ "How to run", "examples.html#autotoc_md231", null ],
351354
[ "Validation result", "examples.html#autotoc_md232", null ],
352355
[ "References", "examples.html#autotoc_md233", null ]
353356
] ],
354-
[ "Richtmyer-Meshkov Instability (2D)", "examples.html#autotoc_md234", null ],
355-
[ "2D IBM-Walled Power-Law Poiseuille Channel", "examples.html#autotoc_md237", [
356-
[ "Geometry and parameters", "examples.html#autotoc_md238", null ],
357-
[ "Analytic solution", "examples.html#autotoc_md239", null ],
358-
[ "How to run", "examples.html#autotoc_md240", null ],
359-
[ "Validation results", "examples.html#autotoc_md241", null ],
360-
[ "References", "examples.html#autotoc_md242", null ]
357+
[ "Viscous Shock Tube (2D)", "examples.html#autotoc_md234", null ],
358+
[ "IBM Bow Shock (3D)", "examples.html#autotoc_md237", [
359+
[ "Final Condition", "examples.html#autotoc_md238", null ]
361360
] ],
362-
[ "Shock Droplet (2D)", "examples.html#autotoc_md243", [
363-
[ "Initial Condition", "examples.html#autotoc_md244", null ],
364-
[ "Result", "examples.html#autotoc_md245", null ]
361+
[ "Richtmyer-Meshkov Instability (2D)", "examples.html#autotoc_md239", null ],
362+
[ "Perfectly Stirred Reactor", "examples.html#autotoc_md242", [
363+
[ "Validation", "examples.html#autotoc_md243", null ]
365364
] ],
366-
[ "2D Hardcodied IC Example", "examples.html#autotoc_md246", [
367-
[ "Initial Condition and Result", "examples.html#autotoc_md247", null ]
365+
[ "Scaling and Performance test", "examples.html#autotoc_md244", [
366+
[ "Weak Scaling", "examples.html#autotoc_md245", null ],
367+
[ "Strong Scaling", "examples.html#autotoc_md246", null ],
368+
[ "Example", "examples.html#autotoc_md247", null ]
368369
] ],
369-
[ "2D Bingham (Yield-Stress) Poiseuille Channel", "examples.html#autotoc_md248", [
370-
[ "Regime and parameters", "examples.html#autotoc_md249", null ],
371-
[ "Governing physics and analytic solution", "examples.html#autotoc_md250", null ],
372-
[ "How to run", "examples.html#autotoc_md251", null ],
373-
[ "Validation result", "examples.html#autotoc_md252", null ],
374-
[ "References", "examples.html#autotoc_md253", null ]
370+
[ "1D Multi-Component Inert Shock Tube", "examples.html#autotoc_md248", [
371+
[ "Initial Condition", "examples.html#autotoc_md249", null ],
372+
[ "Results", "examples.html#autotoc_md250", null ]
375373
] ],
376-
[ "Titarev-Toro problem (1D)", "examples.html#autotoc_md254", [
377-
[ "Initial Condition", "examples.html#autotoc_md255", null ],
378-
[ "Result", "examples.html#autotoc_md256", null ]
374+
[ "Forward Facing Step (2D)", "examples.html#autotoc_md251", [
375+
[ "Final Condition (Density)", "examples.html#autotoc_md252", null ]
379376
] ],
380-
[ "2D Triple Point (2D)", "examples.html#autotoc_md257", [
381-
[ "Numerical Schlieren at Final Time", "examples.html#autotoc_md258", null ]
377+
[ "Lid-Driven Cavity Problem (2D)", "examples.html#autotoc_md253", [
378+
[ "Final Condition", "examples.html#autotoc_md254", null ],
379+
[ "Centerline Velocities", "examples.html#autotoc_md255", null ]
382380
] ],
383-
[ "Gas Jet (2D)", "examples.html#autotoc_md259", [
384-
[ "Final Condition", "examples.html#autotoc_md260", null ]
381+
[ "Gas Jet (2D)", "examples.html#autotoc_md256", [
382+
[ "Final Condition", "examples.html#autotoc_md257", null ]
385383
] ],
386-
[ "Rayleigh-Taylor Instability (2D)", "examples.html#autotoc_md261", [
387-
[ "Final Condition and Linear Theory", "examples.html#autotoc_md262", null ]
384+
[ "2D Hardcodied IC Example", "examples.html#autotoc_md258", [
385+
[ "Initial Condition and Result", "examples.html#autotoc_md259", null ]
386+
] ],
387+
[ "Lax shock tube problem (1D)", "examples.html#autotoc_md260", [
388+
[ "Initial Condition", "examples.html#autotoc_md261", null ],
389+
[ "Result", "examples.html#autotoc_md262", null ]
388390
] ],
389391
[ "Isentropic vortex problem (2D)", "examples.html#autotoc_md263", [
390392
[ "Density", "examples.html#autotoc_md264", null ],
391393
[ "Density Norms", "examples.html#autotoc_md265", null ]
392394
] ],
393-
[ "Taylor-Green Vortex (3D)", "examples.html#autotoc_md266", [
394-
[ "Final Condition", "examples.html#autotoc_md267", null ]
395-
] ],
396-
[ "Shu-Osher problem (1D)", "examples.html#autotoc_md268", [
397-
[ "Initial Condition", "examples.html#autotoc_md269", null ],
398-
[ "Result", "examples.html#autotoc_md270", null ]
399-
] ],
400-
[ "2D Power-Law (Shear-Thinning) Poiseuille Channel", "examples.html#autotoc_md271", [
401-
[ "Regime and parameters", "examples.html#autotoc_md272", null ],
402-
[ "Governing physics and analytic solution", "examples.html#autotoc_md273", null ],
403-
[ "How to run", "examples.html#autotoc_md274", null ],
404-
[ "Validation result", "examples.html#autotoc_md275", null ],
405-
[ "References", "examples.html#autotoc_md276", null ]
406-
] ],
407-
[ "2D Shear-Thinning Lid-Driven Cavity", "examples.html#autotoc_md277", [
408-
[ "Regime and parameters", "examples.html#autotoc_md278", null ],
409-
[ "Governing physics", "examples.html#autotoc_md279", null ],
410-
[ "How to run", "examples.html#autotoc_md280", null ],
411-
[ "References", "examples.html#autotoc_md281", null ]
412-
] ],
413-
[ "Rayleigh-Taylor Instability (3D)", "examples.html#autotoc_md282", [
414-
[ "Final Condition and Linear Theory", "examples.html#autotoc_md283", null ]
415-
] ],
416-
[ "1D Multi-Component Reactive Shock Tube", "examples.html#autotoc_md284", [
417-
[ "Initial Condition", "examples.html#autotoc_md285", null ],
418-
[ "Results", "examples.html#autotoc_md286", null ]
419-
] ],
420-
[ "Backward Facing Step (2D)", "examples.html#autotoc_md287", [
421-
[ "Final Condition (Density)", "examples.html#autotoc_md288", null ]
422-
] ],
423-
[ "Lax shock tube problem (1D)", "examples.html#autotoc_md289", [
424-
[ "Initial Condition", "examples.html#autotoc_md290", null ],
425-
[ "Result", "examples.html#autotoc_md291", null ]
426-
] ],
427-
[ "Viscous Shock Tube (2D)", "examples.html#autotoc_md292", null ],
428-
[ "Forward Facing Step (2D)", "examples.html#autotoc_md295", [
429-
[ "Final Condition (Density)", "examples.html#autotoc_md296", null ]
430-
] ],
431-
[ "2D Riemann Test (2D)", "examples.html#autotoc_md297", [
432-
[ "Density Initial and Final Conditions", "examples.html#autotoc_md298", null ]
433-
] ],
434-
[ "Scaling and Performance test", "examples.html#autotoc_md299", [
435-
[ "Weak Scaling", "examples.html#autotoc_md300", null ],
436-
[ "Strong Scaling", "examples.html#autotoc_md301", null ],
437-
[ "Example", "examples.html#autotoc_md302", null ]
438-
] ],
439-
[ "1D Multi-Component Inert Shock Tube", "examples.html#autotoc_md303", [
440-
[ "Initial Condition", "examples.html#autotoc_md304", null ],
441-
[ "Results", "examples.html#autotoc_md305", null ]
442-
] ],
443-
[ "2D IBM CFL dt (2D)", "examples.html#autotoc_md306", [
444-
[ "Result", "examples.html#autotoc_md307", null ]
445-
] ],
446-
[ "Perfectly Stirred Reactor", "examples.html#autotoc_md308", [
447-
[ "Validation", "examples.html#autotoc_md309", null ]
448-
] ],
449-
[ "Lid-Driven Cavity Problem (2D)", "examples.html#autotoc_md310", [
450-
[ "Final Condition", "examples.html#autotoc_md311", null ],
451-
[ "Centerline Velocities", "examples.html#autotoc_md312", null ]
452-
] ],
453-
[ "3D Turbulent Mixing layer (3D)", "examples.html#autotoc_md313", [
454-
[ "Liutex visualization at transitional state", "examples.html#autotoc_md314", null ]
395+
[ "Backward Facing Step (2D)", "examples.html#autotoc_md266", [
396+
[ "Final Condition (Density)", "examples.html#autotoc_md267", null ]
397+
] ],
398+
[ "2D Shear-Thinning Lid-Driven Cavity", "examples.html#autotoc_md268", [
399+
[ "Regime and parameters", "examples.html#autotoc_md269", null ],
400+
[ "Governing physics", "examples.html#autotoc_md270", null ],
401+
[ "How to run", "examples.html#autotoc_md271", null ],
402+
[ "References", "examples.html#autotoc_md272", null ]
403+
] ],
404+
[ "2D General Herschel-Bulkley Poiseuille Channel", "examples.html#autotoc_md273", [
405+
[ "Regime and parameters", "examples.html#autotoc_md274", null ],
406+
[ "Governing physics and analytic solution", "examples.html#autotoc_md275", null ],
407+
[ "How to run", "examples.html#autotoc_md276", null ],
408+
[ "Validation result", "examples.html#autotoc_md277", null ],
409+
[ "References", "examples.html#autotoc_md278", null ]
410+
] ],
411+
[ "2D Riemann Test (2D)", "examples.html#autotoc_md279", [
412+
[ "Density Initial and Final Conditions", "examples.html#autotoc_md280", null ]
413+
] ],
414+
[ "Kelvin-Helmholtz Instability (2D)", "examples.html#autotoc_md281", null ],
415+
[ "Taylor-Green Vortex (3D)", "examples.html#autotoc_md284", [
416+
[ "Final Condition", "examples.html#autotoc_md285", null ]
417+
] ],
418+
[ "2D Triple Point (2D)", "examples.html#autotoc_md286", [
419+
[ "Numerical Schlieren at Final Time", "examples.html#autotoc_md287", null ]
420+
] ],
421+
[ "2D IBM CFL dt (2D)", "examples.html#autotoc_md288", [
422+
[ "Result", "examples.html#autotoc_md289", null ]
423+
] ],
424+
[ "1D Multi-Component Reactive Shock Tube", "examples.html#autotoc_md290", [
425+
[ "Initial Condition", "examples.html#autotoc_md291", null ],
426+
[ "Results", "examples.html#autotoc_md292", null ]
427+
] ],
428+
[ "Rayleigh-Taylor Instability (2D)", "examples.html#autotoc_md293", [
429+
[ "Final Condition and Linear Theory", "examples.html#autotoc_md294", null ]
430+
] ],
431+
[ "Shock Droplet (2D)", "examples.html#autotoc_md295", [
432+
[ "Initial Condition", "examples.html#autotoc_md296", null ],
433+
[ "Result", "examples.html#autotoc_md297", null ]
434+
] ],
435+
[ "3D Turbulent Mixing layer (3D)", "examples.html#autotoc_md298", [
436+
[ "Liutex visualization at transitional state", "examples.html#autotoc_md299", null ]
437+
] ],
438+
[ "2D Bingham (Yield-Stress) Poiseuille Channel", "examples.html#autotoc_md300", [
439+
[ "Regime and parameters", "examples.html#autotoc_md301", null ],
440+
[ "Governing physics and analytic solution", "examples.html#autotoc_md302", null ],
441+
[ "How to run", "examples.html#autotoc_md303", null ],
442+
[ "Validation result", "examples.html#autotoc_md304", null ],
443+
[ "References", "examples.html#autotoc_md305", null ]
444+
] ],
445+
[ "Shu-Osher problem (1D)", "examples.html#autotoc_md306", [
446+
[ "Initial Condition", "examples.html#autotoc_md307", null ],
447+
[ "Result", "examples.html#autotoc_md308", null ]
448+
] ],
449+
[ "2D Power-Law (Shear-Thickening) Poiseuille Channel", "examples.html#autotoc_md309", [
450+
[ "Regime and parameters", "examples.html#autotoc_md310", null ],
451+
[ "Governing physics and analytic solution", "examples.html#autotoc_md311", null ],
452+
[ "How to run", "examples.html#autotoc_md312", null ],
453+
[ "Validation result", "examples.html#autotoc_md313", null ],
454+
[ "References", "examples.html#autotoc_md314", null ]
455455
] ]
456456
] ]
457457
] ],

0 commit comments

Comments
 (0)