Skip to content

Commit 7bc0af5

Browse files
author
MFC Action
committed
Docs @ cc20c94
1 parent 8e66fa3 commit 7bc0af5

59 files changed

Lines changed: 873 additions & 872 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-09-04</div> </div></div><!-- contents -->
432+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-05</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
@@ -1593,7 +1593,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
15931593
</table>
15941594
<hr />
15951595
<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>
1596-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-04</div> </div></div><!-- contents -->
1596+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-05</div> </div></div><!-- contents -->
15971597
</div><!-- PageDoc -->
15981598
</div><!-- doc-content -->
15991599
<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
@@ -991,7 +991,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
991991
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
992992
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
993993
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
994-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-04</div> </div></div><!-- contents -->
994+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-05</div> </div></div><!-- contents -->
995995
</div><!-- PageDoc -->
996996
</div><!-- doc-content -->
997997
<div id="page-nav" class="page-nav-panel">

‎documentation/contributing.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md97"></a>
328328
<li><b><span class="tt">stp</span> vs <span class="tt">wp</span> mixing:</b> In mixed-precision mode, <span class="tt">stp</span> (storage) may be half-precision while <span class="tt">wp</span> (working) is double. Conversions between them must be intentional, especially in MPI pack/unpack and RHS accumulation.</li>
329329
<li><b>No double-precision intrinsics:</b> <span class="tt">dsqrt</span>, <span class="tt">dexp</span>, <span class="tt">dlog</span>, <span class="tt">dble</span>, <span class="tt">dabs</span>, <span class="tt">real(8)</span>, <span class="tt">real(4)</span> are forbidden. Use generic intrinsics with <span class="tt">wp</span> kind.</li>
330330
<li><b>MPI type matching:</b> <span class="tt">mpi_p</span> must match <span class="tt">wp</span>; <span class="tt">mpi_io_p</span> must match <span class="tt">stp</span>. Mismatches corrupt communicated data.</li>
331+
<li><b>Scalars into device routines that loop:</b> a <span class="tt">GPU_ROUTINE</span> containing any <span class="tt">GPU_LOOP</span> (itself or through what it calls) must be called with scalars, never an array element (<span class="tt">q%sf(j,k,l)</span>, <span class="tt">alpha(i)</span>). Copy the element to a local first and receive results into a local. Cray OpenACC 19 to 21 miscompiles the pair silently at every routine level, OpenMP offload does not (<a href="https://github.com/MFlowCode/MFC/issues/1815">#1815</a>); the linter enforces it inside kernels and device routines.</li>
331332
</ul>
332333
<h3 class="doxsection"><a class="anchor" id="autotoc_md98"></a>
333334
Memory and Allocation</h3>

‎documentation/examples.html‎

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

‎documentation/navtreedata.js‎

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

0 commit comments

Comments
 (0)