Skip to content

Commit faebc5a

Browse files
author
MFC Action
committed
Docs @ 732209d
1 parent 80f9af6 commit faebc5a

194 files changed

Lines changed: 15392 additions & 14492 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
@@ -433,7 +433,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
433433
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
434434
</ol>
435435
<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>
436-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-28</div> </div></div><!-- contents -->
436+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-29</div> </div></div><!-- contents -->
437437
</div><!-- PageDoc -->
438438
</div><!-- doc-content -->
439439
<div id="page-nav" class="page-nav-panel">

‎documentation/case.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -449,6 +449,10 @@ <h3 class="doxsection"><a class="anchor" id="sec-immersed-boundary-patches"></a>
449449
<tr class="markdownTableRowOdd">
450450
<td class="markdownTableBodyRight"><span class="tt">many_ib_patch_parallelism</span> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Parallelize over IB patches instead of grid cells (better for many small patches). </td></tr>
451451
<tr class="markdownTableRowEven">
452+
<td class="markdownTableBodyRight"><span class="tt">ib_second_order_vel</span> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Extrapolate the ghost-point velocity linearly through the boundary intercept. </td></tr>
453+
<tr class="markdownTableRowOdd">
454+
<td class="markdownTableBodyRight"><span class="tt">ib_ip_min_dist</span> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Minimum boundary-to-image-point distance, in local cell widths, for <span class="tt">ib_second_order_vel</span>. </td></tr>
455+
<tr class="markdownTableRowEven">
452456
<td class="markdownTableBodyRight"><span class="tt">geometry</span> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Geometry configuration of the patch. </td></tr>
453457
<tr class="markdownTableRowOdd">
454458
<td class="markdownTableBodyRight"><span class="tt">x[y,z]_centroid</span> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Centroid of the applied geometry in the [x,y,z]-direction. </td></tr>
@@ -548,6 +552,8 @@ <h4 class="doxsection"><a class="anchor" id="autotoc_md24"></a>
548552
<li><span class="tt">collision_time</span> is approximately the amount of simulation time used to resolve collisions. This is handled by modifying the spring constant used to apply collision forces.</li>
549553
<li><span class="tt">collision_temporal_resolution</span> restricts the adaptive time step (<span class="tt">cfl_adap_dt</span>) to at most <span class="tt">collision_time / collision_temporal_resolution</span> while any collision is occurring, so that each collision is resolved with at least that many time steps. Pairing it with <span class="tt">ramp_ratio</span> limits how quickly the time step grows back once the collision ends.</li>
550554
<li><span class="tt">ib_coefficient_of_friction</span> is the coefficient of friction used in IB collisions.</li>
555+
<li><span class="tt">ib_second_order_vel</span> replaces the default ghost-point velocity, which imposes the wall velocity at the ghost point, with the linear extrapolation of Mittal et al. (2008) through the boundary intercept and replaces the interpolation scheme with a bilinear weight interpolation.</li>
556+
<li><span class="tt">ib_ip_min_dist</span> sets \(d_{IP} = \max(d_{GP}, \text{ib\_ip\_min\_dist}\,\Delta)\), with \(\Delta\) the smallest local cell width, so image points of near-wall ghost points interpolate from fluid cells. The default 0 is the pure mirror ( \(d_{IP} = d_{GP}\)). About \(\sqrt{2}\) in 2D ( \(\sqrt{3}\) in 3D) keeps the stencil off a locally planar wall.</li>
551557
<li><span class="tt">ib_neighborhood_radius</span> controls the size of the neighborhood size. A value of $r$ indicates that any given rank is aware of IBs up to $r$ ranks away. This value defaults to 0, which leaves the radius unset so that it is selected automatically. This parameter is required to strong-scale a case when IBs eventually grow to be larger than one full processor domain wide.</li>
552558
</ul>
553559
<h4 class="doxsection"><a class="anchor" id="autotoc_md25"></a>
@@ -1871,7 +1877,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md41"></a>
18711877
<td class="markdownTableBodyNone">hypoelastic variables </td><td class="markdownTableBodyNone">N/A </td></tr>
18721878
</table>
18731879
<p>The above variables correspond to optional physics.</p>
1874-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-27</div> </div></div><!-- contents -->
1880+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-28</div> </div></div><!-- contents -->
18751881
</div><!-- PageDoc -->
18761882
</div><!-- doc-content -->
18771883
<div id="page-nav" class="page-nav-panel">

‎documentation/case_constraints.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1618,7 +1618,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
16181618
</table>
16191619
<hr />
16201620
<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>
1621-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-28</div> </div></div><!-- contents -->
1621+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-29</div> </div></div><!-- contents -->
16221622
</div><!-- PageDoc -->
16231623
</div><!-- doc-content -->
16241624
<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
@@ -993,7 +993,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
993993
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
994994
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
995995
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
996-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-28</div> </div></div><!-- contents -->
996+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-29</div> </div></div><!-- contents -->
997997
</div><!-- PageDoc -->
998998
</div><!-- doc-content -->
999999
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)