Skip to content

Commit aa150b9

Browse files
author
MFC Action
committed
Docs @ ec94064
1 parent 116e3ba commit aa150b9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+7613
-7598
lines changed

‎documentation/architecture.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
401401
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
402402
</ol>
403403
<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>
404-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-09</div> </div></div><!-- contents -->
404+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-10</div> </div></div><!-- contents -->
405405
</div><!-- PageDoc -->
406406
</div><!-- doc-content -->
407407
<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
@@ -1420,7 +1420,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14201420
</table>
14211421
<hr />
14221422
<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>
1423-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-09</div> </div></div><!-- contents -->
1423+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-10</div> </div></div><!-- contents -->
14241424
</div><!-- PageDoc -->
14251425
</div><!-- doc-content -->
14261426
<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_md79"></a>
984984
<h3 class="doxsection"><a class="anchor" id="autotoc_md80"></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-09</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-10</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: 165 additions & 165 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
@@ -328,84 +328,84 @@ var NAVTREE =
328328
] ],
329329
[ "Example Cases", "examples.html", [
330330
[ "Example Cases", "examples.html#autotoc_md212", [
331-
[ "IBM Bow Shock (3D)", "examples.html#autotoc_md213", [
332-
[ "Final Condition", "examples.html#autotoc_md214", null ]
331+
[ "Titarev-Toro problem (1D)", "examples.html#autotoc_md213", [
332+
[ "Initial Condition", "examples.html#autotoc_md214", null ],
333+
[ "Result", "examples.html#autotoc_md215", null ]
333334
] ],
334-
[ "Isentropic vortex problem (2D)", "examples.html#autotoc_md215", [
335-
[ "Density", "examples.html#autotoc_md216", null ],
336-
[ "Density Norms", "examples.html#autotoc_md217", null ]
335+
[ "Lid-Driven Cavity Problem (2D)", "examples.html#autotoc_md216", [
336+
[ "Final Condition", "examples.html#autotoc_md217", null ],
337+
[ "Centerline Velocities", "examples.html#autotoc_md218", null ]
337338
] ],
338-
[ "Rayleigh-Taylor Instability (2D)", "examples.html#autotoc_md218", [
339-
[ "Final Condition and Linear Theory", "examples.html#autotoc_md219", null ]
339+
[ "2D Riemann Test (2D)", "examples.html#autotoc_md219", [
340+
[ "Density Initial and Final Conditions", "examples.html#autotoc_md220", null ]
340341
] ],
341-
[ "2D Hardcodied IC Example", "examples.html#autotoc_md220", [
342-
[ "Initial Condition and Result", "examples.html#autotoc_md221", null ]
342+
[ "Isentropic vortex problem (2D)", "examples.html#autotoc_md221", [
343+
[ "Density", "examples.html#autotoc_md222", null ],
344+
[ "Density Norms", "examples.html#autotoc_md223", null ]
343345
] ],
344-
[ "Taylor-Green Vortex (3D)", "examples.html#autotoc_md222", [
345-
[ "Final Condition", "examples.html#autotoc_md223", null ]
346+
[ "1D Multi-Component Inert Shock Tube", "examples.html#autotoc_md224", [
347+
[ "Initial Condition", "examples.html#autotoc_md225", null ],
348+
[ "Results", "examples.html#autotoc_md226", null ]
346349
] ],
347-
[ "2D IBM CFL dt (2D)", "examples.html#autotoc_md224", [
348-
[ "Result", "examples.html#autotoc_md225", null ]
350+
[ "Richtmyer-Meshkov Instability (2D)", "examples.html#autotoc_md227", null ],
351+
[ "Shock Droplet (2D)", "examples.html#autotoc_md230", [
352+
[ "Initial Condition", "examples.html#autotoc_md231", null ],
353+
[ "Result", "examples.html#autotoc_md232", null ]
349354
] ],
350-
[ "Scaling and Performance test", "examples.html#autotoc_md226", [
351-
[ "Weak Scaling", "examples.html#autotoc_md227", null ],
352-
[ "Strong Scaling", "examples.html#autotoc_md228", null ],
353-
[ "Example", "examples.html#autotoc_md229", null ]
355+
[ "Gas Jet (2D)", "examples.html#autotoc_md233", [
356+
[ "Final Condition", "examples.html#autotoc_md234", null ]
354357
] ],
355-
[ "Gas Jet (2D)", "examples.html#autotoc_md230", [
356-
[ "Final Condition", "examples.html#autotoc_md231", null ]
358+
[ "Scaling and Performance test", "examples.html#autotoc_md235", [
359+
[ "Weak Scaling", "examples.html#autotoc_md236", null ],
360+
[ "Strong Scaling", "examples.html#autotoc_md237", null ],
361+
[ "Example", "examples.html#autotoc_md238", null ]
357362
] ],
358-
[ "Perfectly Stirred Reactor", "examples.html#autotoc_md232", [
359-
[ "Validation", "examples.html#autotoc_md233", null ]
363+
[ "IBM Bow Shock (3D)", "examples.html#autotoc_md239", [
364+
[ "Final Condition", "examples.html#autotoc_md240", null ]
360365
] ],
361-
[ "Lax shock tube problem (1D)", "examples.html#autotoc_md234", [
362-
[ "Initial Condition", "examples.html#autotoc_md235", null ],
363-
[ "Result", "examples.html#autotoc_md236", null ]
366+
[ "Kelvin-Helmholtz Instability (2D)", "examples.html#autotoc_md241", null ],
367+
[ "Lax shock tube problem (1D)", "examples.html#autotoc_md244", [
368+
[ "Initial Condition", "examples.html#autotoc_md245", null ],
369+
[ "Result", "examples.html#autotoc_md246", null ]
364370
] ],
365-
[ "Shu-Osher problem (1D)", "examples.html#autotoc_md237", [
366-
[ "Initial Condition", "examples.html#autotoc_md238", null ],
367-
[ "Result", "examples.html#autotoc_md239", null ]
371+
[ "2D IBM CFL dt (2D)", "examples.html#autotoc_md247", [
372+
[ "Result", "examples.html#autotoc_md248", null ]
368373
] ],
369-
[ "Forward Facing Step (2D)", "examples.html#autotoc_md240", [
370-
[ "Final Condition (Density)", "examples.html#autotoc_md241", null ]
374+
[ "Viscous Shock Tube (2D)", "examples.html#autotoc_md249", null ],
375+
[ "Perfectly Stirred Reactor", "examples.html#autotoc_md252", [
376+
[ "Validation", "examples.html#autotoc_md253", null ]
371377
] ],
372-
[ "Lid-Driven Cavity Problem (2D)", "examples.html#autotoc_md242", [
373-
[ "Final Condition", "examples.html#autotoc_md243", null ],
374-
[ "Centerline Velocities", "examples.html#autotoc_md244", null ]
378+
[ "Forward Facing Step (2D)", "examples.html#autotoc_md254", [
379+
[ "Final Condition (Density)", "examples.html#autotoc_md255", null ]
375380
] ],
376-
[ "2D Riemann Test (2D)", "examples.html#autotoc_md245", [
377-
[ "Density Initial and Final Conditions", "examples.html#autotoc_md246", null ]
381+
[ "Backward Facing Step (2D)", "examples.html#autotoc_md256", [
382+
[ "Final Condition (Density)", "examples.html#autotoc_md257", null ]
378383
] ],
379-
[ "1D Multi-Component Reactive Shock Tube", "examples.html#autotoc_md247", [
380-
[ "Initial Condition", "examples.html#autotoc_md248", null ],
381-
[ "Results", "examples.html#autotoc_md249", null ]
384+
[ "2D Hardcodied IC Example", "examples.html#autotoc_md258", [
385+
[ "Initial Condition and Result", "examples.html#autotoc_md259", null ]
382386
] ],
383-
[ "2D Triple Point (2D)", "examples.html#autotoc_md250", [
384-
[ "Numerical Schlieren at Final Time", "examples.html#autotoc_md251", null ]
387+
[ "Rayleigh-Taylor Instability (2D)", "examples.html#autotoc_md260", [
388+
[ "Final Condition and Linear Theory", "examples.html#autotoc_md261", null ]
385389
] ],
386-
[ "Titarev-Toro problem (1D)", "examples.html#autotoc_md252", [
387-
[ "Initial Condition", "examples.html#autotoc_md253", null ],
388-
[ "Result", "examples.html#autotoc_md254", null ]
390+
[ "3D Turbulent Mixing layer (3D)", "examples.html#autotoc_md262", [
391+
[ "Liutex visualization at transitional state", "examples.html#autotoc_md263", null ]
389392
] ],
390-
[ "Richtmyer-Meshkov Instability (2D)", "examples.html#autotoc_md255", null ],
391-
[ "Backward Facing Step (2D)", "examples.html#autotoc_md258", [
392-
[ "Final Condition (Density)", "examples.html#autotoc_md259", null ]
393+
[ "1D Multi-Component Reactive Shock Tube", "examples.html#autotoc_md264", [
394+
[ "Initial Condition", "examples.html#autotoc_md265", null ],
395+
[ "Results", "examples.html#autotoc_md266", null ]
393396
] ],
394-
[ "Viscous Shock Tube (2D)", "examples.html#autotoc_md260", null ],
395-
[ "3D Turbulent Mixing layer (3D)", "examples.html#autotoc_md263", [
396-
[ "Liutex visualization at transitional state", "examples.html#autotoc_md264", null ]
397+
[ "Shu-Osher problem (1D)", "examples.html#autotoc_md267", [
398+
[ "Initial Condition", "examples.html#autotoc_md268", null ],
399+
[ "Result", "examples.html#autotoc_md269", null ]
397400
] ],
398-
[ "Shock Droplet (2D)", "examples.html#autotoc_md265", [
399-
[ "Initial Condition", "examples.html#autotoc_md266", null ],
400-
[ "Result", "examples.html#autotoc_md267", null ]
401+
[ "2D Triple Point (2D)", "examples.html#autotoc_md270", [
402+
[ "Numerical Schlieren at Final Time", "examples.html#autotoc_md271", null ]
401403
] ],
402-
[ "Kelvin-Helmholtz Instability (2D)", "examples.html#autotoc_md268", null ],
403-
[ "1D Multi-Component Inert Shock Tube", "examples.html#autotoc_md271", [
404-
[ "Initial Condition", "examples.html#autotoc_md272", null ],
405-
[ "Results", "examples.html#autotoc_md273", null ]
404+
[ "Rayleigh-Taylor Instability (3D)", "examples.html#autotoc_md272", [
405+
[ "Final Condition and Linear Theory", "examples.html#autotoc_md273", null ]
406406
] ],
407-
[ "Rayleigh-Taylor Instability (3D)", "examples.html#autotoc_md274", [
408-
[ "Final Condition and Linear Theory", "examples.html#autotoc_md275", null ]
407+
[ "Taylor-Green Vortex (3D)", "examples.html#autotoc_md274", [
408+
[ "Final Condition", "examples.html#autotoc_md275", null ]
409409
] ]
410410
] ]
411411
] ],

‎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#autotoc_md212":[9,0],
249249
"examples.html#autotoc_md213":[9,0,0],
250250
"examples.html#autotoc_md214":[9,0,0,0],
251-
"examples.html#autotoc_md215":[9,0,1],
252-
"examples.html#autotoc_md216":[9,0,1,0]
251+
"examples.html#autotoc_md215":[9,0,0,1],
252+
"examples.html#autotoc_md216":[9,0,1]
253253
};

‎documentation/navtreeindex1.js‎

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

‎documentation/parameters.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1543,7 +1543,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md392"></a>
15431543
<div class="line"> </div>
15441544
<div class="line"># Filter by type</div>
15451545
<div class="line">./mfc.sh params -t real weno</div>
1546-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-09</div> </div></div><!-- contents -->
1546+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-10</div> </div></div><!-- contents -->
15471547
</div><!-- PageDoc -->
15481548
</div><!-- doc-content -->
15491549
<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_md442"></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-09</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-10</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: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)