Skip to content

Commit 1fe0050

Browse files
author
MFC Action
committed
Docs @ 10a2f60
1 parent 595f2fc commit 1fe0050

68 files changed

Lines changed: 2216 additions & 2211 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
@@ -403,7 +403,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
403403
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
404404
</ol>
405405
<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>
406-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-23</div> </div></div><!-- contents -->
406+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-24</div> </div></div><!-- contents -->
407407
</div><!-- PageDoc -->
408408
</div><!-- doc-content -->
409409
<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
@@ -1434,7 +1434,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14341434
</table>
14351435
<hr />
14361436
<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>
1437-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-23</div> </div></div><!-- contents -->
1437+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-24</div> </div></div><!-- contents -->
14381438
</div><!-- PageDoc -->
14391439
</div><!-- doc-content -->
14401440
<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
@@ -984,7 +984,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
984984
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
985985
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
986986
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
987-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-23</div> </div></div><!-- contents -->
987+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-24</div> </div></div><!-- contents -->
988988
</div><!-- PageDoc -->
989989
</div><!-- doc-content -->
990990
<div id="page-nav" class="page-nav-panel">

‎documentation/examples.html‎

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

‎documentation/navtreedata.js‎

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -329,84 +329,84 @@ var NAVTREE =
329329
] ],
330330
[ "Example Cases", "examples.html", [
331331
[ "Example Cases", "examples.html#autotoc_md213", [
332-
[ "Richtmyer-Meshkov Instability (2D)", "examples.html#autotoc_md214", null ],
333-
[ "Backward Facing Step (2D)", "examples.html#autotoc_md217", [
334-
[ "Final Condition (Density)", "examples.html#autotoc_md218", null ]
332+
[ "Titarev-Toro problem (1D)", "examples.html#autotoc_md214", [
333+
[ "Initial Condition", "examples.html#autotoc_md215", null ],
334+
[ "Result", "examples.html#autotoc_md216", null ]
335335
] ],
336-
[ "Shock Droplet (2D)", "examples.html#autotoc_md219", [
337-
[ "Initial Condition", "examples.html#autotoc_md220", null ],
338-
[ "Result", "examples.html#autotoc_md221", null ]
336+
[ "Lid-Driven Cavity Problem (2D)", "examples.html#autotoc_md217", [
337+
[ "Final Condition", "examples.html#autotoc_md218", null ],
338+
[ "Centerline Velocities", "examples.html#autotoc_md219", null ]
339339
] ],
340-
[ "Rayleigh-Taylor Instability (3D)", "examples.html#autotoc_md222", [
341-
[ "Final Condition and Linear Theory", "examples.html#autotoc_md223", null ]
340+
[ "2D Riemann Test (2D)", "examples.html#autotoc_md220", [
341+
[ "Density Initial and Final Conditions", "examples.html#autotoc_md221", null ]
342342
] ],
343-
[ "Perfectly Stirred Reactor", "examples.html#autotoc_md224", [
344-
[ "Validation", "examples.html#autotoc_md225", null ]
343+
[ "Isentropic vortex problem (2D)", "examples.html#autotoc_md222", [
344+
[ "Density", "examples.html#autotoc_md223", null ],
345+
[ "Density Norms", "examples.html#autotoc_md224", null ]
345346
] ],
346-
[ "2D IBM CFL dt (2D)", "examples.html#autotoc_md226", [
347-
[ "Result", "examples.html#autotoc_md227", null ]
347+
[ "1D Multi-Component Inert Shock Tube", "examples.html#autotoc_md225", [
348+
[ "Initial Condition", "examples.html#autotoc_md226", null ],
349+
[ "Results", "examples.html#autotoc_md227", null ]
348350
] ],
349-
[ "IBM Bow Shock (3D)", "examples.html#autotoc_md228", [
350-
[ "Final Condition", "examples.html#autotoc_md229", null ]
351+
[ "Richtmyer-Meshkov Instability (2D)", "examples.html#autotoc_md228", null ],
352+
[ "Shock Droplet (2D)", "examples.html#autotoc_md231", [
353+
[ "Initial Condition", "examples.html#autotoc_md232", null ],
354+
[ "Result", "examples.html#autotoc_md233", null ]
351355
] ],
352-
[ "Kelvin-Helmholtz Instability (2D)", "examples.html#autotoc_md230", null ],
353-
[ "1D Multi-Component Inert Shock Tube", "examples.html#autotoc_md233", [
354-
[ "Initial Condition", "examples.html#autotoc_md234", null ],
355-
[ "Results", "examples.html#autotoc_md235", null ]
356+
[ "Gas Jet (2D)", "examples.html#autotoc_md234", [
357+
[ "Final Condition", "examples.html#autotoc_md235", null ]
356358
] ],
357-
[ "2D Riemann Test (2D)", "examples.html#autotoc_md236", [
358-
[ "Density Initial and Final Conditions", "examples.html#autotoc_md237", null ]
359+
[ "Scaling and Performance test", "examples.html#autotoc_md236", [
360+
[ "Weak Scaling", "examples.html#autotoc_md237", null ],
361+
[ "Strong Scaling", "examples.html#autotoc_md238", null ],
362+
[ "Example", "examples.html#autotoc_md239", null ]
359363
] ],
360-
[ "Rayleigh-Taylor Instability (2D)", "examples.html#autotoc_md238", [
361-
[ "Final Condition and Linear Theory", "examples.html#autotoc_md239", null ]
364+
[ "IBM Bow Shock (3D)", "examples.html#autotoc_md240", [
365+
[ "Final Condition", "examples.html#autotoc_md241", null ]
362366
] ],
363-
[ "Shu-Osher problem (1D)", "examples.html#autotoc_md240", [
364-
[ "Initial Condition", "examples.html#autotoc_md241", null ],
365-
[ "Result", "examples.html#autotoc_md242", null ]
367+
[ "Kelvin-Helmholtz Instability (2D)", "examples.html#autotoc_md242", null ],
368+
[ "Lax shock tube problem (1D)", "examples.html#autotoc_md245", [
369+
[ "Initial Condition", "examples.html#autotoc_md246", null ],
370+
[ "Result", "examples.html#autotoc_md247", null ]
366371
] ],
367-
[ "Lid-Driven Cavity Problem (2D)", "examples.html#autotoc_md243", [
368-
[ "Final Condition", "examples.html#autotoc_md244", null ],
369-
[ "Centerline Velocities", "examples.html#autotoc_md245", null ]
372+
[ "2D IBM CFL dt (2D)", "examples.html#autotoc_md248", [
373+
[ "Result", "examples.html#autotoc_md249", null ]
370374
] ],
371-
[ "Isentropic vortex problem (2D)", "examples.html#autotoc_md246", [
372-
[ "Density", "examples.html#autotoc_md247", null ],
373-
[ "Density Norms", "examples.html#autotoc_md248", null ]
375+
[ "Viscous Shock Tube (2D)", "examples.html#autotoc_md250", null ],
376+
[ "Perfectly Stirred Reactor", "examples.html#autotoc_md253", [
377+
[ "Validation", "examples.html#autotoc_md254", null ]
374378
] ],
375-
[ "2D Hardcodied IC Example", "examples.html#autotoc_md249", [
376-
[ "Initial Condition and Result", "examples.html#autotoc_md250", null ]
379+
[ "Forward Facing Step (2D)", "examples.html#autotoc_md255", [
380+
[ "Final Condition (Density)", "examples.html#autotoc_md256", null ]
377381
] ],
378-
[ "3D Turbulent Mixing layer (3D)", "examples.html#autotoc_md251", [
379-
[ "Liutex visualization at transitional state", "examples.html#autotoc_md252", null ]
382+
[ "Backward Facing Step (2D)", "examples.html#autotoc_md257", [
383+
[ "Final Condition (Density)", "examples.html#autotoc_md258", null ]
380384
] ],
381-
[ "Forward Facing Step (2D)", "examples.html#autotoc_md253", [
382-
[ "Final Condition (Density)", "examples.html#autotoc_md254", null ]
385+
[ "2D Hardcodied IC Example", "examples.html#autotoc_md259", [
386+
[ "Initial Condition and Result", "examples.html#autotoc_md260", null ]
383387
] ],
384-
[ "Titarev-Toro problem (1D)", "examples.html#autotoc_md255", [
385-
[ "Initial Condition", "examples.html#autotoc_md256", null ],
386-
[ "Result", "examples.html#autotoc_md257", null ]
388+
[ "Rayleigh-Taylor Instability (2D)", "examples.html#autotoc_md261", [
389+
[ "Final Condition and Linear Theory", "examples.html#autotoc_md262", null ]
387390
] ],
388-
[ "Lax shock tube problem (1D)", "examples.html#autotoc_md258", [
389-
[ "Initial Condition", "examples.html#autotoc_md259", null ],
390-
[ "Result", "examples.html#autotoc_md260", null ]
391-
] ],
392-
[ "Gas Jet (2D)", "examples.html#autotoc_md261", [
393-
[ "Final Condition", "examples.html#autotoc_md262", null ]
394-
] ],
395-
[ "Taylor-Green Vortex (3D)", "examples.html#autotoc_md263", [
396-
[ "Final Condition", "examples.html#autotoc_md264", null ]
391+
[ "3D Turbulent Mixing layer (3D)", "examples.html#autotoc_md263", [
392+
[ "Liutex visualization at transitional state", "examples.html#autotoc_md264", null ]
397393
] ],
398394
[ "1D Multi-Component Reactive Shock Tube", "examples.html#autotoc_md265", [
399395
[ "Initial Condition", "examples.html#autotoc_md266", null ],
400396
[ "Results", "examples.html#autotoc_md267", null ]
401397
] ],
402-
[ "2D Triple Point (2D)", "examples.html#autotoc_md268", [
403-
[ "Numerical Schlieren at Final Time", "examples.html#autotoc_md269", null ]
398+
[ "Shu-Osher problem (1D)", "examples.html#autotoc_md268", [
399+
[ "Initial Condition", "examples.html#autotoc_md269", null ],
400+
[ "Result", "examples.html#autotoc_md270", null ]
401+
] ],
402+
[ "2D Triple Point (2D)", "examples.html#autotoc_md271", [
403+
[ "Numerical Schlieren at Final Time", "examples.html#autotoc_md272", null ]
404+
] ],
405+
[ "Rayleigh-Taylor Instability (3D)", "examples.html#autotoc_md273", [
406+
[ "Final Condition and Linear Theory", "examples.html#autotoc_md274", null ]
404407
] ],
405-
[ "Viscous Shock Tube (2D)", "examples.html#autotoc_md270", null ],
406-
[ "Scaling and Performance test", "examples.html#autotoc_md273", [
407-
[ "Weak Scaling", "examples.html#autotoc_md274", null ],
408-
[ "Strong Scaling", "examples.html#autotoc_md275", null ],
409-
[ "Example", "examples.html#autotoc_md276", null ]
408+
[ "Taylor-Green Vortex (3D)", "examples.html#autotoc_md275", [
409+
[ "Final Condition", "examples.html#autotoc_md276", null ]
410410
] ]
411411
] ]
412412
] ],
@@ -738,7 +738,7 @@ var NAVTREE =
738738
var NAVTREEINDEX =
739739
[
740740
"architecture.html",
741-
"examples.html#autotoc_md219",
741+
"examples.html#autotoc_md217",
742742
"troubleshooting.html#autotoc_md498"
743743
];
744744

‎documentation/navtreeindex0.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,6 @@ var NAVTREEINDEX0 =
248248
"examples.html":[9],
249249
"examples.html#autotoc_md213":[9,0],
250250
"examples.html#autotoc_md214":[9,0,0],
251-
"examples.html#autotoc_md217":[9,0,1],
252-
"examples.html#autotoc_md218":[9,0,1,0]
251+
"examples.html#autotoc_md215":[9,0,0,0],
252+
"examples.html#autotoc_md216":[9,0,0,1]
253253
};

‎documentation/navtreeindex1.js‎

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,59 @@
11
var NAVTREEINDEX1 =
22
{
3-
"examples.html#autotoc_md219":[9,0,2],
4-
"examples.html#autotoc_md220":[9,0,2,0],
5-
"examples.html#autotoc_md221":[9,0,2,1],
3+
"examples.html#autotoc_md217":[9,0,1],
4+
"examples.html#autotoc_md218":[9,0,1,0],
5+
"examples.html#autotoc_md219":[9,0,1,1],
6+
"examples.html#autotoc_md220":[9,0,2],
7+
"examples.html#autotoc_md221":[9,0,2,0],
68
"examples.html#autotoc_md222":[9,0,3],
79
"examples.html#autotoc_md223":[9,0,3,0],
8-
"examples.html#autotoc_md224":[9,0,4],
9-
"examples.html#autotoc_md225":[9,0,4,0],
10-
"examples.html#autotoc_md226":[9,0,5],
11-
"examples.html#autotoc_md227":[9,0,5,0],
12-
"examples.html#autotoc_md228":[9,0,6],
13-
"examples.html#autotoc_md229":[9,0,6,0],
14-
"examples.html#autotoc_md230":[9,0,7],
15-
"examples.html#autotoc_md233":[9,0,8],
16-
"examples.html#autotoc_md234":[9,0,8,0],
17-
"examples.html#autotoc_md235":[9,0,8,1],
18-
"examples.html#autotoc_md236":[9,0,9],
19-
"examples.html#autotoc_md237":[9,0,9,0],
20-
"examples.html#autotoc_md238":[9,0,10],
21-
"examples.html#autotoc_md239":[9,0,10,0],
22-
"examples.html#autotoc_md240":[9,0,11],
23-
"examples.html#autotoc_md241":[9,0,11,0],
24-
"examples.html#autotoc_md242":[9,0,11,1],
25-
"examples.html#autotoc_md243":[9,0,12],
26-
"examples.html#autotoc_md244":[9,0,12,0],
27-
"examples.html#autotoc_md245":[9,0,12,1],
28-
"examples.html#autotoc_md246":[9,0,13],
29-
"examples.html#autotoc_md247":[9,0,13,0],
30-
"examples.html#autotoc_md248":[9,0,13,1],
31-
"examples.html#autotoc_md249":[9,0,14],
32-
"examples.html#autotoc_md250":[9,0,14,0],
33-
"examples.html#autotoc_md251":[9,0,15],
34-
"examples.html#autotoc_md252":[9,0,15,0],
35-
"examples.html#autotoc_md253":[9,0,16],
36-
"examples.html#autotoc_md254":[9,0,16,0],
37-
"examples.html#autotoc_md255":[9,0,17],
38-
"examples.html#autotoc_md256":[9,0,17,0],
39-
"examples.html#autotoc_md257":[9,0,17,1],
40-
"examples.html#autotoc_md258":[9,0,18],
41-
"examples.html#autotoc_md259":[9,0,18,0],
42-
"examples.html#autotoc_md260":[9,0,18,1],
43-
"examples.html#autotoc_md261":[9,0,19],
44-
"examples.html#autotoc_md262":[9,0,19,0],
45-
"examples.html#autotoc_md263":[9,0,20],
46-
"examples.html#autotoc_md264":[9,0,20,0],
47-
"examples.html#autotoc_md265":[9,0,21],
48-
"examples.html#autotoc_md266":[9,0,21,0],
49-
"examples.html#autotoc_md267":[9,0,21,1],
50-
"examples.html#autotoc_md268":[9,0,22],
51-
"examples.html#autotoc_md269":[9,0,22,0],
52-
"examples.html#autotoc_md270":[9,0,23],
53-
"examples.html#autotoc_md273":[9,0,24],
54-
"examples.html#autotoc_md274":[9,0,24,0],
55-
"examples.html#autotoc_md275":[9,0,24,1],
56-
"examples.html#autotoc_md276":[9,0,24,2],
10+
"examples.html#autotoc_md224":[9,0,3,1],
11+
"examples.html#autotoc_md225":[9,0,4],
12+
"examples.html#autotoc_md226":[9,0,4,0],
13+
"examples.html#autotoc_md227":[9,0,4,1],
14+
"examples.html#autotoc_md228":[9,0,5],
15+
"examples.html#autotoc_md231":[9,0,6],
16+
"examples.html#autotoc_md232":[9,0,6,0],
17+
"examples.html#autotoc_md233":[9,0,6,1],
18+
"examples.html#autotoc_md234":[9,0,7],
19+
"examples.html#autotoc_md235":[9,0,7,0],
20+
"examples.html#autotoc_md236":[9,0,8],
21+
"examples.html#autotoc_md237":[9,0,8,0],
22+
"examples.html#autotoc_md238":[9,0,8,1],
23+
"examples.html#autotoc_md239":[9,0,8,2],
24+
"examples.html#autotoc_md240":[9,0,9],
25+
"examples.html#autotoc_md241":[9,0,9,0],
26+
"examples.html#autotoc_md242":[9,0,10],
27+
"examples.html#autotoc_md245":[9,0,11],
28+
"examples.html#autotoc_md246":[9,0,11,0],
29+
"examples.html#autotoc_md247":[9,0,11,1],
30+
"examples.html#autotoc_md248":[9,0,12],
31+
"examples.html#autotoc_md249":[9,0,12,0],
32+
"examples.html#autotoc_md250":[9,0,13],
33+
"examples.html#autotoc_md253":[9,0,14],
34+
"examples.html#autotoc_md254":[9,0,14,0],
35+
"examples.html#autotoc_md255":[9,0,15],
36+
"examples.html#autotoc_md256":[9,0,15,0],
37+
"examples.html#autotoc_md257":[9,0,16],
38+
"examples.html#autotoc_md258":[9,0,16,0],
39+
"examples.html#autotoc_md259":[9,0,17],
40+
"examples.html#autotoc_md260":[9,0,17,0],
41+
"examples.html#autotoc_md261":[9,0,18],
42+
"examples.html#autotoc_md262":[9,0,18,0],
43+
"examples.html#autotoc_md263":[9,0,19],
44+
"examples.html#autotoc_md264":[9,0,19,0],
45+
"examples.html#autotoc_md265":[9,0,20],
46+
"examples.html#autotoc_md266":[9,0,20,0],
47+
"examples.html#autotoc_md267":[9,0,20,1],
48+
"examples.html#autotoc_md268":[9,0,21],
49+
"examples.html#autotoc_md269":[9,0,21,0],
50+
"examples.html#autotoc_md270":[9,0,21,1],
51+
"examples.html#autotoc_md271":[9,0,22],
52+
"examples.html#autotoc_md272":[9,0,22,0],
53+
"examples.html#autotoc_md273":[9,0,23],
54+
"examples.html#autotoc_md274":[9,0,23,0],
55+
"examples.html#autotoc_md275":[9,0,24],
56+
"examples.html#autotoc_md276":[9,0,24,0],
5757
"expectedPerformance.html":[10],
5858
"expectedPerformance.html#autotoc_md277":[10,0],
5959
"expectedPerformance.html#autotoc_md279":[10,0,0],

‎documentation/parameters.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1575,7 +1575,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></a>
15751575
<div class="line"> </div>
15761576
<div class="line"># Filter by type</div>
15771577
<div class="line">./mfc.sh params -t real weno</div>
1578-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-23</div> </div></div><!-- contents -->
1578+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-24</div> </div></div><!-- contents -->
15791579
</div><!-- PageDoc -->
15801580
</div><!-- doc-content -->
15811581
<div id="page-nav" class="page-nav-panel">

‎documentation/physics_constraints.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -624,7 +624,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
624624
<li>FFT WRT incompatible with cylindrical coordinates</li>
625625
<li>FFT WRT requires global dimensions divisible by 2</li>
626626
</ul>
627-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-23</div> </div></div><!-- contents -->
627+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-24</div> </div></div><!-- contents -->
628628
</div><!-- PageDoc -->
629629
</div><!-- doc-content -->
630630
<div id="page-nav" class="page-nav-panel">

‎documentation/search/all_0.js‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)