Skip to content

Commit d383977

Browse files
author
MFC Action
committed
Docs @ 7c806be
1 parent c0c6abb commit d383977

File tree

1,042 files changed

+169277
-161491
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,042 files changed

+169277
-161491
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-02</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-03</div> </div></div><!-- contents -->
405405
</div><!-- PageDoc -->
406406
</div><!-- doc-content -->
407407
<div id="page-nav" class="page-nav-panel">

documentation/case.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -463,9 +463,9 @@ <h4 class="doxsection"><a class="anchor" id="autotoc_md24"></a>
463463
<li><span class="tt">c</span>, <span class="tt">t</span>, <span class="tt">p</span>, and <span class="tt">m</span> specify the parameters for a NACA airfoil. <span class="tt">m</span> is the maximum camber, <span class="tt">p</span> is the location of maximum camber, <span class="tt">c</span> is the coord length, and <span class="tt">t</span> is the thickness. Additional details on this specification can be found in <a href="https://web.stanford.edu/~cantwell/AA200_Course_Material/The%20NACA%20airfoil%20series.pdf">The Naca Airfoil Series</a></li>
464464
<li><span class="tt">slip</span> applies a slip boundary to the surface of the patch if true and a no-slip boundary condition to the surface if false.</li>
465465
<li>Please see <a class="el" href="#sec-patches" title="3. Patches">Patch Parameters</a> for the descriptions of <span class="tt">model_filepath</span>, <span class="tt">model_scale</span>, <span class="tt">model_rotate</span>, <span class="tt">model_translate</span>, <span class="tt">model_spc</span>, and <span class="tt">model_threshold</span>.</li>
466-
<li><span class="tt">moving_ibm</span> sets the method by which movement will be applied to the immersed boundary. Using 0 will result in no movement. Using 1 will result 1-way coupling where the boundary moves at a constant rate and applied forces to the fluid based upon it's own motion. In 1-way coupling, the fluid does not apply forces back onto the IB.</li>
467-
<li><span class="tt">vel(i)</span> is the initial linear velocity of the IB in the x, y, z direction for i=1, 2, 3. When <span class="tt">moving_ibm</span> equals 1, this velocity is constant.</li>
468-
<li><span class="tt">angular_vel(i)</span> is the initial angular velocity of the IB about the x, y, z axes for i=1, 2, 3 in radians per second. When <span class="tt">moving_ibm</span> equals 1, this angular velocity is constant.</li>
466+
<li><span class="tt">moving_ibm</span> sets the method by which movement will be applied to the immersed boundary. Using 0 will result in no movement. Using 1 will result 1-way coupling where the boundary moves at a constant rate and applied forces to the fluid based upon it's own motion. In 1-way coupling, the fluid does not apply forces back onto the IB. Using 2 will result in 2-way coupling, where the boundary pushes on the fluid and the fluid pushes back on the boundary via pressure and viscous forces. If external forces are applied, the boundary will also experience those forces.</li>
467+
<li><span class="tt">vel(i)</span> is the initial linear velocity of the IB in the x, y, z direction for i=1, 2, 3. When <span class="tt">moving_ibm</span> equals 2, this velocity is just the starting speed of the object, which will then accelerate due to external forces. If <span class="tt">moving_ibm</span> equals 1, then this is constant if it is a number, or can be described analytically with an expression.</li>
468+
<li><span class="tt">angular_vel(i)</span> is the initial angular velocity of the IB about the x, y, z axes for i=1, 2, 3 in radians per second. When <span class="tt">moving_ibm</span> equals 2, this rotation rate is just the starting rate of the object, which will then change due to external torques. If <span class="tt">moving_ibm</span> equals 1, then this is constant if it is a number, or can be described analytically with an expression.</li>
469469
</ul>
470470
<h3 class="doxsection"><a class="anchor" id="sec-fluid-materials"></a>
471471
5. Fluid Material's</h3>

documentation/case_constraints.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -809,7 +809,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
809809
<li>output_partial_domain is incompatible with certain output flags</li>
810810
</ul>
811811
<p><b>Valid values</b> (errors):</p><ul>
812-
<li>num_ibs must be between 1 and num_patches_max (10)</li>
812+
<li>num_ibs must be between 1 and num_patches_max (1000)</li>
813813
</ul>
814814
<p></p>
815815
</details>
@@ -964,10 +964,10 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
964964
<p></p>
965965
<p><b>Schema constraints:</b></p><ul>
966966
<li>Min: 0</li>
967-
<li>Max: 10</li>
967+
<li>Max: 1000</li>
968968
</ul>
969969
<p><b>Valid values</b> (errors):</p><ul>
970-
<li>num_ibs must be between 1 and num_patches_max (10)</li>
970+
<li>num_ibs must be between 1 and num_patches_max (1000)</li>
971971
</ul>
972972
<p></p>
973973
</details>
@@ -1423,7 +1423,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14231423
</table>
14241424
<hr />
14251425
<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>
1426-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-02</div> </div></div><!-- contents -->
1426+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-03</div> </div></div><!-- contents -->
14271427
</div><!-- PageDoc -->
14281428
</div><!-- doc-content -->
14291429
<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
@@ -952,7 +952,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md78"></a>
952952
<h3 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
953953
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
954954
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
955-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-02</div> </div></div><!-- contents -->
955+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-03</div> </div></div><!-- contents -->
956956
</div><!-- PageDoc -->
957957
</div><!-- doc-content -->
958958
<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-02</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-03</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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -486,10 +486,10 @@ 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_icpp", "parameters.html#patch_icpp", [
489+
[ "patch_ib", "parameters.html#patch_ib", [
490490
[ "Patterns", "parameters.html#autotoc_md339", null ]
491491
] ],
492-
[ "patch_ib", "parameters.html#patch_ib", [
492+
[ "patch_icpp", "parameters.html#patch_icpp", [
493493
[ "Patterns", "parameters.html#autotoc_md341", null ]
494494
] ],
495495
[ "fluid_pp", "parameters.html#fluid_pp", [

documentation/navtreeindex1.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ var NAVTREEINDEX1 =
158158
"parameters.html#mom_wrt":[14,0,24],
159159
"parameters.html#omega_wrt":[14,0,25],
160160
"parameters.html#patch_bc":[14,0,5],
161-
"parameters.html#patch_ib":[14,0,3],
162-
"parameters.html#patch_icpp":[14,0,2],
161+
"parameters.html#patch_ib":[14,0,2],
162+
"parameters.html#patch_icpp":[14,0,3],
163163
"parameters.html#probe":[14,0,13],
164164
"parameters.html#schlieren_alpha":[14,0,21],
165165
"parameters.html#simplex_params":[14,0,8],

0 commit comments

Comments
 (0)