Skip to content

Commit 6c8a07d

Browse files
author
MFC Action
committed
Docs @ fbb3de2
1 parent 0da0741 commit 6c8a07d

72 files changed

Lines changed: 2191 additions & 2123 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-08-28</div> </div></div><!-- contents -->
432+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-29</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
@@ -1500,7 +1500,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
15001500
</table>
15011501
<hr />
15021502
<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>
1503-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-28</div> </div></div><!-- contents -->
1503+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-29</div> </div></div><!-- contents -->
15041504
</div><!-- PageDoc -->
15051505
</div><!-- doc-content -->
15061506
<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-08-28</div> </div></div><!-- contents -->
994+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-29</div> </div></div><!-- contents -->
995995
</div><!-- PageDoc -->
996996
</div><!-- doc-content -->
997997
<div id="page-nav" class="page-nav-panel">

‎documentation/doxygen_crawl.html‎

Lines changed: 70 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -412,53 +412,56 @@
412412
<a href="gpuParallelization.html#autotoc_md370"/>
413413
<a href="gpuParallelization.html#autotoc_md371"/>
414414
<a href="gpuParallelization.html#autotoc_md372"/>
415+
<a href="gpuParallelization.html#autotoc_md373"/>
416+
<a href="gpuParallelization.html#autotoc_md374"/>
417+
<a href="gpuParallelization.html#autotoc_md375"/>
415418
<a href="graph_legend.html"/>
416419
<a href="index.html"/>
417-
<a href="index.html#autotoc_md505"/>
418-
<a href="index.html#autotoc_md506"/>
419-
<a href="index.html#autotoc_md507"/>
420420
<a href="index.html#autotoc_md508"/>
421421
<a href="index.html#autotoc_md509"/>
422422
<a href="index.html#autotoc_md510"/>
423+
<a href="index.html#autotoc_md511"/>
424+
<a href="index.html#autotoc_md512"/>
425+
<a href="index.html#autotoc_md513"/>
423426
<a href="pages.html"/>
424427
<a href="papers.html"/>
425-
<a href="papers.html#autotoc_md373"/>
428+
<a href="papers.html#autotoc_md376"/>
426429
<a href="parameters.html"/>
427430
<a href="parameters.html#acoustic"/>
428431
<a href="parameters.html#alpha_rho_e_wrt"/>
429432
<a href="parameters.html#alpha_rho_wrt"/>
430433
<a href="parameters.html#alpha_wrt"/>
431-
<a href="parameters.html#autotoc_md374"/>
432-
<a href="parameters.html#autotoc_md375"/>
433-
<a href="parameters.html#autotoc_md376"/>
434+
<a href="parameters.html#autotoc_md377"/>
434435
<a href="parameters.html#autotoc_md378"/>
435-
<a href="parameters.html#autotoc_md380"/>
436-
<a href="parameters.html#autotoc_md382"/>
437-
<a href="parameters.html#autotoc_md384"/>
438-
<a href="parameters.html#autotoc_md386"/>
439-
<a href="parameters.html#autotoc_md388"/>
440-
<a href="parameters.html#autotoc_md390"/>
441-
<a href="parameters.html#autotoc_md392"/>
442-
<a href="parameters.html#autotoc_md394"/>
443-
<a href="parameters.html#autotoc_md396"/>
444-
<a href="parameters.html#autotoc_md398"/>
445-
<a href="parameters.html#autotoc_md400"/>
446-
<a href="parameters.html#autotoc_md402"/>
447-
<a href="parameters.html#autotoc_md404"/>
448-
<a href="parameters.html#autotoc_md406"/>
449-
<a href="parameters.html#autotoc_md408"/>
450-
<a href="parameters.html#autotoc_md410"/>
451-
<a href="parameters.html#autotoc_md415"/>
452-
<a href="parameters.html#autotoc_md417"/>
453-
<a href="parameters.html#autotoc_md419"/>
454-
<a href="parameters.html#autotoc_md421"/>
455-
<a href="parameters.html#autotoc_md423"/>
456-
<a href="parameters.html#autotoc_md425"/>
457-
<a href="parameters.html#autotoc_md430"/>
458-
<a href="parameters.html#autotoc_md432"/>
459-
<a href="parameters.html#autotoc_md434"/>
460-
<a href="parameters.html#autotoc_md436"/>
461-
<a href="parameters.html#autotoc_md445"/>
436+
<a href="parameters.html#autotoc_md379"/>
437+
<a href="parameters.html#autotoc_md381"/>
438+
<a href="parameters.html#autotoc_md383"/>
439+
<a href="parameters.html#autotoc_md385"/>
440+
<a href="parameters.html#autotoc_md387"/>
441+
<a href="parameters.html#autotoc_md389"/>
442+
<a href="parameters.html#autotoc_md391"/>
443+
<a href="parameters.html#autotoc_md393"/>
444+
<a href="parameters.html#autotoc_md395"/>
445+
<a href="parameters.html#autotoc_md397"/>
446+
<a href="parameters.html#autotoc_md399"/>
447+
<a href="parameters.html#autotoc_md401"/>
448+
<a href="parameters.html#autotoc_md403"/>
449+
<a href="parameters.html#autotoc_md405"/>
450+
<a href="parameters.html#autotoc_md407"/>
451+
<a href="parameters.html#autotoc_md409"/>
452+
<a href="parameters.html#autotoc_md411"/>
453+
<a href="parameters.html#autotoc_md413"/>
454+
<a href="parameters.html#autotoc_md418"/>
455+
<a href="parameters.html#autotoc_md420"/>
456+
<a href="parameters.html#autotoc_md422"/>
457+
<a href="parameters.html#autotoc_md424"/>
458+
<a href="parameters.html#autotoc_md426"/>
459+
<a href="parameters.html#autotoc_md428"/>
460+
<a href="parameters.html#autotoc_md433"/>
461+
<a href="parameters.html#autotoc_md435"/>
462+
<a href="parameters.html#autotoc_md437"/>
463+
<a href="parameters.html#autotoc_md439"/>
464+
<a href="parameters.html#autotoc_md448"/>
462465
<a href="parameters.html#bc_x"/>
463466
<a href="parameters.html#bc_y"/>
464467
<a href="parameters.html#bc_z"/>
@@ -496,19 +499,17 @@
496499
<a href="parameters.html#z_domain"/>
497500
<a href="parameters.html#z_output"/>
498501
<a href="physics_constraints.html"/>
499-
<a href="physics_constraints.html#autotoc_md446"/>
500-
<a href="physics_constraints.html#autotoc_md448"/>
501502
<a href="physics_constraints.html#autotoc_md449"/>
502-
<a href="physics_constraints.html#autotoc_md450"/>
503503
<a href="physics_constraints.html#autotoc_md451"/>
504+
<a href="physics_constraints.html#autotoc_md452"/>
504505
<a href="physics_constraints.html#autotoc_md453"/>
505506
<a href="physics_constraints.html#autotoc_md454"/>
506-
<a href="physics_constraints.html#autotoc_md455"/>
507+
<a href="physics_constraints.html#autotoc_md456"/>
507508
<a href="physics_constraints.html#autotoc_md457"/>
508509
<a href="physics_constraints.html#autotoc_md458"/>
509-
<a href="physics_constraints.html#autotoc_md459"/>
510510
<a href="physics_constraints.html#autotoc_md460"/>
511511
<a href="physics_constraints.html#autotoc_md461"/>
512+
<a href="physics_constraints.html#autotoc_md462"/>
512513
<a href="physics_constraints.html#autotoc_md463"/>
513514
<a href="physics_constraints.html#autotoc_md464"/>
514515
<a href="physics_constraints.html#autotoc_md466"/>
@@ -517,109 +518,108 @@
517518
<a href="physics_constraints.html#autotoc_md470"/>
518519
<a href="physics_constraints.html#autotoc_md472"/>
519520
<a href="physics_constraints.html#autotoc_md473"/>
520-
<a href="physics_constraints.html#autotoc_md474"/>
521521
<a href="physics_constraints.html#autotoc_md475"/>
522+
<a href="physics_constraints.html#autotoc_md476"/>
522523
<a href="physics_constraints.html#autotoc_md477"/>
523524
<a href="physics_constraints.html#autotoc_md478"/>
524-
<a href="physics_constraints.html#autotoc_md479"/>
525525
<a href="physics_constraints.html#autotoc_md480"/>
526526
<a href="physics_constraints.html#autotoc_md481"/>
527527
<a href="physics_constraints.html#autotoc_md482"/>
528528
<a href="physics_constraints.html#autotoc_md483"/>
529529
<a href="physics_constraints.html#autotoc_md484"/>
530530
<a href="physics_constraints.html#autotoc_md485"/>
531+
<a href="physics_constraints.html#autotoc_md486"/>
531532
<a href="physics_constraints.html#autotoc_md487"/>
532533
<a href="physics_constraints.html#autotoc_md488"/>
533-
<a href="physics_constraints.html#autotoc_md489"/>
534534
<a href="physics_constraints.html#autotoc_md490"/>
535535
<a href="physics_constraints.html#autotoc_md491"/>
536+
<a href="physics_constraints.html#autotoc_md492"/>
536537
<a href="physics_constraints.html#autotoc_md493"/>
537538
<a href="physics_constraints.html#autotoc_md494"/>
538539
<a href="physics_constraints.html#autotoc_md496"/>
539540
<a href="physics_constraints.html#autotoc_md497"/>
540-
<a href="physics_constraints.html#autotoc_md498"/>
541+
<a href="physics_constraints.html#autotoc_md499"/>
541542
<a href="physics_constraints.html#autotoc_md500"/>
542543
<a href="physics_constraints.html#autotoc_md501"/>
543544
<a href="physics_constraints.html#autotoc_md503"/>
544545
<a href="physics_constraints.html#autotoc_md504"/>
546+
<a href="physics_constraints.html#autotoc_md506"/>
547+
<a href="physics_constraints.html#autotoc_md507"/>
545548
<a href="running.html"/>
546-
<a href="running.html#autotoc_md511"/>
547-
<a href="running.html#autotoc_md512"/>
548549
<a href="running.html#autotoc_md514"/>
549-
<a href="running.html#autotoc_md516"/>
550+
<a href="running.html#autotoc_md515"/>
550551
<a href="running.html#autotoc_md517"/>
551-
<a href="running.html#autotoc_md518"/>
552552
<a href="running.html#autotoc_md519"/>
553553
<a href="running.html#autotoc_md520"/>
554554
<a href="running.html#autotoc_md521"/>
555555
<a href="running.html#autotoc_md522"/>
556556
<a href="running.html#autotoc_md523"/>
557557
<a href="running.html#autotoc_md524"/>
558+
<a href="running.html#autotoc_md525"/>
558559
<a href="running.html#autotoc_md526"/>
559560
<a href="running.html#autotoc_md527"/>
560-
<a href="running.html#autotoc_md528"/>
561561
<a href="running.html#autotoc_md529"/>
562562
<a href="running.html#autotoc_md530"/>
563563
<a href="running.html#autotoc_md531"/>
564+
<a href="running.html#autotoc_md532"/>
564565
<a href="running.html#autotoc_md533"/>
565-
<a href="running.html#autotoc_md535"/>
566+
<a href="running.html#autotoc_md534"/>
567+
<a href="running.html#autotoc_md536"/>
568+
<a href="running.html#autotoc_md538"/>
566569
<a href="testing.html"/>
567-
<a href="testing.html#autotoc_md536"/>
568-
<a href="testing.html#autotoc_md537"/>
569-
<a href="testing.html#autotoc_md538"/>
570+
<a href="testing.html#autotoc_md539"/>
571+
<a href="testing.html#autotoc_md540"/>
572+
<a href="testing.html#autotoc_md541"/>
570573
<a href="troubleshooting.html"/>
571-
<a href="troubleshooting.html#autotoc_md539"/>
572-
<a href="troubleshooting.html#autotoc_md540"/>
573-
<a href="troubleshooting.html#autotoc_md541"/>
574574
<a href="troubleshooting.html#autotoc_md542"/>
575575
<a href="troubleshooting.html#autotoc_md543"/>
576+
<a href="troubleshooting.html#autotoc_md544"/>
576577
<a href="troubleshooting.html#autotoc_md545"/>
577578
<a href="troubleshooting.html#autotoc_md546"/>
578-
<a href="troubleshooting.html#autotoc_md547"/>
579579
<a href="troubleshooting.html#autotoc_md548"/>
580+
<a href="troubleshooting.html#autotoc_md549"/>
580581
<a href="troubleshooting.html#autotoc_md550"/>
581582
<a href="troubleshooting.html#autotoc_md551"/>
582-
<a href="troubleshooting.html#autotoc_md552"/>
583583
<a href="troubleshooting.html#autotoc_md553"/>
584584
<a href="troubleshooting.html#autotoc_md554"/>
585585
<a href="troubleshooting.html#autotoc_md555"/>
586+
<a href="troubleshooting.html#autotoc_md556"/>
586587
<a href="troubleshooting.html#autotoc_md557"/>
587588
<a href="troubleshooting.html#autotoc_md558"/>
588-
<a href="troubleshooting.html#autotoc_md559"/>
589589
<a href="troubleshooting.html#autotoc_md560"/>
590590
<a href="troubleshooting.html#autotoc_md561"/>
591+
<a href="troubleshooting.html#autotoc_md562"/>
591592
<a href="troubleshooting.html#autotoc_md563"/>
592593
<a href="troubleshooting.html#autotoc_md564"/>
593-
<a href="troubleshooting.html#autotoc_md565"/>
594594
<a href="troubleshooting.html#autotoc_md566"/>
595595
<a href="troubleshooting.html#autotoc_md567"/>
596596
<a href="troubleshooting.html#autotoc_md568"/>
597+
<a href="troubleshooting.html#autotoc_md569"/>
597598
<a href="troubleshooting.html#autotoc_md570"/>
598599
<a href="troubleshooting.html#autotoc_md571"/>
599-
<a href="troubleshooting.html#autotoc_md572"/>
600600
<a href="troubleshooting.html#autotoc_md573"/>
601+
<a href="troubleshooting.html#autotoc_md574"/>
601602
<a href="troubleshooting.html#autotoc_md575"/>
602603
<a href="troubleshooting.html#autotoc_md576"/>
603-
<a href="troubleshooting.html#autotoc_md577"/>
604604
<a href="troubleshooting.html#autotoc_md578"/>
605605
<a href="troubleshooting.html#autotoc_md579"/>
606606
<a href="troubleshooting.html#autotoc_md580"/>
607+
<a href="troubleshooting.html#autotoc_md581"/>
607608
<a href="troubleshooting.html#autotoc_md582"/>
608609
<a href="troubleshooting.html#autotoc_md583"/>
609-
<a href="troubleshooting.html#autotoc_md584"/>
610610
<a href="troubleshooting.html#autotoc_md585"/>
611611
<a href="troubleshooting.html#autotoc_md586"/>
612+
<a href="troubleshooting.html#autotoc_md587"/>
612613
<a href="troubleshooting.html#autotoc_md588"/>
613614
<a href="troubleshooting.html#autotoc_md589"/>
614-
<a href="troubleshooting.html#autotoc_md590"/>
615615
<a href="troubleshooting.html#autotoc_md591"/>
616616
<a href="troubleshooting.html#autotoc_md592"/>
617+
<a href="troubleshooting.html#autotoc_md593"/>
617618
<a href="troubleshooting.html#autotoc_md594"/>
619+
<a href="troubleshooting.html#autotoc_md595"/>
620+
<a href="troubleshooting.html#autotoc_md597"/>
618621
<a href="visualization.html"/>
619-
<a href="visualization.html#autotoc_md595"/>
620-
<a href="visualization.html#autotoc_md597"/>
621622
<a href="visualization.html#autotoc_md598"/>
622-
<a href="visualization.html#autotoc_md599"/>
623623
<a href="visualization.html#autotoc_md600"/>
624624
<a href="visualization.html#autotoc_md601"/>
625625
<a href="visualization.html#autotoc_md602"/>
@@ -630,13 +630,16 @@
630630
<a href="visualization.html#autotoc_md607"/>
631631
<a href="visualization.html#autotoc_md608"/>
632632
<a href="visualization.html#autotoc_md609"/>
633+
<a href="visualization.html#autotoc_md610"/>
633634
<a href="visualization.html#autotoc_md611"/>
634635
<a href="visualization.html#autotoc_md612"/>
635-
<a href="visualization.html#autotoc_md613"/>
636636
<a href="visualization.html#autotoc_md614"/>
637637
<a href="visualization.html#autotoc_md615"/>
638638
<a href="visualization.html#autotoc_md616"/>
639639
<a href="visualization.html#autotoc_md617"/>
640640
<a href="visualization.html#autotoc_md618"/>
641+
<a href="visualization.html#autotoc_md619"/>
642+
<a href="visualization.html#autotoc_md620"/>
643+
<a href="visualization.html#autotoc_md621"/>
641644
</body>
642645
</html>

‎documentation/examples.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_md311"></a>
630630
<ul>
631631
<li>Papanastasiou, T. C. (1987). Flows of materials with yield. <em>J. Rheol.</em> 31, 385.</li>
632632
</ul>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-28</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-29</div> </div></div><!-- contents -->
634634
</div><!-- PageDoc -->
635635
</div><!-- doc-content -->
636636
<div id="page-nav" class="page-nav-panel">

‎documentation/gpuParallelization.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -939,6 +939,20 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md371"></a>
939939
<li>The backend is invoked with the <span class="tt">LIBOMPTARGET_JIT_OPT_LEVEL</span> flag.</li>
940940
</ul>
941941
<h2 class="doxsection"><a class="anchor" id="autotoc_md372"></a>
942+
AMD flang (amdflang) Known Issues</h2>
943+
<h3 class="doxsection"><a class="anchor" id="autotoc_md373"></a>
944+
Whole-image device codegen instability (worked around in the build)</h3>
945+
<p>amdflang generates device code for the whole image at link time. Once the image carries enough OpenMP target regions, the device link's <span class="tt">Attributor</span> pass exceeds its <span class="tt">AAPointerInfo</span> access cap on a heavily shared object; pointer information goes pessimistic and <span class="tt">OpenMPOpt</span>'s <span class="tt">__kmpc_parallel</span> cleanup then fails for the whole module. The visible effect: adding (or removing) ANY kernel anywhere silently regenerates UNTOUCHED kernels with far worse ISA — measured 2.4-4.5x slower, with register spills and an extra 512 B of LDS in every kernel. A wall-time A/B between two commits that differ in target-region count is confounded by this whole-image effect.</p>
946+
<p>MFC's build raises the cap (<span class="tt">-attributor-max-pi-accesses=16384</span>, passed to the offload linker in <span class="tt">cmake/MFCTargets.cmake</span>), which restores full pointer precision for the whole image and makes kernel quality independent of unrelated edits. The cost is a longer device link. If a build's device link is unexpectedly slow, this flag is why — do not remove it; kernel performance becomes nondeterministic across commits without it.</p>
947+
<p>The failure signature without the flag: after adding a kernel, unrelated kernels' resource usage shifts image-wide (uniform LDS increase, scratch/spill jumps visible in <span class="tt">rocprofv3</span> dispatch records) and previously fast kernels slow several-fold.</p>
948+
<h3 class="doxsection"><a class="anchor" id="autotoc_md374"></a>
949+
Target regions inside Fortran BLOCK constructs are silently dropped</h3>
950+
<p>A <span class="tt">GPU_PARALLEL_LOOP</span> (OpenMP target region) written inside a Fortran <span class="tt">block ...
951+
end block</span> construct compiles cleanly, but amdflang omits it from the device image while the host still registers it. The first launch aborts with </p><pre class="fragment">hsa_executable_get_symbol_by_name(__omp_offloading_..._l&lt;line&gt;.kd):
952+
HSA_STATUS_ERROR_INVALID_SYMBOL_NAME
953+
omptarget error: Failed to load kernel ...
954+
</pre><p>followed by a segmentation fault. Never place a GPU kernel inside a <span class="tt">block</span> construct; hoist it into its own (module) subroutine with the locals passed as arguments.</p>
955+
<h2 class="doxsection"><a class="anchor" id="autotoc_md375"></a>
942956
Compiler Documentation</h2>
943957
<ul>
944958
<li><a href="https://cpe.ext.hpe.com/docs/24.11/cce/man7/intro_openmp.7.html#environment-variables">Cray &amp; OpenMP Docs</a></li>

0 commit comments

Comments
 (0)