Skip to content

Commit 20ae98e

Browse files
author
MFC Action
committed
Docs @ 52e8af1
1 parent f229764 commit 20ae98e

File tree

4,545 files changed

+192073
-206680
lines changed

Some content is hidden

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

4,545 files changed

+192073
-206680
lines changed

documentation/architecture.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md7"></a>
281281
<tr class="markdownTableRowOdd">
282282
<td class="markdownTableBodyNone"><span class="tt">m_chemistry</span> </td><td class="markdownTableBodyNone">Multi-species chemistry interface for thermodynamic properties, reaction rates, and transport coefficients </td></tr>
283283
<tr class="markdownTableRowEven">
284-
<td class="markdownTableBodyNone"><span class="tt">m_acoustic_src</span> </td><td class="markdownTableBodyNone">Applies acoustic pressure source terms including focused, planar, and broadband transducers </td></tr>
284+
<td class="markdownTableBodyNone"><span class="tt">m_acoustic_src</span> </td><td class="markdownTableBodyNone">One-way acoustic source injection, Maeda and Colonius JCP (2017) </td></tr>
285285
<tr class="markdownTableRowOdd">
286286
<td class="markdownTableBodyNone"><span class="tt">m_body_forces</span> </td><td class="markdownTableBodyNone">Computes gravitational and user-defined body force source terms for the momentum equations </td></tr>
287287
<tr class="markdownTableRowEven">
@@ -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-25</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-26</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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ <h4 class="doxsection"><a class="anchor" id="autotoc_md24"></a>
476476
<li><span class="tt">length_x[y,z]</span> is the length of the patch in the x[y,z]-direction.</li>
477477
<li><span class="tt">radius</span> is the radius to be used for circular patches.</li>
478478
<li><span class="tt">theta</span> allows for the angle of attach of airfoil patches to be changed.</li>
479-
<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>
479+
<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://en.wikipedia.org/wiki/NACA_airfoil">NACA airfoil</a>.</li>
480480
<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>
481481
<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>
482482
<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>

documentation/case_constraints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1420,7 +1420,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14201420
</table>
14211421
<hr />
14221422
<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>
1423-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-25</div> </div></div><!-- contents -->
1423+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-26</div> </div></div><!-- contents -->
14241424
</div><!-- PageDoc -->
14251425
</div><!-- doc-content -->
14261426
<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_md79"></a>
964964
<h3 class="doxsection"><a class="anchor" id="autotoc_md80"></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-25</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-26</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_md274"></a>
388388
<h3 class="doxsection"><a class="anchor" id="autotoc_md275"></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-25</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-26</div> </div></div><!-- contents -->
392392
</div><!-- PageDoc -->
393393
</div><!-- doc-content -->
394394
<div id="page-nav" class="page-nav-panel">

documentation/parameters.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1543,7 +1543,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md392"></a>
15431543
<div class="line"> </div>
15441544
<div class="line"># Filter by type</div>
15451545
<div class="line">./mfc.sh params -t real weno</div>
1546-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-25</div> </div></div><!-- contents -->
1546+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-26</div> </div></div><!-- contents -->
15471547
</div><!-- PageDoc -->
15481548
</div><!-- doc-content -->
15491549
<div id="page-nav" class="page-nav-panel">

documentation/physics_constraints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -624,7 +624,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md442"></a>
624624
<li>FFT WRT incompatible with cylindrical coordinates</li>
625625
<li>FFT WRT requires global dimensions divisible by 2</li>
626626
</ul>
627-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-25</div> </div></div><!-- contents -->
627+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-03-26</div> </div></div><!-- contents -->
628628
</div><!-- PageDoc -->
629629
</div><!-- doc-content -->
630630
<div id="page-nav" class="page-nav-panel">

0 commit comments

Comments
 (0)