Skip to content

Commit 521f781

Browse files
author
MFC Action
committed
Docs @ ab146e9
1 parent c470f69 commit 521f781

63 files changed

Lines changed: 624 additions & 624 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
@@ -405,7 +405,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
405405
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
406406
</ol>
407407
<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>
408-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-27</div> </div></div><!-- contents -->
408+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-28</div> </div></div><!-- contents -->
409409
</div><!-- PageDoc -->
410410
</div><!-- doc-content -->
411411
<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
@@ -1456,7 +1456,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14561456
</table>
14571457
<hr />
14581458
<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>
1459-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-27</div> </div></div><!-- contents -->
1459+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-28</div> </div></div><!-- contents -->
14601460
</div><!-- PageDoc -->
14611461
</div><!-- doc-content -->
14621462
<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
@@ -996,7 +996,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
996996
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
997997
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
998998
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
999-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-27</div> </div></div><!-- contents -->
999+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-28</div> </div></div><!-- contents -->
10001000
</div><!-- PageDoc -->
10011001
</div><!-- doc-content -->
10021002
<div id="page-nav" class="page-nav-panel">

‎documentation/examples.html‎

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

‎documentation/navtreedata.js‎

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -329,82 +329,82 @@ var NAVTREE =
329329
] ],
330330
[ "Example Cases", "examples.html", [
331331
[ "Example Cases", "examples.html#autotoc_md213", [
332-
[ "Rayleigh-Taylor Instability (3D)", "examples.html#autotoc_md214", [
333-
[ "Final Condition and Linear Theory", "examples.html#autotoc_md215", null ]
332+
[ "1D Multi-Component Inert Shock Tube", "examples.html#autotoc_md214", [
333+
[ "Initial Condition", "examples.html#autotoc_md215", null ],
334+
[ "Results", "examples.html#autotoc_md216", null ]
334335
] ],
335-
[ "1D Multi-Component Reactive Shock Tube", "examples.html#autotoc_md216", [
336-
[ "Initial Condition", "examples.html#autotoc_md217", null ],
337-
[ "Results", "examples.html#autotoc_md218", null ]
336+
[ "Shock Droplet (2D)", "examples.html#autotoc_md217", [
337+
[ "Initial Condition", "examples.html#autotoc_md218", null ],
338+
[ "Result", "examples.html#autotoc_md219", null ]
338339
] ],
339-
[ "2D Hardcodied IC Example", "examples.html#autotoc_md219", [
340-
[ "Initial Condition and Result", "examples.html#autotoc_md220", null ]
340+
[ "Backward Facing Step (2D)", "examples.html#autotoc_md220", [
341+
[ "Final Condition (Density)", "examples.html#autotoc_md221", null ]
341342
] ],
342-
[ "Scaling and Performance test", "examples.html#autotoc_md221", [
343-
[ "Weak Scaling", "examples.html#autotoc_md222", null ],
344-
[ "Strong Scaling", "examples.html#autotoc_md223", null ],
345-
[ "Example", "examples.html#autotoc_md224", null ]
343+
[ "Lid-Driven Cavity Problem (2D)", "examples.html#autotoc_md222", [
344+
[ "Final Condition", "examples.html#autotoc_md223", null ],
345+
[ "Centerline Velocities", "examples.html#autotoc_md224", null ]
346346
] ],
347-
[ "Perfectly Stirred Reactor", "examples.html#autotoc_md225", [
348-
[ "Validation", "examples.html#autotoc_md226", null ]
347+
[ "Viscous Shock Tube (2D)", "examples.html#autotoc_md225", null ],
348+
[ "2D Triple Point (2D)", "examples.html#autotoc_md228", [
349+
[ "Numerical Schlieren at Final Time", "examples.html#autotoc_md229", null ]
349350
] ],
350-
[ "Forward Facing Step (2D)", "examples.html#autotoc_md227", [
351-
[ "Final Condition (Density)", "examples.html#autotoc_md228", null ]
351+
[ "Perfectly Stirred Reactor", "examples.html#autotoc_md230", [
352+
[ "Validation", "examples.html#autotoc_md231", null ]
352353
] ],
353-
[ "Richtmyer-Meshkov Instability (2D)", "examples.html#autotoc_md229", null ],
354-
[ "Isentropic vortex problem (2D)", "examples.html#autotoc_md232", [
355-
[ "Density", "examples.html#autotoc_md233", null ],
356-
[ "Density Norms", "examples.html#autotoc_md234", null ]
354+
[ "Shu-Osher problem (1D)", "examples.html#autotoc_md232", [
355+
[ "Initial Condition", "examples.html#autotoc_md233", null ],
356+
[ "Result", "examples.html#autotoc_md234", null ]
357357
] ],
358-
[ "2D Riemann Test (2D)", "examples.html#autotoc_md235", [
359-
[ "Density Initial and Final Conditions", "examples.html#autotoc_md236", null ]
358+
[ "2D Hardcodied IC Example", "examples.html#autotoc_md235", [
359+
[ "Initial Condition and Result", "examples.html#autotoc_md236", null ]
360360
] ],
361-
[ "Taylor-Green Vortex (3D)", "examples.html#autotoc_md237", [
362-
[ "Final Condition", "examples.html#autotoc_md238", null ]
361+
[ "Scaling and Performance test", "examples.html#autotoc_md237", [
362+
[ "Weak Scaling", "examples.html#autotoc_md238", null ],
363+
[ "Strong Scaling", "examples.html#autotoc_md239", null ],
364+
[ "Example", "examples.html#autotoc_md240", null ]
363365
] ],
364-
[ "Viscous Shock Tube (2D)", "examples.html#autotoc_md239", null ],
365-
[ "2D Triple Point (2D)", "examples.html#autotoc_md242", [
366-
[ "Numerical Schlieren at Final Time", "examples.html#autotoc_md243", null ]
366+
[ "2D Riemann Test (2D)", "examples.html#autotoc_md241", [
367+
[ "Density Initial and Final Conditions", "examples.html#autotoc_md242", null ]
367368
] ],
368-
[ "Titarev-Toro problem (1D)", "examples.html#autotoc_md244", [
369-
[ "Initial Condition", "examples.html#autotoc_md245", null ],
370-
[ "Result", "examples.html#autotoc_md246", null ]
369+
[ "Rayleigh-Taylor Instability (2D)", "examples.html#autotoc_md243", [
370+
[ "Final Condition and Linear Theory", "examples.html#autotoc_md244", null ]
371371
] ],
372-
[ "Backward Facing Step (2D)", "examples.html#autotoc_md247", [
373-
[ "Final Condition (Density)", "examples.html#autotoc_md248", null ]
372+
[ "Gas Jet (2D)", "examples.html#autotoc_md245", [
373+
[ "Final Condition", "examples.html#autotoc_md246", null ]
374374
] ],
375-
[ "Lid-Driven Cavity Problem (2D)", "examples.html#autotoc_md249", [
376-
[ "Final Condition", "examples.html#autotoc_md250", null ],
377-
[ "Centerline Velocities", "examples.html#autotoc_md251", null ]
375+
[ "Forward Facing Step (2D)", "examples.html#autotoc_md247", [
376+
[ "Final Condition (Density)", "examples.html#autotoc_md248", null ]
378377
] ],
379-
[ "2D IBM CFL dt (2D)", "examples.html#autotoc_md252", [
380-
[ "Result", "examples.html#autotoc_md253", null ]
378+
[ "3D Turbulent Mixing layer (3D)", "examples.html#autotoc_md249", [
379+
[ "Liutex visualization at transitional state", "examples.html#autotoc_md250", null ]
381380
] ],
382-
[ "Shock Droplet (2D)", "examples.html#autotoc_md254", [
383-
[ "Initial Condition", "examples.html#autotoc_md255", null ],
384-
[ "Result", "examples.html#autotoc_md256", null ]
381+
[ "IBM Bow Shock (3D)", "examples.html#autotoc_md251", [
382+
[ "Final Condition", "examples.html#autotoc_md252", null ]
385383
] ],
386-
[ "Shu-Osher problem (1D)", "examples.html#autotoc_md257", [
387-
[ "Initial Condition", "examples.html#autotoc_md258", null ],
388-
[ "Result", "examples.html#autotoc_md259", null ]
384+
[ "Isentropic vortex problem (2D)", "examples.html#autotoc_md253", [
385+
[ "Density", "examples.html#autotoc_md254", null ],
386+
[ "Density Norms", "examples.html#autotoc_md255", null ]
389387
] ],
390-
[ "1D Multi-Component Inert Shock Tube", "examples.html#autotoc_md260", [
391-
[ "Initial Condition", "examples.html#autotoc_md261", null ],
392-
[ "Results", "examples.html#autotoc_md262", null ]
388+
[ "Richtmyer-Meshkov Instability (2D)", "examples.html#autotoc_md256", null ],
389+
[ "2D IBM CFL dt (2D)", "examples.html#autotoc_md259", [
390+
[ "Result", "examples.html#autotoc_md260", null ]
393391
] ],
394-
[ "3D Turbulent Mixing layer (3D)", "examples.html#autotoc_md263", [
395-
[ "Liutex visualization at transitional state", "examples.html#autotoc_md264", null ]
392+
[ "1D Multi-Component Reactive Shock Tube", "examples.html#autotoc_md261", [
393+
[ "Initial Condition", "examples.html#autotoc_md262", null ],
394+
[ "Results", "examples.html#autotoc_md263", null ]
396395
] ],
397-
[ "Rayleigh-Taylor Instability (2D)", "examples.html#autotoc_md265", [
398-
[ "Final Condition and Linear Theory", "examples.html#autotoc_md266", null ]
396+
[ "Lax shock tube problem (1D)", "examples.html#autotoc_md264", [
397+
[ "Initial Condition", "examples.html#autotoc_md265", null ],
398+
[ "Result", "examples.html#autotoc_md266", null ]
399399
] ],
400-
[ "Gas Jet (2D)", "examples.html#autotoc_md267", [
401-
[ "Final Condition", "examples.html#autotoc_md268", null ]
400+
[ "Rayleigh-Taylor Instability (3D)", "examples.html#autotoc_md267", [
401+
[ "Final Condition and Linear Theory", "examples.html#autotoc_md268", null ]
402402
] ],
403-
[ "IBM Bow Shock (3D)", "examples.html#autotoc_md269", [
404-
[ "Final Condition", "examples.html#autotoc_md270", null ]
403+
[ "Kelvin-Helmholtz Instability (2D)", "examples.html#autotoc_md269", null ],
404+
[ "Taylor-Green Vortex (3D)", "examples.html#autotoc_md272", [
405+
[ "Final Condition", "examples.html#autotoc_md273", null ]
405406
] ],
406-
[ "Kelvin-Helmholtz Instability (2D)", "examples.html#autotoc_md271", null ],
407-
[ "Lax shock tube problem (1D)", "examples.html#autotoc_md274", [
407+
[ "Titarev-Toro problem (1D)", "examples.html#autotoc_md274", [
408408
[ "Initial Condition", "examples.html#autotoc_md275", null ],
409409
[ "Result", "examples.html#autotoc_md276", null ]
410410
] ]

‎documentation/navtreeindex0.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,5 +249,5 @@ var NAVTREEINDEX0 =
249249
"examples.html#autotoc_md213":[9,0],
250250
"examples.html#autotoc_md214":[9,0,0],
251251
"examples.html#autotoc_md215":[9,0,0,0],
252-
"examples.html#autotoc_md216":[9,0,1]
252+
"examples.html#autotoc_md216":[9,0,0,1]
253253
};

‎documentation/navtreeindex1.js‎

Lines changed: 36 additions & 36 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,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,3,2],
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],
8+
"examples.html#autotoc_md222":[9,0,3],
9+
"examples.html#autotoc_md223":[9,0,3,0],
10+
"examples.html#autotoc_md224":[9,0,3,1],
1111
"examples.html#autotoc_md225":[9,0,4],
12-
"examples.html#autotoc_md226":[9,0,4,0],
13-
"examples.html#autotoc_md227":[9,0,5],
14-
"examples.html#autotoc_md228":[9,0,5,0],
15-
"examples.html#autotoc_md229":[9,0,6],
12+
"examples.html#autotoc_md228":[9,0,5],
13+
"examples.html#autotoc_md229":[9,0,5,0],
14+
"examples.html#autotoc_md230":[9,0,6],
15+
"examples.html#autotoc_md231":[9,0,6,0],
1616
"examples.html#autotoc_md232":[9,0,7],
1717
"examples.html#autotoc_md233":[9,0,7,0],
1818
"examples.html#autotoc_md234":[9,0,7,1],
1919
"examples.html#autotoc_md235":[9,0,8],
2020
"examples.html#autotoc_md236":[9,0,8,0],
2121
"examples.html#autotoc_md237":[9,0,9],
2222
"examples.html#autotoc_md238":[9,0,9,0],
23-
"examples.html#autotoc_md239":[9,0,10],
24-
"examples.html#autotoc_md242":[9,0,11],
25-
"examples.html#autotoc_md243":[9,0,11,0],
26-
"examples.html#autotoc_md244":[9,0,12],
27-
"examples.html#autotoc_md245":[9,0,12,0],
28-
"examples.html#autotoc_md246":[9,0,12,1],
23+
"examples.html#autotoc_md239":[9,0,9,1],
24+
"examples.html#autotoc_md240":[9,0,9,2],
25+
"examples.html#autotoc_md241":[9,0,10],
26+
"examples.html#autotoc_md242":[9,0,10,0],
27+
"examples.html#autotoc_md243":[9,0,11],
28+
"examples.html#autotoc_md244":[9,0,11,0],
29+
"examples.html#autotoc_md245":[9,0,12],
30+
"examples.html#autotoc_md246":[9,0,12,0],
2931
"examples.html#autotoc_md247":[9,0,13],
3032
"examples.html#autotoc_md248":[9,0,13,0],
3133
"examples.html#autotoc_md249":[9,0,14],
3234
"examples.html#autotoc_md250":[9,0,14,0],
33-
"examples.html#autotoc_md251":[9,0,14,1],
34-
"examples.html#autotoc_md252":[9,0,15],
35-
"examples.html#autotoc_md253":[9,0,15,0],
36-
"examples.html#autotoc_md254":[9,0,16],
37-
"examples.html#autotoc_md255":[9,0,16,0],
38-
"examples.html#autotoc_md256":[9,0,16,1],
39-
"examples.html#autotoc_md257":[9,0,17],
40-
"examples.html#autotoc_md258":[9,0,17,0],
41-
"examples.html#autotoc_md259":[9,0,17,1],
42-
"examples.html#autotoc_md260":[9,0,18],
43-
"examples.html#autotoc_md261":[9,0,18,0],
44-
"examples.html#autotoc_md262":[9,0,18,1],
45-
"examples.html#autotoc_md263":[9,0,19],
46-
"examples.html#autotoc_md264":[9,0,19,0],
47-
"examples.html#autotoc_md265":[9,0,20],
48-
"examples.html#autotoc_md266":[9,0,20,0],
35+
"examples.html#autotoc_md251":[9,0,15],
36+
"examples.html#autotoc_md252":[9,0,15,0],
37+
"examples.html#autotoc_md253":[9,0,16],
38+
"examples.html#autotoc_md254":[9,0,16,0],
39+
"examples.html#autotoc_md255":[9,0,16,1],
40+
"examples.html#autotoc_md256":[9,0,17],
41+
"examples.html#autotoc_md259":[9,0,18],
42+
"examples.html#autotoc_md260":[9,0,18,0],
43+
"examples.html#autotoc_md261":[9,0,19],
44+
"examples.html#autotoc_md262":[9,0,19,0],
45+
"examples.html#autotoc_md263":[9,0,19,1],
46+
"examples.html#autotoc_md264":[9,0,20],
47+
"examples.html#autotoc_md265":[9,0,20,0],
48+
"examples.html#autotoc_md266":[9,0,20,1],
4949
"examples.html#autotoc_md267":[9,0,21],
5050
"examples.html#autotoc_md268":[9,0,21,0],
5151
"examples.html#autotoc_md269":[9,0,22],
52-
"examples.html#autotoc_md270":[9,0,22,0],
53-
"examples.html#autotoc_md271":[9,0,23],
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
"examples.html#autotoc_md276":[9,0,24,1],

‎documentation/parameters.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1577,7 +1577,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></a>
15771577
<div class="line"> </div>
15781578
<div class="line"># Filter by type</div>
15791579
<div class="line">./mfc.sh params -t real weno</div>
1580-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-27</div> </div></div><!-- contents -->
1580+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-28</div> </div></div><!-- contents -->
15811581
</div><!-- PageDoc -->
15821582
</div><!-- doc-content -->
15831583
<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
@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
630630
<li>FFT WRT incompatible with cylindrical coordinates</li>
631631
<li>FFT WRT requires global dimensions divisible by 2</li>
632632
</ul>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-27</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-28</div> </div></div><!-- contents -->
634634
</div><!-- PageDoc -->
635635
</div><!-- doc-content -->
636636
<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)