Skip to content

Commit f438fd6

Browse files
author
MFC Action
committed
Docs @ a27ef44
1 parent 1ce109e commit f438fd6

407 files changed

Lines changed: 19870 additions & 17488 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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md8"></a>
305305
<tr class="markdownTableRowEven">
306306
<td class="markdownTableBodyNone"><span class="tt">m_ibm</span> </td><td class="markdownTableBodyNone">Ghost-node immersed boundary method: locates ghost/image points, computes interpolation coefficients, and corrects the flow state </td></tr>
307307
<tr class="markdownTableRowOdd">
308-
<td class="markdownTableBodyNone"><span class="tt">m_particle_bed</span> </td><td class="markdownTableBodyNone">Generates particle beds by converting particle_bed patch specifications into individual immersed boundary patches before domain reduction </td></tr>
308+
<td class="markdownTableBodyNone"><span class="tt">m_particle_cloud</span> </td><td class="markdownTableBodyNone">Generates particle beds by converting particle_cloud patch specifications into individual immersed boundary patches before domain reduction </td></tr>
309309
<tr class="markdownTableRowEven">
310310
<td class="markdownTableBodyNone"><span class="tt">m_igr</span> </td><td class="markdownTableBodyNone">Iterative ghost rasterization (IGR) for sharp immersed boundary treatment </td></tr>
311311
<tr class="markdownTableRowOdd">
@@ -407,7 +407,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
407407
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
408408
</ol>
409409
<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>
410-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-05</div> </div></div><!-- contents -->
410+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-06</div> </div></div><!-- contents -->
411411
</div><!-- PageDoc -->
412412
</div><!-- doc-content -->
413413
<div id="page-nav" class="page-nav-panel">

documentation/case.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ <h3 class="doxsection"><a class="anchor" id="sec-immersed-boundary-patches"></a>
431431
<tr class="markdownTableRowEven">
432432
<td class="markdownTableBodyRight"><span class="tt">num_stl_models</span> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Number of STL/OBJ model entries in the <span class="tt">stl_models</span> array </td></tr>
433433
<tr class="markdownTableRowOdd">
434-
<td class="markdownTableBodyRight"><span class="tt">num_particle_beds</span> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Number of particle bed specifications to generate immersed boundary patches from </td></tr>
434+
<td class="markdownTableBodyRight"><span class="tt">num_particle_clouds</span> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Number of particle bed specifications to generate immersed boundary patches from </td></tr>
435435
<tr class="markdownTableRowEven">
436436
<td class="markdownTableBodyRight"><span class="tt">ib_neighborhood_radius</span> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Parameter that controls the neighborhood size for IB detection. </td></tr>
437437
<tr class="markdownTableRowOdd">

documentation/case_constraints.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -815,7 +815,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
815815
<li>output_partial_domain is incompatible with certain output flags</li>
816816
</ul>
817817
<p><b>Valid values</b> (errors):</p><ul>
818-
<li>num_ibs must be &gt;= 1 when ib is enabled (or specify at least one particle_bed with num_particles &gt; 0)</li>
818+
<li>num_ibs must be &gt;= 1 when ib is enabled (or specify at least one particle_cloud with num_particles &gt; 0)</li>
819819
<li>num_ibs must be &lt;= num_ib_patches_max (num_ib_patches_max_namelist in m_constants.fpp)</li>
820820
</ul>
821821
<p></p>
@@ -1006,7 +1006,7 @@ <h2 class="doxsection"><a class="anchor" id="quick-parameter-reference"></a>
10061006
<li>Min: 0</li>
10071007
</ul>
10081008
<p><b>Valid values</b> (errors):</p><ul>
1009-
<li>num_ibs must be &gt;= 1 when ib is enabled (or specify at least one particle_bed with num_particles &gt; 0)</li>
1009+
<li>num_ibs must be &gt;= 1 when ib is enabled (or specify at least one particle_cloud with num_particles &gt; 0)</li>
10101010
<li>num_ibs must be &lt;= num_ib_patches_max (num_ib_patches_max_namelist in m_constants.fpp)</li>
10111011
</ul>
10121012
<p></p>
@@ -1463,7 +1463,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14631463
</table>
14641464
<hr />
14651465
<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>
1466-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-05</div> </div></div><!-- contents -->
1466+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-06</div> </div></div><!-- contents -->
14671467
</div><!-- PageDoc -->
14681468
</div><!-- doc-content -->
14691469
<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
@@ -994,7 +994,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
994994
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
995995
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
996996
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
997-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-05</div> </div></div><!-- contents -->
997+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-06</div> </div></div><!-- contents -->
998998
</div><!-- PageDoc -->
999999
</div><!-- doc-content -->
10001000
<div id="page-nav" class="page-nav-panel">

documentation/doxygen_crawl.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@
431431
<a href="parameters.html#lag_params"/>
432432
<a href="parameters.html#mom_wrt"/>
433433
<a href="parameters.html#omega_wrt"/>
434-
<a href="parameters.html#particle_bed"/>
434+
<a href="parameters.html#particle_cloud"/>
435435
<a href="parameters.html#patch_bc"/>
436436
<a href="parameters.html#patch_ib"/>
437437
<a href="parameters.html#patch_icpp"/>

documentation/examples.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md275"></a>
388388
<h3 class="doxsection"><a class="anchor" id="autotoc_md276"></a>
389389
Result</h3>
390390
<p><img src="result-1D_titarevtorro-example.png" alt="" heiht="400" class="inline"/></p>
391-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-05</div> </div></div><!-- contents -->
391+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-06-06</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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -526,7 +526,7 @@ var NAVTREE =
526526
] ],
527527
[ "bub_pp", "parameters.html#bub_pp", null ],
528528
[ "lag_params", "parameters.html#lag_params", null ],
529-
[ "particle_bed", "parameters.html#particle_bed", null ],
529+
[ "particle_cloud", "parameters.html#particle_cloud", null ],
530530
[ "alpha_rho_e_wrt", "parameters.html#alpha_rho_e_wrt", [
531531
[ "Patterns", "parameters.html#autotoc_md368", null ]
532532
] ],

documentation/navtreeindex1.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ var NAVTREEINDEX1 =
159159
"parameters.html#lag_params":[14,0,15],
160160
"parameters.html#mom_wrt":[14,0,26],
161161
"parameters.html#omega_wrt":[14,0,27],
162-
"parameters.html#particle_bed":[14,0,16],
162+
"parameters.html#particle_cloud":[14,0,16],
163163
"parameters.html#patch_bc":[14,0,4],
164164
"parameters.html#patch_ib":[14,0,13],
165165
"parameters.html#patch_icpp":[14,0,2],

0 commit comments

Comments
 (0)