Skip to content

Commit 9f2f7d4

Browse files
author
MFC Action
committed
Docs @ 598f5a5
1 parent a7e96f4 commit 9f2f7d4

File tree

496 files changed

+42851
-42303
lines changed

Some content is hidden

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

496 files changed

+42851
-42303
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-12</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-13</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: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -390,8 +390,8 @@ <h4 class="doxsection"><a class="anchor" id="autotoc_md22"></a>
390390
<ul>
391391
<li><span class="tt">num_patches</span> defines the total number of patches defined in the domain. The number has to be a positive integer.</li>
392392
<li><span class="tt">num_fluids</span> defines the total number of fluids defined in each of the patches. The number has to be a positive integer.</li>
393-
<li><span class="tt">patch_icpp(j)%geometry</span> defines the type of geometry of $j$-th patch by using an integer from 1 to 13. Definition of the patch type for each integer is listed in table <a class="el" href="#patch-types" title="Patch types">Patch Types</a>.</li>
394-
<li><span class="tt">[x,y,z]_centroid</span>, <span class="tt">length_[x,y,z]</span>, and/or <span class="tt">radius</span> are used to uniquely define the geometry of the patch with given type. Requisite combinations of the parameters for each type can be found in is listed in table <a class="el" href="#patch-types" title="Patch types">Patch types</a>.</li>
393+
<li><span class="tt">patch_icpp(j)%geometry</span> defines the type of geometry of $j$-th patch by using an integer from 1 to 21. Definition of the patch type for each integer is listed in table <a class="el" href="#patch-types" title="Patch types">Patch Types</a>.</li>
394+
<li><span class="tt">[x,y,z]_centroid</span>, <span class="tt">length_[x,y,z]</span>, and/or <span class="tt">radius</span> are used to uniquely define the geometry of the patch with given type. Requisite combinations of the parameters for each type are listed in table <a class="el" href="#patch-types" title="Patch types">Patch types</a>.</li>
395395
<li><span class="tt">patch_icpp(j)%alter_patch(i)</span> activates alternation of <span class="tt">patch(i)</span> with <span class="tt">patch(j)</span>. For instance, in a 2D simulation, when a cylindrical <span class="tt">patch(2)</span> is immersed in a rectangular <span class="tt">patch(1)</span>:<ul>
396396
<li><span class="tt">patch_icpp(1)%geometry = 3</span></li>
397397
<li><span class="tt">patch_icpp(2)%geometry = 2</span></li>
@@ -1331,9 +1331,9 @@ <h3 class="doxsection"><a class="anchor" id="patch-types"></a>
13311331
<tr class="markdownTableRowEven">
13321332
<td class="markdownTableBodyRight">12 </td><td class="markdownTableBodyCenter">Ellipsoid </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">Y </td><td class="markdownTableBodyLeft">Requires <span class="tt">[x,y,z]_centroid</span> and <span class="tt">radii(i)</span>. </td></tr>
13331333
<tr class="markdownTableRowOdd">
1334-
<td class="markdownTableBodyRight">13 </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyLeft">No longer exists. Empty. </td></tr>
1334+
<td class="markdownTableBodyRight">13 </td><td class="markdownTableBodyCenter">2D modal (Fourier) </td><td class="markdownTableBodyCenter">2 </td><td class="markdownTableBodyCenter">Y </td><td class="markdownTableBodyLeft">Requires <span class="tt">x_centroid</span>, <span class="tt">y_centroid</span>, <span class="tt">radius</span>. Optional: <span class="tt">fourier_cos(n)</span>, <span class="tt">fourier_sin(n)</span> (n=1..10), <span class="tt">modal_clip_r_to_min</span>, <span class="tt">modal_r_min</span>, <span class="tt">modal_use_exp_form</span>. </td></tr>
13351335
<tr class="markdownTableRowEven">
1336-
<td class="markdownTableBodyRight">14 </td><td class="markdownTableBodyCenter">Spherical Harmonic </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Requires <span class="tt">[x,y,z]_centroid</span>, <span class="tt">radius</span>, <span class="tt">epsilon</span>, <span class="tt">beta</span> </td></tr>
1336+
<td class="markdownTableBodyRight">14 </td><td class="markdownTableBodyCenter">3D spherical harmonic </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">Y </td><td class="markdownTableBodyLeft">Requires <span class="tt">x_centroid</span>, <span class="tt">y_centroid</span>, <span class="tt">z_centroid</span>, <span class="tt">radius</span>. Optional: <span class="tt">sph_har_coeff(l,m)</span> (l=0..5, m=-l..l). </td></tr>
13371337
<tr class="markdownTableRowOdd">
13381338
<td class="markdownTableBodyRight">15 </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyLeft">No longer exists. Empty. </td></tr>
13391339
<tr class="markdownTableRowEven">
@@ -1350,6 +1350,19 @@ <h3 class="doxsection"><a class="anchor" id="patch-types"></a>
13501350
<td class="markdownTableBodyRight">21 </td><td class="markdownTableBodyCenter">Model </td><td class="markdownTableBodyCenter">2 &amp; 3 </td><td class="markdownTableBodyCenter">Y </td><td class="markdownTableBodyLeft">Imports a Model (STL/OBJ). Requires <span class="tt">model_filepath</span>. </td></tr>
13511351
</table>
13521352
<p>The patch types supported by the MFC are listed in table <a class="el" href="#patch-types" title="Patch types">Patch Types</a>. This includes types exclusive to one-, two-, and three-dimensional problems. The patch type number (<span class="tt">#</span>) corresponds to the input value in <span class="tt">input.py</span> labeled <span class="tt">patch_icpp(j)%geometry</span> where $j$ is the patch index. Each patch requires a different set of parameters, which are also listed in this table.</p>
1353+
<p><b>Geometry 13: 2D modal (Fourier):</b> <br />
1354+
Boundary is at polar angle \(\theta = \mathrm{atan2}(y - y_{\mathrm{centroid}}, x - x_{\mathrm{centroid}})\).</p>
1355+
<ul>
1356+
<li><b>Additive form</b> (default, <span class="tt">modal_use_exp_form</span> false): <br />
1357+
\(R_{\mathrm{boundary}} = \mathrm{radius} + \sum_n \bigl[ \mathtt{fourier\_cos}(n)\cos(n\theta) + \mathtt{fourier\_sin}(n)\sin(n\theta) \bigr]\). <br />
1358+
Coefficients are absolute: same units as <span class="tt">radius</span> (length). <br />
1359+
If this formula gives \(R_{\mathrm{boundary}} &lt; 0\) at some \(\theta\), it is clipped to zero. <br />
1360+
With <span class="tt">modal_clip_r_to_min</span> true, if \(R_{\mathrm{boundary}} &lt;\) <span class="tt">modal_r_min</span> at some \(\theta\), it is clipped to <span class="tt">modal_r_min</span>. <br />
1361+
</li>
1362+
<li><b>Exponential form</b> (<span class="tt">modal_use_exp_form</span> true): <br />
1363+
\(R_{\mathrm{boundary}} = \mathrm{radius} \times \exp\bigl( \sum_n [\ldots] \bigr)\). <br />
1364+
Coefficients are relative (dimensionless); the sum scales the radius.</li>
1365+
</ul>
13531366
<h3 class="doxsection"><a class="anchor" id="immersed-boundary-patch-types"></a>
13541367
Immersed Boundary Patch Types</h3>
13551368
<table class="markdownTable">

documentation/case_constraints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1424,7 +1424,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14241424
</table>
14251425
<hr />
14261426
<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>
1427-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-12</div> </div></div><!-- contents -->
1427+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-13</div> </div></div><!-- contents -->
14281428
</div><!-- PageDoc -->
14291429
</div><!-- doc-content -->
14301430
<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-12</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-13</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-12</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-13</div> </div></div><!-- contents -->
392392
</div><!-- PageDoc -->
393393
</div><!-- doc-content -->
394394
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)