Skip to content

Commit e2f9a84

Browse files
author
MFC Action
committed
Docs @ 9652f08
1 parent b8c2dcc commit e2f9a84

Some content is hidden

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

62 files changed

+1513
-1513
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-02-25</div> </div></div><!-- contents -->
404+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-26</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
@@ -1421,7 +1421,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14211421
</table>
14221422
<hr />
14231423
<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>
1424-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-25</div> </div></div><!-- contents -->
1424+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-26</div> </div></div><!-- contents -->
14251425
</div><!-- PageDoc -->
14261426
</div><!-- doc-content -->
14271427
<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
@@ -863,7 +863,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md77"></a>
863863
<h3 class="doxsection"><a class="anchor" id="autotoc_md78"></a>
864864
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
865865
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
866-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-25</div> </div></div><!-- contents -->
866+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-26</div> </div></div><!-- contents -->
867867
</div><!-- PageDoc -->
868868
</div><!-- doc-content -->
869869
<div id="page-nav" class="page-nav-panel">

‎documentation/examples.html‎

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

‎documentation/navtreedata.js‎

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -326,82 +326,82 @@ var NAVTREE =
326326
] ],
327327
[ "Example Cases", "examples.html", [
328328
[ "Example Cases", "examples.html#autotoc_md210", [
329-
[ "Lax shock tube problem (1D)", "examples.html#autotoc_md211", [
330-
[ "Initial Condition", "examples.html#autotoc_md212", null ],
331-
[ "Result", "examples.html#autotoc_md213", null ]
329+
[ "Perfectly Stirred Reactor", "examples.html#autotoc_md211", null ],
330+
[ "2D Triple Point (2D)", "examples.html#autotoc_md212", [
331+
[ "Numerical Schlieren at Final Time", "examples.html#autotoc_md213", null ]
332332
] ],
333-
[ "Scaling and Performance test", "examples.html#autotoc_md214", [
334-
[ "Weak Scaling", "examples.html#autotoc_md215", null ],
335-
[ "Strong Scaling", "examples.html#autotoc_md216", null ],
336-
[ "Example", "examples.html#autotoc_md217", null ]
333+
[ "Lax shock tube problem (1D)", "examples.html#autotoc_md214", [
334+
[ "Initial Condition", "examples.html#autotoc_md215", null ],
335+
[ "Result", "examples.html#autotoc_md216", null ]
337336
] ],
338-
[ "Rayleigh-Taylor Instability (3D)", "examples.html#autotoc_md218", [
339-
[ "Final Condition and Linear Theory", "examples.html#autotoc_md219", null ]
337+
[ "Richtmyer-Meshkov Instability (2D)", "examples.html#autotoc_md217", null ],
338+
[ "Shu-Osher problem (1D)", "examples.html#autotoc_md220", [
339+
[ "Initial Condition", "examples.html#autotoc_md221", null ],
340+
[ "Result", "examples.html#autotoc_md222", null ]
340341
] ],
341-
[ "2D IBM CFL dt (2D)", "examples.html#autotoc_md220", [
342-
[ "Result", "examples.html#autotoc_md221", null ]
342+
[ "Shock Droplet (2D)", "examples.html#autotoc_md223", [
343+
[ "Initial Condition", "examples.html#autotoc_md224", null ],
344+
[ "Result", "examples.html#autotoc_md225", null ]
343345
] ],
344-
[ "Shu-Osher problem (1D)", "examples.html#autotoc_md222", [
345-
[ "Initial Condition", "examples.html#autotoc_md223", null ],
346-
[ "Result", "examples.html#autotoc_md224", null ]
346+
[ "Rayleigh-Taylor Instability (2D)", "examples.html#autotoc_md226", [
347+
[ "Final Condition and Linear Theory", "examples.html#autotoc_md227", null ]
347348
] ],
348-
[ "Kelvin-Helmholtz Instability (2D)", "examples.html#autotoc_md225", null ],
349-
[ "Gas Jet (2D)", "examples.html#autotoc_md228", [
350-
[ "Final Condition", "examples.html#autotoc_md229", null ]
349+
[ "1D Multi-Component Reactive Shock Tube", "examples.html#autotoc_md228", [
350+
[ "Initial Condition", "examples.html#autotoc_md229", null ],
351+
[ "Results", "examples.html#autotoc_md230", null ]
351352
] ],
352-
[ "1D Multi-Component Reactive Shock Tube", "examples.html#autotoc_md230", [
353-
[ "Initial Condition", "examples.html#autotoc_md231", null ],
354-
[ "Results", "examples.html#autotoc_md232", null ]
353+
[ "2D Riemann Test (2D)", "examples.html#autotoc_md231", [
354+
[ "Density Initial and Final Conditions", "examples.html#autotoc_md232", null ]
355355
] ],
356-
[ "Forward Facing Step (2D)", "examples.html#autotoc_md233", [
357-
[ "Final Condition (Density)", "examples.html#autotoc_md234", null ]
356+
[ "3D Turbulent Mixing layer (3D)", "examples.html#autotoc_md233", [
357+
[ "Liutex visualization at transitional state", "examples.html#autotoc_md234", null ]
358358
] ],
359-
[ "2D Riemann Test (2D)", "examples.html#autotoc_md235", [
360-
[ "Density Initial and Final Conditions", "examples.html#autotoc_md236", null ]
359+
[ "Kelvin-Helmholtz Instability (2D)", "examples.html#autotoc_md235", null ],
360+
[ "Scaling and Performance test", "examples.html#autotoc_md238", [
361+
[ "Weak Scaling", "examples.html#autotoc_md239", null ],
362+
[ "Strong Scaling", "examples.html#autotoc_md240", null ],
363+
[ "Example", "examples.html#autotoc_md241", null ]
361364
] ],
362-
[ "Perfectly Stirred Reactor", "examples.html#autotoc_md237", null ],
363-
[ "Lid-Driven Cavity Problem (2D)", "examples.html#autotoc_md238", [
364-
[ "Final Condition", "examples.html#autotoc_md239", null ],
365-
[ "Centerline Velocities", "examples.html#autotoc_md240", null ]
365+
[ "Titarev-Toro problem (1D)", "examples.html#autotoc_md242", [
366+
[ "Initial Condition", "examples.html#autotoc_md243", null ],
367+
[ "Result", "examples.html#autotoc_md244", null ]
366368
] ],
367-
[ "Richtmyer-Meshkov Instability (2D)", "examples.html#autotoc_md241", null ],
368-
[ "Viscous Shock Tube (2D)", "examples.html#autotoc_md244", null ],
369-
[ "Isentropic vortex problem (2D)", "examples.html#autotoc_md247", [
370-
[ "Density", "examples.html#autotoc_md248", null ],
371-
[ "Density Norms", "examples.html#autotoc_md249", null ]
369+
[ "Gas Jet (2D)", "examples.html#autotoc_md245", [
370+
[ "Final Condition", "examples.html#autotoc_md246", null ]
372371
] ],
373-
[ "Titarev-Toro problem (1D)", "examples.html#autotoc_md250", [
374-
[ "Initial Condition", "examples.html#autotoc_md251", null ],
375-
[ "Result", "examples.html#autotoc_md252", null ]
372+
[ "IBM Bow Shock (3D)", "examples.html#autotoc_md247", [
373+
[ "Final Condition", "examples.html#autotoc_md248", null ]
376374
] ],
377-
[ "2D Hardcodied IC Example", "examples.html#autotoc_md253", [
378-
[ "Initial Condition and Result", "examples.html#autotoc_md254", null ]
375+
[ "Viscous Shock Tube (2D)", "examples.html#autotoc_md249", null ],
376+
[ "Isentropic vortex problem (2D)", "examples.html#autotoc_md252", [
377+
[ "Density", "examples.html#autotoc_md253", null ],
378+
[ "Density Norms", "examples.html#autotoc_md254", null ]
379379
] ],
380380
[ "Backward Facing Step (2D)", "examples.html#autotoc_md255", [
381381
[ "Final Condition (Density)", "examples.html#autotoc_md256", null ]
382382
] ],
383-
[ "Shock Droplet (2D)", "examples.html#autotoc_md257", [
383+
[ "1D Multi-Component Inert Shock Tube", "examples.html#autotoc_md257", [
384384
[ "Initial Condition", "examples.html#autotoc_md258", null ],
385-
[ "Result", "examples.html#autotoc_md259", null ]
385+
[ "Results", "examples.html#autotoc_md259", null ]
386386
] ],
387-
[ "Taylor-Green Vortex (3D)", "examples.html#autotoc_md260", [
388-
[ "Final Condition", "examples.html#autotoc_md261", null ]
387+
[ "Rayleigh-Taylor Instability (3D)", "examples.html#autotoc_md260", [
388+
[ "Final Condition and Linear Theory", "examples.html#autotoc_md261", null ]
389389
] ],
390-
[ "Rayleigh-Taylor Instability (2D)", "examples.html#autotoc_md262", [
391-
[ "Final Condition and Linear Theory", "examples.html#autotoc_md263", null ]
390+
[ "2D Hardcodied IC Example", "examples.html#autotoc_md262", [
391+
[ "Initial Condition and Result", "examples.html#autotoc_md263", null ]
392392
] ],
393-
[ "2D Triple Point (2D)", "examples.html#autotoc_md264", [
394-
[ "Numerical Schlieren at Final Time", "examples.html#autotoc_md265", null ]
393+
[ "2D IBM CFL dt (2D)", "examples.html#autotoc_md264", [
394+
[ "Result", "examples.html#autotoc_md265", null ]
395395
] ],
396-
[ "3D Turbulent Mixing layer (3D)", "examples.html#autotoc_md266", [
397-
[ "Liutex visualization at transitional state", "examples.html#autotoc_md267", null ]
396+
[ "Lid-Driven Cavity Problem (2D)", "examples.html#autotoc_md266", [
397+
[ "Final Condition", "examples.html#autotoc_md267", null ],
398+
[ "Centerline Velocities", "examples.html#autotoc_md268", null ]
398399
] ],
399-
[ "1D Multi-Component Inert Shock Tube", "examples.html#autotoc_md268", [
400-
[ "Initial Condition", "examples.html#autotoc_md269", null ],
401-
[ "Results", "examples.html#autotoc_md270", null ]
400+
[ "Taylor-Green Vortex (3D)", "examples.html#autotoc_md269", [
401+
[ "Final Condition", "examples.html#autotoc_md270", null ]
402402
] ],
403-
[ "IBM Bow Shock (3D)", "examples.html#autotoc_md271", [
404-
[ "Final Condition", "examples.html#autotoc_md272", null ]
403+
[ "Forward Facing Step (2D)", "examples.html#autotoc_md271", [
404+
[ "Final Condition (Density)", "examples.html#autotoc_md272", null ]
405405
] ]
406406
] ]
407407
] ],

‎documentation/navtreeindex0.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -245,9 +245,9 @@ var NAVTREEINDEX0 =
245245
"examples.html":[9],
246246
"examples.html#autotoc_md210":[9,0],
247247
"examples.html#autotoc_md211":[9,0,0],
248-
"examples.html#autotoc_md212":[9,0,0,0],
249-
"examples.html#autotoc_md213":[9,0,0,1],
250-
"examples.html#autotoc_md214":[9,0,1],
251-
"examples.html#autotoc_md215":[9,0,1,0],
252-
"examples.html#autotoc_md216":[9,0,1,1]
248+
"examples.html#autotoc_md212":[9,0,1],
249+
"examples.html#autotoc_md213":[9,0,1,0],
250+
"examples.html#autotoc_md214":[9,0,2],
251+
"examples.html#autotoc_md215":[9,0,2,0],
252+
"examples.html#autotoc_md216":[9,0,2,1]
253253
};

‎documentation/navtreeindex1.js‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
var NAVTREEINDEX1 =
22
{
3-
"examples.html#autotoc_md217":[9,0,1,2],
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,4,1],
11-
"examples.html#autotoc_md225":[9,0,5],
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_md231":[9,0,7,0],
16-
"examples.html#autotoc_md232":[9,0,7,1],
17-
"examples.html#autotoc_md233":[9,0,8],
18-
"examples.html#autotoc_md234":[9,0,8,0],
19-
"examples.html#autotoc_md235":[9,0,9],
20-
"examples.html#autotoc_md236":[9,0,9,0],
21-
"examples.html#autotoc_md237":[9,0,10],
3+
"examples.html#autotoc_md217":[9,0,3],
4+
"examples.html#autotoc_md220":[9,0,4],
5+
"examples.html#autotoc_md221":[9,0,4,0],
6+
"examples.html#autotoc_md222":[9,0,4,1],
7+
"examples.html#autotoc_md223":[9,0,5],
8+
"examples.html#autotoc_md224":[9,0,5,0],
9+
"examples.html#autotoc_md225":[9,0,5,1],
10+
"examples.html#autotoc_md226":[9,0,6],
11+
"examples.html#autotoc_md227":[9,0,6,0],
12+
"examples.html#autotoc_md228":[9,0,7],
13+
"examples.html#autotoc_md229":[9,0,7,0],
14+
"examples.html#autotoc_md230":[9,0,7,1],
15+
"examples.html#autotoc_md231":[9,0,8],
16+
"examples.html#autotoc_md232":[9,0,8,0],
17+
"examples.html#autotoc_md233":[9,0,9],
18+
"examples.html#autotoc_md234":[9,0,9,0],
19+
"examples.html#autotoc_md235":[9,0,10],
2220
"examples.html#autotoc_md238":[9,0,11],
2321
"examples.html#autotoc_md239":[9,0,11,0],
2422
"examples.html#autotoc_md240":[9,0,11,1],
25-
"examples.html#autotoc_md241":[9,0,12],
26-
"examples.html#autotoc_md244":[9,0,13],
23+
"examples.html#autotoc_md241":[9,0,11,2],
24+
"examples.html#autotoc_md242":[9,0,12],
25+
"examples.html#autotoc_md243":[9,0,12,0],
26+
"examples.html#autotoc_md244":[9,0,12,1],
27+
"examples.html#autotoc_md245":[9,0,13],
28+
"examples.html#autotoc_md246":[9,0,13,0],
2729
"examples.html#autotoc_md247":[9,0,14],
2830
"examples.html#autotoc_md248":[9,0,14,0],
29-
"examples.html#autotoc_md249":[9,0,14,1],
30-
"examples.html#autotoc_md250":[9,0,15],
31-
"examples.html#autotoc_md251":[9,0,15,0],
32-
"examples.html#autotoc_md252":[9,0,15,1],
33-
"examples.html#autotoc_md253":[9,0,16],
34-
"examples.html#autotoc_md254":[9,0,16,0],
31+
"examples.html#autotoc_md249":[9,0,15],
32+
"examples.html#autotoc_md252":[9,0,16],
33+
"examples.html#autotoc_md253":[9,0,16,0],
34+
"examples.html#autotoc_md254":[9,0,16,1],
3535
"examples.html#autotoc_md255":[9,0,17],
3636
"examples.html#autotoc_md256":[9,0,17,0],
3737
"examples.html#autotoc_md257":[9,0,18],
@@ -45,9 +45,9 @@ var NAVTREEINDEX1 =
4545
"examples.html#autotoc_md265":[9,0,21,0],
4646
"examples.html#autotoc_md266":[9,0,22],
4747
"examples.html#autotoc_md267":[9,0,22,0],
48-
"examples.html#autotoc_md268":[9,0,23],
49-
"examples.html#autotoc_md269":[9,0,23,0],
50-
"examples.html#autotoc_md270":[9,0,23,1],
48+
"examples.html#autotoc_md268":[9,0,22,1],
49+
"examples.html#autotoc_md269":[9,0,23],
50+
"examples.html#autotoc_md270":[9,0,23,0],
5151
"examples.html#autotoc_md271":[9,0,24],
5252
"examples.html#autotoc_md272":[9,0,24,0],
5353
"expectedPerformance.html":[10],

‎documentation/parameters.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1524,7 +1524,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md390"></a>
15241524
<div class="line"> </div>
15251525
<div class="line"># Filter by type</div>
15261526
<div class="line">./mfc.sh params -t real weno</div>
1527-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-25</div> </div></div><!-- contents -->
1527+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-26</div> </div></div><!-- contents -->
15281528
</div><!-- PageDoc -->
15291529
</div><!-- doc-content -->
15301530
<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
@@ -623,7 +623,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md440"></a>
623623
<li>FFT WRT incompatible with cylindrical coordinates</li>
624624
<li>FFT WRT requires global dimensions divisible by 2</li>
625625
</ul>
626-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-25</div> </div></div><!-- contents -->
626+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-02-26</div> </div></div><!-- contents -->
627627
</div><!-- PageDoc -->
628628
</div><!-- doc-content -->
629629
<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)