Skip to content

Commit 333d914

Browse files
author
MFC Action
committed
Docs @ c9ce9bc
1 parent 6c745e6 commit 333d914

58 files changed

Lines changed: 823 additions & 823 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: 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-13</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-14</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
@@ -1516,7 +1516,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
15161516
</table>
15171517
<hr />
15181518
<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>
1519-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-13</div> </div></div><!-- contents -->
1519+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-14</div> </div></div><!-- contents -->
15201520
</div><!-- PageDoc -->
15211521
</div><!-- doc-content -->
15221522
<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-08-13</div> </div></div><!-- contents -->
1002+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-14</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: 303 additions & 303 deletions
Large diffs are not rendered by default.

‎documentation/navtreedata.js‎

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

0 commit comments

Comments
 (0)