Skip to content

Commit a031ee9

Browse files
author
MFC Action
committed
Docs @ d4ffa29
1 parent e3f2188 commit a031ee9

67 files changed

Lines changed: 1221 additions & 1196 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-19</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-20</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: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1072,9 +1072,9 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
10721072
<li>Min: 0</li>
10731073
</ul>
10741074
<p><b>Requirements</b> (errors):</p><ul>
1075+
<li>z_domainbeg must be set when p &gt; 0</li>
1076+
<li>z_domainend must be set when p &gt; 0</li>
10751077
<li>down sample requires 3D (p &gt; 0)</li>
1076-
<li>down sample requires p divisible by 3</li>
1077-
<li>stretch_z requires p &gt; 0</li>
10781078
</ul>
10791079
<p><b>Incompatibilities</b> (errors):</p><ul>
10801080
<li>6-equation model (model_eqns = 3) does not support cylindrical coordinates (cyl_coord = T and p != 0)</li>
@@ -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-19</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-20</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
@@ -981,7 +981,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
981981
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
982982
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
983983
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
984-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-19</div> </div></div><!-- contents -->
984+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-20</div> </div></div><!-- contents -->
985985
</div><!-- PageDoc -->
986986
</div><!-- doc-content -->
987987
<div id="page-nav" class="page-nav-panel">

documentation/doxygen_crawl.html

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -414,12 +414,12 @@
414414
<a href="gpuParallelization.html#autotoc_md372"/>
415415
<a href="graph_legend.html"/>
416416
<a href="index.html"/>
417-
<a href="index.html#autotoc_md504"/>
418417
<a href="index.html#autotoc_md505"/>
419418
<a href="index.html#autotoc_md506"/>
420419
<a href="index.html#autotoc_md507"/>
421420
<a href="index.html#autotoc_md508"/>
422421
<a href="index.html#autotoc_md509"/>
422+
<a href="index.html#autotoc_md510"/>
423423
<a href="pages.html"/>
424424
<a href="papers.html"/>
425425
<a href="papers.html#autotoc_md373"/>
@@ -508,17 +508,17 @@
508508
<a href="physics_constraints.html#autotoc_md458"/>
509509
<a href="physics_constraints.html#autotoc_md459"/>
510510
<a href="physics_constraints.html#autotoc_md460"/>
511-
<a href="physics_constraints.html#autotoc_md462"/>
511+
<a href="physics_constraints.html#autotoc_md461"/>
512512
<a href="physics_constraints.html#autotoc_md463"/>
513-
<a href="physics_constraints.html#autotoc_md465"/>
513+
<a href="physics_constraints.html#autotoc_md464"/>
514514
<a href="physics_constraints.html#autotoc_md466"/>
515-
<a href="physics_constraints.html#autotoc_md468"/>
515+
<a href="physics_constraints.html#autotoc_md467"/>
516516
<a href="physics_constraints.html#autotoc_md469"/>
517-
<a href="physics_constraints.html#autotoc_md471"/>
517+
<a href="physics_constraints.html#autotoc_md470"/>
518518
<a href="physics_constraints.html#autotoc_md472"/>
519519
<a href="physics_constraints.html#autotoc_md473"/>
520520
<a href="physics_constraints.html#autotoc_md474"/>
521-
<a href="physics_constraints.html#autotoc_md476"/>
521+
<a href="physics_constraints.html#autotoc_md475"/>
522522
<a href="physics_constraints.html#autotoc_md477"/>
523523
<a href="physics_constraints.html#autotoc_md478"/>
524524
<a href="physics_constraints.html#autotoc_md479"/>
@@ -527,25 +527,25 @@
527527
<a href="physics_constraints.html#autotoc_md482"/>
528528
<a href="physics_constraints.html#autotoc_md483"/>
529529
<a href="physics_constraints.html#autotoc_md484"/>
530-
<a href="physics_constraints.html#autotoc_md486"/>
530+
<a href="physics_constraints.html#autotoc_md485"/>
531531
<a href="physics_constraints.html#autotoc_md487"/>
532532
<a href="physics_constraints.html#autotoc_md488"/>
533533
<a href="physics_constraints.html#autotoc_md489"/>
534534
<a href="physics_constraints.html#autotoc_md490"/>
535-
<a href="physics_constraints.html#autotoc_md492"/>
535+
<a href="physics_constraints.html#autotoc_md491"/>
536536
<a href="physics_constraints.html#autotoc_md493"/>
537-
<a href="physics_constraints.html#autotoc_md495"/>
537+
<a href="physics_constraints.html#autotoc_md494"/>
538538
<a href="physics_constraints.html#autotoc_md496"/>
539539
<a href="physics_constraints.html#autotoc_md497"/>
540-
<a href="physics_constraints.html#autotoc_md499"/>
540+
<a href="physics_constraints.html#autotoc_md498"/>
541541
<a href="physics_constraints.html#autotoc_md500"/>
542-
<a href="physics_constraints.html#autotoc_md502"/>
542+
<a href="physics_constraints.html#autotoc_md501"/>
543543
<a href="physics_constraints.html#autotoc_md503"/>
544+
<a href="physics_constraints.html#autotoc_md504"/>
544545
<a href="running.html"/>
545-
<a href="running.html#autotoc_md510"/>
546546
<a href="running.html#autotoc_md511"/>
547-
<a href="running.html#autotoc_md513"/>
548-
<a href="running.html#autotoc_md515"/>
547+
<a href="running.html#autotoc_md512"/>
548+
<a href="running.html#autotoc_md514"/>
549549
<a href="running.html#autotoc_md516"/>
550550
<a href="running.html#autotoc_md517"/>
551551
<a href="running.html#autotoc_md518"/>
@@ -554,69 +554,69 @@
554554
<a href="running.html#autotoc_md521"/>
555555
<a href="running.html#autotoc_md522"/>
556556
<a href="running.html#autotoc_md523"/>
557-
<a href="running.html#autotoc_md525"/>
557+
<a href="running.html#autotoc_md524"/>
558558
<a href="running.html#autotoc_md526"/>
559559
<a href="running.html#autotoc_md527"/>
560560
<a href="running.html#autotoc_md528"/>
561561
<a href="running.html#autotoc_md529"/>
562562
<a href="running.html#autotoc_md530"/>
563-
<a href="running.html#autotoc_md532"/>
564-
<a href="running.html#autotoc_md534"/>
563+
<a href="running.html#autotoc_md531"/>
564+
<a href="running.html#autotoc_md533"/>
565+
<a href="running.html#autotoc_md535"/>
565566
<a href="testing.html"/>
566-
<a href="testing.html#autotoc_md535"/>
567567
<a href="testing.html#autotoc_md536"/>
568568
<a href="testing.html#autotoc_md537"/>
569+
<a href="testing.html#autotoc_md538"/>
569570
<a href="troubleshooting.html"/>
570-
<a href="troubleshooting.html#autotoc_md538"/>
571571
<a href="troubleshooting.html#autotoc_md539"/>
572572
<a href="troubleshooting.html#autotoc_md540"/>
573573
<a href="troubleshooting.html#autotoc_md541"/>
574574
<a href="troubleshooting.html#autotoc_md542"/>
575-
<a href="troubleshooting.html#autotoc_md544"/>
575+
<a href="troubleshooting.html#autotoc_md543"/>
576576
<a href="troubleshooting.html#autotoc_md545"/>
577577
<a href="troubleshooting.html#autotoc_md546"/>
578578
<a href="troubleshooting.html#autotoc_md547"/>
579-
<a href="troubleshooting.html#autotoc_md549"/>
579+
<a href="troubleshooting.html#autotoc_md548"/>
580580
<a href="troubleshooting.html#autotoc_md550"/>
581581
<a href="troubleshooting.html#autotoc_md551"/>
582582
<a href="troubleshooting.html#autotoc_md552"/>
583583
<a href="troubleshooting.html#autotoc_md553"/>
584584
<a href="troubleshooting.html#autotoc_md554"/>
585-
<a href="troubleshooting.html#autotoc_md556"/>
585+
<a href="troubleshooting.html#autotoc_md555"/>
586586
<a href="troubleshooting.html#autotoc_md557"/>
587587
<a href="troubleshooting.html#autotoc_md558"/>
588588
<a href="troubleshooting.html#autotoc_md559"/>
589589
<a href="troubleshooting.html#autotoc_md560"/>
590-
<a href="troubleshooting.html#autotoc_md562"/>
590+
<a href="troubleshooting.html#autotoc_md561"/>
591591
<a href="troubleshooting.html#autotoc_md563"/>
592592
<a href="troubleshooting.html#autotoc_md564"/>
593593
<a href="troubleshooting.html#autotoc_md565"/>
594594
<a href="troubleshooting.html#autotoc_md566"/>
595595
<a href="troubleshooting.html#autotoc_md567"/>
596-
<a href="troubleshooting.html#autotoc_md569"/>
596+
<a href="troubleshooting.html#autotoc_md568"/>
597597
<a href="troubleshooting.html#autotoc_md570"/>
598598
<a href="troubleshooting.html#autotoc_md571"/>
599599
<a href="troubleshooting.html#autotoc_md572"/>
600-
<a href="troubleshooting.html#autotoc_md574"/>
600+
<a href="troubleshooting.html#autotoc_md573"/>
601601
<a href="troubleshooting.html#autotoc_md575"/>
602602
<a href="troubleshooting.html#autotoc_md576"/>
603603
<a href="troubleshooting.html#autotoc_md577"/>
604604
<a href="troubleshooting.html#autotoc_md578"/>
605605
<a href="troubleshooting.html#autotoc_md579"/>
606-
<a href="troubleshooting.html#autotoc_md581"/>
606+
<a href="troubleshooting.html#autotoc_md580"/>
607607
<a href="troubleshooting.html#autotoc_md582"/>
608608
<a href="troubleshooting.html#autotoc_md583"/>
609609
<a href="troubleshooting.html#autotoc_md584"/>
610610
<a href="troubleshooting.html#autotoc_md585"/>
611-
<a href="troubleshooting.html#autotoc_md587"/>
611+
<a href="troubleshooting.html#autotoc_md586"/>
612612
<a href="troubleshooting.html#autotoc_md588"/>
613613
<a href="troubleshooting.html#autotoc_md589"/>
614614
<a href="troubleshooting.html#autotoc_md590"/>
615615
<a href="troubleshooting.html#autotoc_md591"/>
616-
<a href="troubleshooting.html#autotoc_md593"/>
616+
<a href="troubleshooting.html#autotoc_md592"/>
617+
<a href="troubleshooting.html#autotoc_md594"/>
617618
<a href="visualization.html"/>
618-
<a href="visualization.html#autotoc_md594"/>
619-
<a href="visualization.html#autotoc_md596"/>
619+
<a href="visualization.html#autotoc_md595"/>
620620
<a href="visualization.html#autotoc_md597"/>
621621
<a href="visualization.html#autotoc_md598"/>
622622
<a href="visualization.html#autotoc_md599"/>
@@ -629,13 +629,14 @@
629629
<a href="visualization.html#autotoc_md606"/>
630630
<a href="visualization.html#autotoc_md607"/>
631631
<a href="visualization.html#autotoc_md608"/>
632-
<a href="visualization.html#autotoc_md610"/>
632+
<a href="visualization.html#autotoc_md609"/>
633633
<a href="visualization.html#autotoc_md611"/>
634634
<a href="visualization.html#autotoc_md612"/>
635635
<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"/>
640+
<a href="visualization.html#autotoc_md618"/>
640641
</body>
641642
</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-19</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-20</div> </div></div><!-- contents -->
634634
</div><!-- PageDoc -->
635635
</div><!-- doc-content -->
636636
<div id="page-nav" class="page-nav-panel">

documentation/index.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,15 +158,15 @@
158158
</div><!--header-->
159159
<div class="contents">
160160
<div class="textblock"><p>Welcome to the Multi-component Flow Code (MFC) documentation.</p>
161-
<h2 class="doxsection"><a class="anchor" id="autotoc_md504"></a>
161+
<h2 class="doxsection"><a class="anchor" id="autotoc_md505"></a>
162162
Getting Started</h2>
163163
<ul>
164164
<li><a class="el" href="getting-started.html" title="Getting Started">Getting Started</a> - Installation and first steps</li>
165165
<li><a class="el" href="running.html" title="Running">Running</a> - How to run simulations (interactive, batch, GPU)</li>
166166
<li><a class="el" href="case.html" title="Case Files">Case Files</a> - Setting up input files</li>
167167
<li><a class="el" href="testing.html" title="Testing">Testing</a> - Running the test suite</li>
168168
</ul>
169-
<h2 class="doxsection"><a class="anchor" id="autotoc_md505"></a>
169+
<h2 class="doxsection"><a class="anchor" id="autotoc_md506"></a>
170170
Reference</h2>
171171
<ul>
172172
<li><a class="el" href="equations.html" title="Equations">Equations</a> - Comprehensive equations reference</li>
@@ -175,13 +175,13 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md505"></a>
175175
<li><a class="el" href="case_constraints.html" title="Case Creator Guide">Case Creator Guide</a> - Feature compatibility</li>
176176
<li><a class="el" href="physics_constraints.html" title="Physics Constraints">Physics Constraints</a> - Mathematical basis for validation rules</li>
177177
</ul>
178-
<h2 class="doxsection"><a class="anchor" id="autotoc_md506"></a>
178+
<h2 class="doxsection"><a class="anchor" id="autotoc_md507"></a>
179179
Examples &amp; Visualization</h2>
180180
<ul>
181181
<li><a class="el" href="examples.html" title="Example Cases">Example Cases</a> - Sample simulations</li>
182182
<li><a class="el" href="visualization.html" title="Flow visualization">Flow Visualization</a> - Post-processing</li>
183183
</ul>
184-
<h2 class="doxsection"><a class="anchor" id="autotoc_md507"></a>
184+
<h2 class="doxsection"><a class="anchor" id="autotoc_md508"></a>
185185
Advanced Topics</h2>
186186
<ul>
187187
<li><a class="el" href="architecture.html" title="Code Architecture">Code Architecture</a> - How the source code is organized, data flow, and module map</li>
@@ -190,13 +190,13 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md507"></a>
190190
<li><a class="el" href="docker.html" title="Containers">Containers</a> - Docker usage</li>
191191
<li><a class="el" href="troubleshooting.html" title="Troubleshooting Guide">Troubleshooting</a> - Debugging and common issues</li>
192192
</ul>
193-
<h2 class="doxsection"><a class="anchor" id="autotoc_md508"></a>
193+
<h2 class="doxsection"><a class="anchor" id="autotoc_md509"></a>
194194
Development</h2>
195195
<ul>
196196
<li><a class="el" href="contributing.html" title="Contributing">Contributing</a> - Developer guide and coding standards</li>
197197
<li><a href="../api/index.html">API Documentation</a> - Source code reference for all three components</li>
198198
</ul>
199-
<h2 class="doxsection"><a class="anchor" id="autotoc_md509"></a>
199+
<h2 class="doxsection"><a class="anchor" id="autotoc_md510"></a>
200200
About</h2>
201201
<ul>
202202
<li><a class="el" href="papers.html" title="Papers">Papers</a> - Publications using MFC</li>

0 commit comments

Comments
 (0)