Skip to content

Commit f966592

Browse files
author
MFC Action
committed
Docs @ b504b3c
1 parent d0a77f6 commit f966592

14 files changed

+1143
-1142
lines changed

documentation/architecture.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
401401
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
402402
</ol>
403403
<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>
404-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-18</div> </div></div><!-- contents -->
404+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-19</div> </div></div><!-- contents -->
405405
</div><!-- PageDoc -->
406406
</div><!-- doc-content -->
407407
<div id="page-nav" class="page-nav-panel">

documentation/case_constraints.html

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -810,7 +810,8 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
810810
<li>output_partial_domain is incompatible with certain output flags</li>
811811
</ul>
812812
<p><b>Valid values</b> (errors):</p><ul>
813-
<li>num_ibs must be between 1 and num_patches_max (1000)</li>
813+
<li>num_ibs must be &gt;= 1 when ib is enabled</li>
814+
<li>num_ibs must be &lt;= num_patches_max (num_patches_max in m_constants.fpp)</li>
814815
</ul>
815816
<p></p>
816817
</details>
@@ -965,10 +966,10 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
965966
<p></p>
966967
<p><b>Schema constraints:</b></p><ul>
967968
<li>Min: 0</li>
968-
<li>Max: 1000</li>
969969
</ul>
970970
<p><b>Valid values</b> (errors):</p><ul>
971-
<li>num_ibs must be between 1 and num_patches_max (1000)</li>
971+
<li>num_ibs must be &gt;= 1 when ib is enabled</li>
972+
<li>num_ibs must be &lt;= num_patches_max (num_patches_max in m_constants.fpp)</li>
972973
</ul>
973974
<p></p>
974975
</details>
@@ -987,7 +988,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
987988
<p></p>
988989
<p><b>Schema constraints:</b></p><ul>
989990
<li>Min: 0</li>
990-
<li>Max: 10</li>
991+
<li>Max: 1000</li>
991992
</ul>
992993
<p><b>Valid values</b> (errors):</p><ul>
993994
<li>num_patches must be non-negative</li>
@@ -1428,7 +1429,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14281429
</table>
14291430
<hr />
14301431
<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>
1431-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-18</div> </div></div><!-- contents -->
1432+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-19</div> </div></div><!-- contents -->
14321433
</div><!-- PageDoc -->
14331434
</div><!-- doc-content -->
14341435
<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
@@ -964,7 +964,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md78"></a>
964964
<h3 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
965965
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
966966
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
967-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-18</div> </div></div><!-- contents -->
967+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-19</div> </div></div><!-- contents -->
968968
</div><!-- PageDoc -->
969969
</div><!-- doc-content -->
970970
<div id="page-nav" class="page-nav-panel">

documentation/examples.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md273"></a>
388388
<h3 class="doxsection"><a class="anchor" id="autotoc_md274"></a>
389389
Final Condition (Density)</h3>
390390
<p><img src="final-2D_forward_facing_step-example.png" alt="" class="inline"/></p>
391-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-18</div> </div></div><!-- contents -->
391+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-19</div> </div></div><!-- contents -->
392392
</div><!-- PageDoc -->
393393
</div><!-- doc-content -->
394394
<div id="page-nav" class="page-nav-panel">

documentation/navtreedata.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -486,34 +486,34 @@ var NAVTREE =
486486
[ "Case Parameters", "parameters.html#autotoc_md335", [
487487
[ "Overview", "parameters.html#autotoc_md336", null ],
488488
[ "Parameter Families", "parameters.html#autotoc_md337", null ],
489-
[ "patch_ib", "parameters.html#patch_ib", [
489+
[ "patch_icpp", "parameters.html#patch_icpp", [
490490
[ "Patterns", "parameters.html#autotoc_md339", null ]
491491
] ],
492-
[ "patch_icpp", "parameters.html#patch_icpp", [
492+
[ "fluid_pp", "parameters.html#fluid_pp", [
493493
[ "Patterns", "parameters.html#autotoc_md341", null ]
494494
] ],
495-
[ "fluid_pp", "parameters.html#fluid_pp", [
495+
[ "patch_bc", "parameters.html#patch_bc", [
496496
[ "Patterns", "parameters.html#autotoc_md343", null ]
497497
] ],
498-
[ "patch_bc", "parameters.html#patch_bc", [
498+
[ "acoustic", "parameters.html#acoustic", [
499499
[ "Patterns", "parameters.html#autotoc_md345", null ]
500500
] ],
501-
[ "acoustic", "parameters.html#acoustic", [
501+
[ "chem_wrt_Y", "parameters.html#chem_wrt_Y", [
502502
[ "Patterns", "parameters.html#autotoc_md347", null ]
503503
] ],
504-
[ "chem_wrt_Y", "parameters.html#chem_wrt_Y", [
504+
[ "simplex_params", "parameters.html#simplex_params", [
505505
[ "Patterns", "parameters.html#autotoc_md349", null ]
506506
] ],
507-
[ "simplex_params", "parameters.html#simplex_params", [
507+
[ "bc_x", "parameters.html#bc_x", [
508508
[ "Patterns", "parameters.html#autotoc_md351", null ]
509509
] ],
510-
[ "bc_x", "parameters.html#bc_x", [
510+
[ "bc_y", "parameters.html#bc_y", [
511511
[ "Patterns", "parameters.html#autotoc_md353", null ]
512512
] ],
513-
[ "bc_y", "parameters.html#bc_y", [
513+
[ "bc_z", "parameters.html#bc_z", [
514514
[ "Patterns", "parameters.html#autotoc_md355", null ]
515515
] ],
516-
[ "bc_z", "parameters.html#bc_z", [
516+
[ "patch_ib", "parameters.html#patch_ib", [
517517
[ "Patterns", "parameters.html#autotoc_md357", null ]
518518
] ],
519519
[ "integral", "parameters.html#integral", [

documentation/navtreeindex1.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ var NAVTREEINDEX1 =
112112
"papers.html":[13],
113113
"papers.html#autotoc_md334":[13,0],
114114
"parameters.html":[14],
115-
"parameters.html#acoustic":[14,0,6],
115+
"parameters.html#acoustic":[14,0,5],
116116
"parameters.html#alpha_rho_e_wrt":[14,0,16],
117117
"parameters.html#alpha_rho_wrt":[14,0,17],
118118
"parameters.html#alpha_wrt":[14,0,18],
@@ -142,13 +142,13 @@ var NAVTREEINDEX1 =
142142
"parameters.html#autotoc_md382":[14,0,25,0],
143143
"parameters.html#autotoc_md384":[14,0,26,0],
144144
"parameters.html#autotoc_md393":[14,0,34],
145-
"parameters.html#bc_x":[14,0,9],
146-
"parameters.html#bc_y":[14,0,10],
147-
"parameters.html#bc_z":[14,0,11],
145+
"parameters.html#bc_x":[14,0,8],
146+
"parameters.html#bc_y":[14,0,9],
147+
"parameters.html#bc_z":[14,0,10],
148148
"parameters.html#bub_pp":[14,0,14],
149149
"parameters.html#chem_params":[14,0,22],
150-
"parameters.html#chem_wrt_Y":[14,0,7],
151-
"parameters.html#fluid_pp":[14,0,4],
150+
"parameters.html#chem_wrt_Y":[14,0,6],
151+
"parameters.html#fluid_pp":[14,0,3],
152152
"parameters.html#fluid_rho":[14,0,19],
153153
"parameters.html#flux_wrt":[14,0,23],
154154
"parameters.html#general":[14,0,33],
@@ -157,12 +157,12 @@ var NAVTREEINDEX1 =
157157
"parameters.html#lag_params":[14,0,15],
158158
"parameters.html#mom_wrt":[14,0,24],
159159
"parameters.html#omega_wrt":[14,0,25],
160-
"parameters.html#patch_bc":[14,0,5],
161-
"parameters.html#patch_ib":[14,0,2],
162-
"parameters.html#patch_icpp":[14,0,3],
160+
"parameters.html#patch_bc":[14,0,4],
161+
"parameters.html#patch_ib":[14,0,11],
162+
"parameters.html#patch_icpp":[14,0,2],
163163
"parameters.html#probe":[14,0,13],
164164
"parameters.html#schlieren_alpha":[14,0,21],
165-
"parameters.html#simplex_params":[14,0,8],
165+
"parameters.html#simplex_params":[14,0,7],
166166
"parameters.html#vel_wrt":[14,0,26],
167167
"parameters.html#x_domain":[14,0,27],
168168
"parameters.html#x_output":[14,0,28],

0 commit comments

Comments
 (0)