Skip to content

Commit d3e35bb

Browse files
author
MFC Action
committed
Docs @ b7d7883
1 parent 699a3c9 commit d3e35bb

565 files changed

Lines changed: 26309 additions & 26445 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-08-16</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-17</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: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -877,10 +877,6 @@ <h3 class="doxsection"><a class="anchor" id="sec-formatted-output"></a>
877877
<tr class="markdownTableRowOdd">
878878
<td class="markdownTableBodyRight"><span class="tt">sim_data</span> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Write interface and energy data files (post_process) </td></tr>
879879
<tr class="markdownTableRowEven">
880-
<td class="markdownTableBodyRight"><span class="tt">integral_wrt</span> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Write integral data </td></tr>
881-
<tr class="markdownTableRowOdd">
882-
<td class="markdownTableBodyRight"><span class="tt">num_integrals</span> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Number of integral regions </td></tr>
883-
<tr class="markdownTableRowEven">
884880
<td class="markdownTableBodyRight"><span class="tt">down_sample</span> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Enable output downsampling </td></tr>
885881
<tr class="markdownTableRowOdd">
886882
<td class="markdownTableBodyRight"><span class="tt">fd_order</span> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Order of finite differences for computing the vorticity and the numerical Schlieren function [1,2,4] </td></tr>

documentation/case_constraints.html

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -871,19 +871,6 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
871871
</details>
872872
<details >
873873
<summary >
874-
<b>integral_wrt</b> (<span class="tt">integral_wrt</span>)</summary>
875-
<p></p>
876-
<p><b>Dependencies:</b></p><ul>
877-
<li>When enabled, requires: <span class="tt">fd_order</span></li>
878-
</ul>
879-
<p><b>Requirements</b> (errors):</p><ul>
880-
<li>fd_order must be specified for integral_wrt</li>
881-
<li>integral_wrt requires bubbles_euler to be enabled</li>
882-
</ul>
883-
<p></p>
884-
</details>
885-
<details >
886-
<summary >
887874
<b>m</b> (<span class="tt">m</span>)</summary>
888875
<p></p>
889876
<p><b>Schema constraints:</b></p><ul>
@@ -1035,15 +1022,6 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
10351022
</details>
10361023
<details >
10371024
<summary >
1038-
<b>num_integrals</b> (<span class="tt">num_integrals</span>)</summary>
1039-
<p></p>
1040-
<p><b>Schema constraints:</b></p><ul>
1041-
<li>Min: 1</li>
1042-
</ul>
1043-
<p></p>
1044-
</details>
1045-
<details >
1046-
<summary >
10471025
<b>num_patches</b> (<span class="tt">num_patches</span>)</summary>
10481026
<p></p>
10491027
<p><b>Schema constraints:</b></p><ul>
@@ -1516,7 +1494,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
15161494
</table>
15171495
<hr />
15181496
<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>
1519-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-16</div> </div></div><!-- contents -->
1497+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-17</div> </div></div><!-- contents -->
15201498
</div><!-- PageDoc -->
15211499
</div><!-- doc-content -->
15221500
<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
@@ -999,7 +999,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md82"></a>
999999
<h3 class="doxsection"><a class="anchor" id="autotoc_md83"></a>
10001000
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
10011001
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
1002-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-16</div> </div></div><!-- contents -->
1002+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-17</div> </div></div><!-- contents -->
10031003
</div><!-- PageDoc -->
10041004
</div><!-- doc-content -->
10051005
<div id="page-nav" class="page-nav-panel">

documentation/doxygen_crawl.html

Lines changed: 38 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -416,12 +416,12 @@
416416
<a href="gpuParallelization.html#autotoc_md374"/>
417417
<a href="graph_legend.html"/>
418418
<a href="index.html"/>
419+
<a href="index.html#autotoc_md505"/>
420+
<a href="index.html#autotoc_md506"/>
419421
<a href="index.html#autotoc_md507"/>
420422
<a href="index.html#autotoc_md508"/>
421423
<a href="index.html#autotoc_md509"/>
422424
<a href="index.html#autotoc_md510"/>
423-
<a href="index.html#autotoc_md511"/>
424-
<a href="index.html#autotoc_md512"/>
425425
<a href="pages.html"/>
426426
<a href="papers.html"/>
427427
<a href="papers.html#autotoc_md375"/>
@@ -450,18 +450,17 @@
450450
<a href="parameters.html#autotoc_md408"/>
451451
<a href="parameters.html#autotoc_md410"/>
452452
<a href="parameters.html#autotoc_md412"/>
453-
<a href="parameters.html#autotoc_md414"/>
453+
<a href="parameters.html#autotoc_md417"/>
454454
<a href="parameters.html#autotoc_md419"/>
455455
<a href="parameters.html#autotoc_md421"/>
456456
<a href="parameters.html#autotoc_md423"/>
457457
<a href="parameters.html#autotoc_md425"/>
458458
<a href="parameters.html#autotoc_md427"/>
459-
<a href="parameters.html#autotoc_md429"/>
459+
<a href="parameters.html#autotoc_md432"/>
460460
<a href="parameters.html#autotoc_md434"/>
461461
<a href="parameters.html#autotoc_md436"/>
462462
<a href="parameters.html#autotoc_md438"/>
463-
<a href="parameters.html#autotoc_md440"/>
464-
<a href="parameters.html#autotoc_md449"/>
463+
<a href="parameters.html#autotoc_md447"/>
465464
<a href="parameters.html#bc_x"/>
466465
<a href="parameters.html#bc_y"/>
467466
<a href="parameters.html#bc_z"/>
@@ -473,7 +472,6 @@
473472
<a href="parameters.html#flux_wrt"/>
474473
<a href="parameters.html#general"/>
475474
<a href="parameters.html#ib_airfoil"/>
476-
<a href="parameters.html#integral"/>
477475
<a href="parameters.html#lag_params"/>
478476
<a href="parameters.html#mom_wrt"/>
479477
<a href="parameters.html#omega_wrt"/>
@@ -500,125 +498,127 @@
500498
<a href="parameters.html#z_domain"/>
501499
<a href="parameters.html#z_output"/>
502500
<a href="physics_constraints.html"/>
501+
<a href="physics_constraints.html#autotoc_md448"/>
503502
<a href="physics_constraints.html#autotoc_md450"/>
503+
<a href="physics_constraints.html#autotoc_md451"/>
504504
<a href="physics_constraints.html#autotoc_md452"/>
505505
<a href="physics_constraints.html#autotoc_md453"/>
506-
<a href="physics_constraints.html#autotoc_md454"/>
507506
<a href="physics_constraints.html#autotoc_md455"/>
507+
<a href="physics_constraints.html#autotoc_md456"/>
508508
<a href="physics_constraints.html#autotoc_md457"/>
509-
<a href="physics_constraints.html#autotoc_md458"/>
510509
<a href="physics_constraints.html#autotoc_md459"/>
510+
<a href="physics_constraints.html#autotoc_md460"/>
511511
<a href="physics_constraints.html#autotoc_md461"/>
512512
<a href="physics_constraints.html#autotoc_md462"/>
513-
<a href="physics_constraints.html#autotoc_md463"/>
514513
<a href="physics_constraints.html#autotoc_md464"/>
515-
<a href="physics_constraints.html#autotoc_md466"/>
514+
<a href="physics_constraints.html#autotoc_md465"/>
516515
<a href="physics_constraints.html#autotoc_md467"/>
517-
<a href="physics_constraints.html#autotoc_md469"/>
516+
<a href="physics_constraints.html#autotoc_md468"/>
518517
<a href="physics_constraints.html#autotoc_md470"/>
519-
<a href="physics_constraints.html#autotoc_md472"/>
518+
<a href="physics_constraints.html#autotoc_md471"/>
520519
<a href="physics_constraints.html#autotoc_md473"/>
520+
<a href="physics_constraints.html#autotoc_md474"/>
521521
<a href="physics_constraints.html#autotoc_md475"/>
522522
<a href="physics_constraints.html#autotoc_md476"/>
523-
<a href="physics_constraints.html#autotoc_md477"/>
524523
<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"/>
532531
<a href="physics_constraints.html#autotoc_md487"/>
532+
<a href="physics_constraints.html#autotoc_md488"/>
533533
<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"/>
537536
<a href="physics_constraints.html#autotoc_md493"/>
538-
<a href="physics_constraints.html#autotoc_md495"/>
537+
<a href="physics_constraints.html#autotoc_md494"/>
539538
<a href="physics_constraints.html#autotoc_md496"/>
539+
<a href="physics_constraints.html#autotoc_md497"/>
540540
<a href="physics_constraints.html#autotoc_md498"/>
541-
<a href="physics_constraints.html#autotoc_md499"/>
542541
<a href="physics_constraints.html#autotoc_md500"/>
543-
<a href="physics_constraints.html#autotoc_md502"/>
542+
<a href="physics_constraints.html#autotoc_md501"/>
544543
<a href="physics_constraints.html#autotoc_md503"/>
545-
<a href="physics_constraints.html#autotoc_md505"/>
546-
<a href="physics_constraints.html#autotoc_md506"/>
544+
<a href="physics_constraints.html#autotoc_md504"/>
547545
<a href="running.html"/>
548-
<a href="running.html#autotoc_md513"/>
546+
<a href="running.html#autotoc_md511"/>
547+
<a href="running.html#autotoc_md512"/>
549548
<a href="running.html#autotoc_md514"/>
550549
<a href="running.html#autotoc_md516"/>
550+
<a href="running.html#autotoc_md517"/>
551551
<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"/>
559558
<a href="running.html#autotoc_md526"/>
559+
<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"/>
563563
<a href="running.html#autotoc_md531"/>
564-
<a href="running.html#autotoc_md532"/>
565564
<a href="running.html#autotoc_md533"/>
566565
<a href="running.html#autotoc_md535"/>
567-
<a href="running.html#autotoc_md537"/>
568566
<a href="testing.html"/>
567+
<a href="testing.html#autotoc_md536"/>
568+
<a href="testing.html#autotoc_md537"/>
569569
<a href="testing.html#autotoc_md538"/>
570-
<a href="testing.html#autotoc_md539"/>
571-
<a href="testing.html#autotoc_md540"/>
572570
<a href="troubleshooting.html"/>
571+
<a href="troubleshooting.html#autotoc_md539"/>
572+
<a href="troubleshooting.html#autotoc_md540"/>
573573
<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"/>
577576
<a href="troubleshooting.html#autotoc_md545"/>
577+
<a href="troubleshooting.html#autotoc_md546"/>
578578
<a href="troubleshooting.html#autotoc_md547"/>
579579
<a href="troubleshooting.html#autotoc_md548"/>
580-
<a href="troubleshooting.html#autotoc_md549"/>
581580
<a href="troubleshooting.html#autotoc_md550"/>
581+
<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"/>
585585
<a href="troubleshooting.html#autotoc_md555"/>
586-
<a href="troubleshooting.html#autotoc_md556"/>
587586
<a href="troubleshooting.html#autotoc_md557"/>
587+
<a href="troubleshooting.html#autotoc_md558"/>
588588
<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"/>
592591
<a href="troubleshooting.html#autotoc_md563"/>
592+
<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"/>
596596
<a href="troubleshooting.html#autotoc_md568"/>
597-
<a href="troubleshooting.html#autotoc_md569"/>
598597
<a href="troubleshooting.html#autotoc_md570"/>
598+
<a href="troubleshooting.html#autotoc_md571"/>
599599
<a href="troubleshooting.html#autotoc_md572"/>
600600
<a href="troubleshooting.html#autotoc_md573"/>
601-
<a href="troubleshooting.html#autotoc_md574"/>
602601
<a href="troubleshooting.html#autotoc_md575"/>
602+
<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"/>
606606
<a href="troubleshooting.html#autotoc_md580"/>
607-
<a href="troubleshooting.html#autotoc_md581"/>
608607
<a href="troubleshooting.html#autotoc_md582"/>
608+
<a href="troubleshooting.html#autotoc_md583"/>
609609
<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"/>
613612
<a href="troubleshooting.html#autotoc_md588"/>
613+
<a href="troubleshooting.html#autotoc_md589"/>
614614
<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"/>
618617
<a href="troubleshooting.html#autotoc_md594"/>
619-
<a href="troubleshooting.html#autotoc_md596"/>
620618
<a href="visualization.html"/>
619+
<a href="visualization.html#autotoc_md595"/>
621620
<a href="visualization.html#autotoc_md597"/>
621+
<a href="visualization.html#autotoc_md598"/>
622622
<a href="visualization.html#autotoc_md599"/>
623623
<a href="visualization.html#autotoc_md600"/>
624624
<a href="visualization.html#autotoc_md601"/>
@@ -630,15 +630,13 @@
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"/>
634633
<a href="visualization.html#autotoc_md611"/>
634+
<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"/>
640640
<a href="visualization.html#autotoc_md618"/>
641-
<a href="visualization.html#autotoc_md619"/>
642-
<a href="visualization.html#autotoc_md620"/>
643641
</body>
644642
</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_md313"></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-16</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-17</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_md507"></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_md508"></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_md508"></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_md509"></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_md510"></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_md510"></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_md511"></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_md512"></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)