Skip to content

Commit e9e7a96

Browse files
author
MFC Action
committed
Docs @ 665ba86
1 parent 38aebe5 commit e9e7a96

272 files changed

Lines changed: 25741 additions & 22856 deletions

File tree

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-17</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-18</div> </div></div><!-- contents -->
433433
</div><!-- PageDoc -->
434434
</div><!-- doc-content -->
435435
<div id="page-nav" class="page-nav-panel">

‎documentation/case.html‎

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

‎documentation/case_constraints.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1175,9 +1175,9 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
11751175
<li>Min: 0</li>
11761176
</ul>
11771177
<p><b>Requirements</b> (errors):</p><ul>
1178+
<li>patch_ib(i)kin_model requires a 3D case (p &gt; 0)</li>
11781179
<li>particle_cloud(i)periodic requires positive box lengths in each active dimension</li>
11791180
<li>z_domainbeg must be set when p &gt; 0</li>
1180-
<li>z_domainend must be set when p &gt; 0</li>
11811181
</ul>
11821182
<p><b>Incompatibilities</b> (errors):</p><ul>
11831183
<li>6-equation model (model_eqns = 3) does not support cylindrical coordinates (cyl_coord = T and p != 0)</li>
@@ -1617,7 +1617,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
16171617
</table>
16181618
<hr />
16191619
<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>
1620-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-17</div> </div></div><!-- contents -->
1620+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-18</div> </div></div><!-- contents -->
16211621
</div><!-- PageDoc -->
16221622
</div><!-- doc-content -->
16231623
<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-17</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-18</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 & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
<a href="case.html#sec-computational-domain"/>
6565
<a href="case.html#sec-fluid-materials"/>
6666
<a href="case.html#sec-formatted-output"/>
67+
<a href="case.html#sec-ib-force-history"/>
6768
<a href="case.html#sec-immersed-boundary-patches"/>
6869
<a href="case.html#sec-non-newtonian"/>
6970
<a href="case.html#sec-patches"/>
@@ -364,30 +365,30 @@
364365
<a href="examples.html#autotoc_md316"/>
365366
<a href="examples.html#autotoc_md317"/>
366367
<a href="examples.html#autotoc_md318"/>
368+
<a href="examples.html#autotoc_md319"/>
369+
<a href="examples.html#autotoc_md320"/>
370+
<a href="examples.html#autotoc_md321"/>
371+
<a href="examples.html#autotoc_md322"/>
367372
<a href="expectedPerformance.html"/>
368-
<a href="expectedPerformance.html#autotoc_md319"/>
369-
<a href="expectedPerformance.html#autotoc_md321"/>
370-
<a href="expectedPerformance.html#autotoc_md322"/>
371373
<a href="expectedPerformance.html#autotoc_md323"/>
372-
<a href="expectedPerformance.html#autotoc_md324"/>
373374
<a href="expectedPerformance.html#autotoc_md325"/>
374375
<a href="expectedPerformance.html#autotoc_md326"/>
376+
<a href="expectedPerformance.html#autotoc_md327"/>
375377
<a href="expectedPerformance.html#autotoc_md328"/>
376378
<a href="expectedPerformance.html#autotoc_md329"/>
377379
<a href="expectedPerformance.html#autotoc_md330"/>
378-
<a href="expectedPerformance.html#autotoc_md331"/>
379380
<a href="expectedPerformance.html#autotoc_md332"/>
380381
<a href="expectedPerformance.html#autotoc_md333"/>
381382
<a href="expectedPerformance.html#autotoc_md334"/>
382383
<a href="expectedPerformance.html#autotoc_md335"/>
383384
<a href="expectedPerformance.html#autotoc_md336"/>
384385
<a href="expectedPerformance.html#autotoc_md337"/>
385386
<a href="expectedPerformance.html#autotoc_md338"/>
387+
<a href="expectedPerformance.html#autotoc_md339"/>
388+
<a href="expectedPerformance.html#autotoc_md340"/>
389+
<a href="expectedPerformance.html#autotoc_md341"/>
390+
<a href="expectedPerformance.html#autotoc_md342"/>
386391
<a href="getting-started.html"/>
387-
<a href="getting-started.html#autotoc_md339"/>
388-
<a href="getting-started.html#autotoc_md340"/>
389-
<a href="getting-started.html#autotoc_md341"/>
390-
<a href="getting-started.html#autotoc_md342"/>
391392
<a href="getting-started.html#autotoc_md343"/>
392393
<a href="getting-started.html#autotoc_md344"/>
393394
<a href="getting-started.html#autotoc_md345"/>
@@ -398,20 +399,20 @@
398399
<a href="getting-started.html#autotoc_md350"/>
399400
<a href="getting-started.html#autotoc_md351"/>
400401
<a href="getting-started.html#autotoc_md352"/>
402+
<a href="getting-started.html#autotoc_md353"/>
403+
<a href="getting-started.html#autotoc_md354"/>
404+
<a href="getting-started.html#autotoc_md355"/>
405+
<a href="getting-started.html#autotoc_md356"/>
401406
<a href="gpuParallelization.html"/>
402-
<a href="gpuParallelization.html#autotoc_md353"/>
403-
<a href="gpuParallelization.html#autotoc_md355"/>
404-
<a href="gpuParallelization.html#autotoc_md356"/>
405407
<a href="gpuParallelization.html#autotoc_md357"/>
406408
<a href="gpuParallelization.html#autotoc_md359"/>
409+
<a href="gpuParallelization.html#autotoc_md360"/>
407410
<a href="gpuParallelization.html#autotoc_md361"/>
408411
<a href="gpuParallelization.html#autotoc_md363"/>
409412
<a href="gpuParallelization.html#autotoc_md365"/>
410413
<a href="gpuParallelization.html#autotoc_md367"/>
411414
<a href="gpuParallelization.html#autotoc_md369"/>
412-
<a href="gpuParallelization.html#autotoc_md370"/>
413415
<a href="gpuParallelization.html#autotoc_md371"/>
414-
<a href="gpuParallelization.html#autotoc_md372"/>
415416
<a href="gpuParallelization.html#autotoc_md373"/>
416417
<a href="gpuParallelization.html#autotoc_md374"/>
417418
<a href="gpuParallelization.html#autotoc_md375"/>
@@ -421,28 +422,30 @@
421422
<a href="gpuParallelization.html#autotoc_md379"/>
422423
<a href="gpuParallelization.html#autotoc_md380"/>
423424
<a href="gpuParallelization.html#autotoc_md381"/>
425+
<a href="gpuParallelization.html#autotoc_md382"/>
424426
<a href="gpuParallelization.html#autotoc_md383"/>
427+
<a href="gpuParallelization.html#autotoc_md384"/>
428+
<a href="gpuParallelization.html#autotoc_md385"/>
429+
<a href="gpuParallelization.html#autotoc_md387"/>
425430
<a href="gpuParallelization.html#silent-failure-traps"/>
426431
<a href="graph_legend.html"/>
427432
<a href="index.html"/>
428-
<a href="index.html#autotoc_md519"/>
429-
<a href="index.html#autotoc_md520"/>
430-
<a href="index.html#autotoc_md521"/>
431-
<a href="index.html#autotoc_md522"/>
432433
<a href="index.html#autotoc_md523"/>
433434
<a href="index.html#autotoc_md524"/>
435+
<a href="index.html#autotoc_md525"/>
436+
<a href="index.html#autotoc_md526"/>
437+
<a href="index.html#autotoc_md527"/>
438+
<a href="index.html#autotoc_md528"/>
434439
<a href="pages.html"/>
435440
<a href="papers.html"/>
436-
<a href="papers.html#autotoc_md384"/>
441+
<a href="papers.html#autotoc_md388"/>
437442
<a href="parameters.html"/>
438443
<a href="parameters.html#acoustic"/>
439444
<a href="parameters.html#alpha_rho_e_wrt"/>
440445
<a href="parameters.html#alpha_rho_wrt"/>
441446
<a href="parameters.html#alpha_wrt"/>
442-
<a href="parameters.html#autotoc_md385"/>
443-
<a href="parameters.html#autotoc_md386"/>
444-
<a href="parameters.html#autotoc_md387"/>
445447
<a href="parameters.html#autotoc_md389"/>
448+
<a href="parameters.html#autotoc_md390"/>
446449
<a href="parameters.html#autotoc_md391"/>
447450
<a href="parameters.html#autotoc_md393"/>
448451
<a href="parameters.html#autotoc_md395"/>
@@ -459,17 +462,19 @@
459462
<a href="parameters.html#autotoc_md417"/>
460463
<a href="parameters.html#autotoc_md419"/>
461464
<a href="parameters.html#autotoc_md421"/>
462-
<a href="parameters.html#autotoc_md426"/>
463-
<a href="parameters.html#autotoc_md428"/>
465+
<a href="parameters.html#autotoc_md423"/>
466+
<a href="parameters.html#autotoc_md425"/>
464467
<a href="parameters.html#autotoc_md430"/>
465468
<a href="parameters.html#autotoc_md432"/>
466469
<a href="parameters.html#autotoc_md434"/>
467470
<a href="parameters.html#autotoc_md436"/>
468-
<a href="parameters.html#autotoc_md441"/>
469-
<a href="parameters.html#autotoc_md443"/>
471+
<a href="parameters.html#autotoc_md438"/>
472+
<a href="parameters.html#autotoc_md440"/>
470473
<a href="parameters.html#autotoc_md445"/>
471474
<a href="parameters.html#autotoc_md447"/>
472-
<a href="parameters.html#autotoc_md456"/>
475+
<a href="parameters.html#autotoc_md449"/>
476+
<a href="parameters.html#autotoc_md451"/>
477+
<a href="parameters.html#autotoc_md460"/>
473478
<a href="parameters.html#bc_x"/>
474479
<a href="parameters.html#bc_y"/>
475480
<a href="parameters.html#bc_z"/>
@@ -507,135 +512,131 @@
507512
<a href="parameters.html#z_domain"/>
508513
<a href="parameters.html#z_output"/>
509514
<a href="physics_constraints.html"/>
510-
<a href="physics_constraints.html#autotoc_md457"/>
511-
<a href="physics_constraints.html#autotoc_md459"/>
512-
<a href="physics_constraints.html#autotoc_md460"/>
513515
<a href="physics_constraints.html#autotoc_md461"/>
514-
<a href="physics_constraints.html#autotoc_md462"/>
515516
<a href="physics_constraints.html#autotoc_md463"/>
516517
<a href="physics_constraints.html#autotoc_md464"/>
518+
<a href="physics_constraints.html#autotoc_md465"/>
517519
<a href="physics_constraints.html#autotoc_md466"/>
518520
<a href="physics_constraints.html#autotoc_md467"/>
519521
<a href="physics_constraints.html#autotoc_md468"/>
520522
<a href="physics_constraints.html#autotoc_md470"/>
521523
<a href="physics_constraints.html#autotoc_md471"/>
522524
<a href="physics_constraints.html#autotoc_md472"/>
523-
<a href="physics_constraints.html#autotoc_md473"/>
524525
<a href="physics_constraints.html#autotoc_md474"/>
526+
<a href="physics_constraints.html#autotoc_md475"/>
525527
<a href="physics_constraints.html#autotoc_md476"/>
526528
<a href="physics_constraints.html#autotoc_md477"/>
527-
<a href="physics_constraints.html#autotoc_md479"/>
529+
<a href="physics_constraints.html#autotoc_md478"/>
528530
<a href="physics_constraints.html#autotoc_md480"/>
529-
<a href="physics_constraints.html#autotoc_md482"/>
531+
<a href="physics_constraints.html#autotoc_md481"/>
530532
<a href="physics_constraints.html#autotoc_md483"/>
531533
<a href="physics_constraints.html#autotoc_md484"/>
532534
<a href="physics_constraints.html#autotoc_md486"/>
533535
<a href="physics_constraints.html#autotoc_md487"/>
534536
<a href="physics_constraints.html#autotoc_md488"/>
535-
<a href="physics_constraints.html#autotoc_md489"/>
537+
<a href="physics_constraints.html#autotoc_md490"/>
536538
<a href="physics_constraints.html#autotoc_md491"/>
537539
<a href="physics_constraints.html#autotoc_md492"/>
538540
<a href="physics_constraints.html#autotoc_md493"/>
539-
<a href="physics_constraints.html#autotoc_md494"/>
540541
<a href="physics_constraints.html#autotoc_md495"/>
541542
<a href="physics_constraints.html#autotoc_md496"/>
542543
<a href="physics_constraints.html#autotoc_md497"/>
543544
<a href="physics_constraints.html#autotoc_md498"/>
544545
<a href="physics_constraints.html#autotoc_md499"/>
546+
<a href="physics_constraints.html#autotoc_md500"/>
545547
<a href="physics_constraints.html#autotoc_md501"/>
546548
<a href="physics_constraints.html#autotoc_md502"/>
547549
<a href="physics_constraints.html#autotoc_md503"/>
548-
<a href="physics_constraints.html#autotoc_md504"/>
549550
<a href="physics_constraints.html#autotoc_md505"/>
551+
<a href="physics_constraints.html#autotoc_md506"/>
550552
<a href="physics_constraints.html#autotoc_md507"/>
551553
<a href="physics_constraints.html#autotoc_md508"/>
552-
<a href="physics_constraints.html#autotoc_md510"/>
554+
<a href="physics_constraints.html#autotoc_md509"/>
553555
<a href="physics_constraints.html#autotoc_md511"/>
554556
<a href="physics_constraints.html#autotoc_md512"/>
555557
<a href="physics_constraints.html#autotoc_md514"/>
556558
<a href="physics_constraints.html#autotoc_md515"/>
557-
<a href="physics_constraints.html#autotoc_md517"/>
559+
<a href="physics_constraints.html#autotoc_md516"/>
558560
<a href="physics_constraints.html#autotoc_md518"/>
561+
<a href="physics_constraints.html#autotoc_md519"/>
562+
<a href="physics_constraints.html#autotoc_md521"/>
563+
<a href="physics_constraints.html#autotoc_md522"/>
559564
<a href="running.html"/>
560-
<a href="running.html#autotoc_md525"/>
561-
<a href="running.html#autotoc_md526"/>
562-
<a href="running.html#autotoc_md528"/>
565+
<a href="running.html#autotoc_md529"/>
563566
<a href="running.html#autotoc_md530"/>
564-
<a href="running.html#autotoc_md531"/>
565567
<a href="running.html#autotoc_md532"/>
566-
<a href="running.html#autotoc_md533"/>
567568
<a href="running.html#autotoc_md534"/>
568569
<a href="running.html#autotoc_md535"/>
569570
<a href="running.html#autotoc_md536"/>
570571
<a href="running.html#autotoc_md537"/>
571572
<a href="running.html#autotoc_md538"/>
573+
<a href="running.html#autotoc_md539"/>
572574
<a href="running.html#autotoc_md540"/>
573575
<a href="running.html#autotoc_md541"/>
574576
<a href="running.html#autotoc_md542"/>
575-
<a href="running.html#autotoc_md543"/>
576577
<a href="running.html#autotoc_md544"/>
577578
<a href="running.html#autotoc_md545"/>
579+
<a href="running.html#autotoc_md546"/>
578580
<a href="running.html#autotoc_md547"/>
581+
<a href="running.html#autotoc_md548"/>
579582
<a href="running.html#autotoc_md549"/>
583+
<a href="running.html#autotoc_md551"/>
584+
<a href="running.html#autotoc_md553"/>
580585
<a href="testing.html"/>
581-
<a href="testing.html#autotoc_md550"/>
582-
<a href="testing.html#autotoc_md551"/>
583-
<a href="testing.html#autotoc_md552"/>
586+
<a href="testing.html#autotoc_md554"/>
587+
<a href="testing.html#autotoc_md555"/>
588+
<a href="testing.html#autotoc_md556"/>
584589
<a href="testing.html#selection-and-execution-pitfalls"/>
585590
<a href="troubleshooting.html"/>
586-
<a href="troubleshooting.html#autotoc_md553"/>
587-
<a href="troubleshooting.html#autotoc_md554"/>
588-
<a href="troubleshooting.html#autotoc_md555"/>
589-
<a href="troubleshooting.html#autotoc_md556"/>
590591
<a href="troubleshooting.html#autotoc_md557"/>
592+
<a href="troubleshooting.html#autotoc_md558"/>
591593
<a href="troubleshooting.html#autotoc_md559"/>
592594
<a href="troubleshooting.html#autotoc_md560"/>
593595
<a href="troubleshooting.html#autotoc_md561"/>
594-
<a href="troubleshooting.html#autotoc_md562"/>
596+
<a href="troubleshooting.html#autotoc_md563"/>
595597
<a href="troubleshooting.html#autotoc_md564"/>
596598
<a href="troubleshooting.html#autotoc_md565"/>
597599
<a href="troubleshooting.html#autotoc_md566"/>
598-
<a href="troubleshooting.html#autotoc_md567"/>
599600
<a href="troubleshooting.html#autotoc_md568"/>
600601
<a href="troubleshooting.html#autotoc_md569"/>
602+
<a href="troubleshooting.html#autotoc_md570"/>
601603
<a href="troubleshooting.html#autotoc_md571"/>
602604
<a href="troubleshooting.html#autotoc_md572"/>
603605
<a href="troubleshooting.html#autotoc_md573"/>
604-
<a href="troubleshooting.html#autotoc_md574"/>
605606
<a href="troubleshooting.html#autotoc_md575"/>
607+
<a href="troubleshooting.html#autotoc_md576"/>
606608
<a href="troubleshooting.html#autotoc_md577"/>
607609
<a href="troubleshooting.html#autotoc_md578"/>
608610
<a href="troubleshooting.html#autotoc_md579"/>
609-
<a href="troubleshooting.html#autotoc_md580"/>
610611
<a href="troubleshooting.html#autotoc_md581"/>
611612
<a href="troubleshooting.html#autotoc_md582"/>
613+
<a href="troubleshooting.html#autotoc_md583"/>
612614
<a href="troubleshooting.html#autotoc_md584"/>
613615
<a href="troubleshooting.html#autotoc_md585"/>
614616
<a href="troubleshooting.html#autotoc_md586"/>
615-
<a href="troubleshooting.html#autotoc_md587"/>
617+
<a href="troubleshooting.html#autotoc_md588"/>
616618
<a href="troubleshooting.html#autotoc_md589"/>
617619
<a href="troubleshooting.html#autotoc_md590"/>
618620
<a href="troubleshooting.html#autotoc_md591"/>
619-
<a href="troubleshooting.html#autotoc_md592"/>
620621
<a href="troubleshooting.html#autotoc_md593"/>
621622
<a href="troubleshooting.html#autotoc_md594"/>
623+
<a href="troubleshooting.html#autotoc_md595"/>
622624
<a href="troubleshooting.html#autotoc_md596"/>
623625
<a href="troubleshooting.html#autotoc_md597"/>
624626
<a href="troubleshooting.html#autotoc_md598"/>
625-
<a href="troubleshooting.html#autotoc_md599"/>
626627
<a href="troubleshooting.html#autotoc_md600"/>
628+
<a href="troubleshooting.html#autotoc_md601"/>
627629
<a href="troubleshooting.html#autotoc_md602"/>
628630
<a href="troubleshooting.html#autotoc_md603"/>
629631
<a href="troubleshooting.html#autotoc_md604"/>
630-
<a href="troubleshooting.html#autotoc_md605"/>
631632
<a href="troubleshooting.html#autotoc_md606"/>
633+
<a href="troubleshooting.html#autotoc_md607"/>
632634
<a href="troubleshooting.html#autotoc_md608"/>
635+
<a href="troubleshooting.html#autotoc_md609"/>
636+
<a href="troubleshooting.html#autotoc_md610"/>
637+
<a href="troubleshooting.html#autotoc_md612"/>
633638
<a href="visualization.html"/>
634-
<a href="visualization.html#autotoc_md609"/>
635-
<a href="visualization.html#autotoc_md611"/>
636-
<a href="visualization.html#autotoc_md612"/>
637639
<a href="visualization.html#autotoc_md613"/>
638-
<a href="visualization.html#autotoc_md614"/>
639640
<a href="visualization.html#autotoc_md615"/>
640641
<a href="visualization.html#autotoc_md616"/>
641642
<a href="visualization.html#autotoc_md617"/>
@@ -645,13 +646,17 @@
645646
<a href="visualization.html#autotoc_md621"/>
646647
<a href="visualization.html#autotoc_md622"/>
647648
<a href="visualization.html#autotoc_md623"/>
649+
<a href="visualization.html#autotoc_md624"/>
648650
<a href="visualization.html#autotoc_md625"/>
649651
<a href="visualization.html#autotoc_md626"/>
650652
<a href="visualization.html#autotoc_md627"/>
651-
<a href="visualization.html#autotoc_md628"/>
652653
<a href="visualization.html#autotoc_md629"/>
653654
<a href="visualization.html#autotoc_md630"/>
654655
<a href="visualization.html#autotoc_md631"/>
655656
<a href="visualization.html#autotoc_md632"/>
657+
<a href="visualization.html#autotoc_md633"/>
658+
<a href="visualization.html#autotoc_md634"/>
659+
<a href="visualization.html#autotoc_md635"/>
660+
<a href="visualization.html#autotoc_md636"/>
656661
</body>
657662
</html>

0 commit comments

Comments
 (0)