Skip to content

Commit 6b9ac85

Browse files
author
MFC Action
committed
Docs @ 92585b1
1 parent 868e2f0 commit 6b9ac85

13 files changed

Lines changed: 1046 additions & 1046 deletions

‎documentation/architecture.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
403403
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
404404
</ol>
405405
<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>
406-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-16</div> </div></div><!-- contents -->
406+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-17</div> </div></div><!-- contents -->
407407
</div><!-- PageDoc -->
408408
</div><!-- doc-content -->
409409
<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
@@ -1429,7 +1429,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14291429
</table>
14301430
<hr />
14311431
<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>
1432-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-16</div> </div></div><!-- contents -->
1432+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-17</div> </div></div><!-- contents -->
14331433
</div><!-- PageDoc -->
14341434
</div><!-- doc-content -->
14351435
<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
@@ -984,7 +984,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md79"></a>
984984
<h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
985985
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
986986
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
987-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-16</div> </div></div><!-- contents -->
987+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-17</div> </div></div><!-- contents -->
988988
</div><!-- PageDoc -->
989989
</div><!-- doc-content -->
990990
<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 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md275"></a>
388388
Final Condition</h3>
389389
<p>This figure shows the isosurface with zero q-criterion.</p>
390390
<p><img src="result-3D_TaylorGreenVortex-example.png" alt="" height="400" class="inline"/></p>
391-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-16</div> </div></div><!-- contents -->
391+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-17</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
@@ -1551,7 +1551,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md392"></a>
15511551
<div class="line"> </div>
15521552
<div class="line"># Filter by type</div>
15531553
<div class="line">./mfc.sh params -t real weno</div>
1554-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-16</div> </div></div><!-- contents -->
1554+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-17</div> </div></div><!-- contents -->
15551555
</div><!-- PageDoc -->
15561556
</div><!-- doc-content -->
15571557
<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-04-16</div> </div></div><!-- contents -->
627+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-17</div> </div></div><!-- contents -->
628628
</div><!-- PageDoc -->
629629
</div><!-- doc-content -->
630630
<div id="page-nav" class="page-nav-panel">

‎simulation/m__collisions_8fpp_8f90_source.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -769,7 +769,7 @@
769769
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno"> 627</span><span class="preprocessor"></span><span class="comment">!$omp atomic update</span></div>
770770
<div class="line"><a id="l00628" name="l00628"></a><span class="lineno"> 628</span><span class="preprocessor"># 150 &quot;/home/runner/work/MFC/MFC/src/simulation/m_collisions.fpp&quot;</span></div>
771771
<div class="line"><a id="l00629" name="l00629"></a><span class="lineno"> 629</span><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
772-
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno"> 630</span><span class="preprocessor"></span> torques(pid2, l) = torques(pid2, l) - torque(l)*patch_ib(pid2)%radius/patch_ib(pid1)%radius</div>
772+
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno"> 630</span><span class="preprocessor"></span> torques(pid2, l) = torques(pid2, l) + torque(l)*patch_ib(pid2)%radius/patch_ib(pid1)%radius</div>
773773
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno"> 631</span><span class="keywordflow"> end do</span></div>
774774
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno"> 632</span><span class="keywordflow"> end if</span></div>
775775
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno"> 633</span><span class="keywordflow"> end if</span></div>

‎simulation/m__data__output_8fpp_8f90_source.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -665,7 +665,7 @@
665665
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno"> 519</span> <span class="keyword">call </span><a class="code hl_function" href="namespacem__compile__specific.html#aa1b4e12a20e09147a215c3b5018484b0">s_create_directory</a>(trim(<a class="code hl_variable" href="namespacem__global__parameters.html#ab3482dd78520fd94475375479fe1befb">case_dir</a>) // <span class="stringliteral">&#39;/restart_data&#39;</span>)</div>
666666
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno"> 520</span> <span class="keyword">write</span> (file_loc, <span class="stringliteral">&#39;(A)&#39;</span>) <span class="stringliteral">&#39;ib_state.dat&#39;</span></div>
667667
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno"> 521</span> file_loc = trim(<a class="code hl_variable" href="namespacem__global__parameters.html#ab3482dd78520fd94475375479fe1befb">case_dir</a>) // <span class="stringliteral">&#39;/restart_data/&#39;</span> // trim(file_loc)</div>
668-
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno"> 522</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="namespacem__global__parameters.html#ace0c8a67825d0dccd2e23b5d0f9985c0">t_step_start</a> /= 0) <span class="keywordflow">then</span></div>
668+
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno"> 522</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="namespacem__global__parameters.html#ace0c8a67825d0dccd2e23b5d0f9985c0">t_step_start</a> &gt; 0) <span class="keywordflow">then</span></div>
669669
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno"> 523</span> <span class="comment">! On restart, append to existing file to preserve history</span></div>
670670
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno"> 524</span> <span class="keyword">open</span> (newunit=<a class="code hl_variable" href="namespacem__data__output.html#a9dec45ea1457583c89b7abeda19896a4">ib_state_unit</a>, file=trim(file_loc), form=<span class="stringliteral">&#39;unformatted&#39;</span>, access=<span class="stringliteral">&#39;stream&#39;</span>, status=<span class="stringliteral">&#39;old&#39;</span>, &amp;</div>
671671
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno"> 525</span> &amp; position=<span class="stringliteral">&#39;append&#39;</span>, iostat=ios)</div>

‎simulation/m__global__parameters_8fpp_8f90.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -310,17 +310,17 @@
310310
<tr class="memitem:aabad0b5732baec4916c15bd01cb7f9b7" id="r_aabad0b5732baec4916c15bd01cb7f9b7"><td class="memItemLeft">logical&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#aabad0b5732baec4916c15bd01cb7f9b7">m_global_parameters::bf_y</a></td></tr>
311311
<tr class="memitem:a8f189b60d9f8aa4b5cfb8451d9bacd73" id="r_a8f189b60d9f8aa4b5cfb8451d9bacd73"><td class="memItemLeft">logical&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a8f189b60d9f8aa4b5cfb8451d9bacd73">m_global_parameters::bf_z</a></td></tr>
312312
<tr class="memdesc:a8f189b60d9f8aa4b5cfb8451d9bacd73"><td class="mdescLeft">&#160;</td><td class="mdescRight">body force toggle in three directions <br /></td></tr>
313-
<tr class="memitem:a82a4a61004712d4ded68b1018d796fae" id="r_a82a4a61004712d4ded68b1018d796fae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a82a4a61004712d4ded68b1018d796fae">m_global_parameters::g_y</a></td></tr>
314-
<tr class="memdesc:a82a4a61004712d4ded68b1018d796fae"><td class="mdescLeft">&#160;</td><td class="mdescRight">amplitude, frequency, and phase shift sinusoid in each direction <br /></td></tr>
315-
<tr class="memitem:a72371679cecccecfbc2b291dcd726228" id="r_a72371679cecccecfbc2b291dcd726228"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a72371679cecccecfbc2b291dcd726228">m_global_parameters::k_y</a></td></tr>
316-
<tr class="memitem:a86fb50483af0d51af7adb848daa8a4ae" id="r_a86fb50483af0d51af7adb848daa8a4ae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a86fb50483af0d51af7adb848daa8a4ae">m_global_parameters::p_y</a></td></tr>
317-
<tr class="memitem:ac5836965fc47e3cda0ac04bd3f33e347" id="r_ac5836965fc47e3cda0ac04bd3f33e347"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#ac5836965fc47e3cda0ac04bd3f33e347">m_global_parameters::w_y</a></td></tr>
318-
<tr class="memitem:a444ad421d11df63042d50c0ecae450c9" id="r_a444ad421d11df63042d50c0ecae450c9"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a444ad421d11df63042d50c0ecae450c9">m_global_parameters::g_z</a></td></tr>
319313
<tr class="memitem:a2b4bee61739d582d3f9d9538c6100c02" id="r_a2b4bee61739d582d3f9d9538c6100c02"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a2b4bee61739d582d3f9d9538c6100c02">m_global_parameters::k_z</a></td></tr>
314+
<tr class="memdesc:a2b4bee61739d582d3f9d9538c6100c02"><td class="mdescLeft">&#160;</td><td class="mdescRight">amplitude, frequency, and phase shift sinusoid in each direction <br /></td></tr>
315+
<tr class="memitem:a444ad421d11df63042d50c0ecae450c9" id="r_a444ad421d11df63042d50c0ecae450c9"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a444ad421d11df63042d50c0ecae450c9">m_global_parameters::g_z</a></td></tr>
320316
<tr class="memitem:a1f924d5ee4e2910cffe8e756a0c8657b" id="r_a1f924d5ee4e2910cffe8e756a0c8657b"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1f924d5ee4e2910cffe8e756a0c8657b">m_global_parameters::p_z</a></td></tr>
321317
<tr class="memitem:aa11528d15dfa6e313e1298dee5ca42cd" id="r_aa11528d15dfa6e313e1298dee5ca42cd"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#aa11528d15dfa6e313e1298dee5ca42cd">m_global_parameters::w_z</a></td></tr>
322-
<tr class="memitem:a1b2b0f3b66e4aef04d872e7550735df5" id="r_a1b2b0f3b66e4aef04d872e7550735df5"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1b2b0f3b66e4aef04d872e7550735df5">m_global_parameters::g_x</a></td></tr>
318+
<tr class="memitem:a72371679cecccecfbc2b291dcd726228" id="r_a72371679cecccecfbc2b291dcd726228"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a72371679cecccecfbc2b291dcd726228">m_global_parameters::k_y</a></td></tr>
319+
<tr class="memitem:a82a4a61004712d4ded68b1018d796fae" id="r_a82a4a61004712d4ded68b1018d796fae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a82a4a61004712d4ded68b1018d796fae">m_global_parameters::g_y</a></td></tr>
320+
<tr class="memitem:a86fb50483af0d51af7adb848daa8a4ae" id="r_a86fb50483af0d51af7adb848daa8a4ae"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a86fb50483af0d51af7adb848daa8a4ae">m_global_parameters::p_y</a></td></tr>
321+
<tr class="memitem:ac5836965fc47e3cda0ac04bd3f33e347" id="r_ac5836965fc47e3cda0ac04bd3f33e347"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#ac5836965fc47e3cda0ac04bd3f33e347">m_global_parameters::w_y</a></td></tr>
323322
<tr class="memitem:a1671373492ac31693c8698500f095ff4" id="r_a1671373492ac31693c8698500f095ff4"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1671373492ac31693c8698500f095ff4">m_global_parameters::k_x</a></td></tr>
323+
<tr class="memitem:a1b2b0f3b66e4aef04d872e7550735df5" id="r_a1b2b0f3b66e4aef04d872e7550735df5"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1b2b0f3b66e4aef04d872e7550735df5">m_global_parameters::g_x</a></td></tr>
324324
<tr class="memitem:a1b662ab55a2226686cc9e8a9ab95ada3" id="r_a1b662ab55a2226686cc9e8a9ab95ada3"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a1b662ab55a2226686cc9e8a9ab95ada3">m_global_parameters::p_x</a></td></tr>
325325
<tr class="memitem:a04316d272b181c3c8496d1b0ce088c64" id="r_a04316d272b181c3c8496d1b0ce088c64"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a04316d272b181c3c8496d1b0ce088c64">m_global_parameters::w_x</a></td></tr>
326326
<tr class="memitem:a4d953db2f36f05624766c42cc9851362" id="r_a4d953db2f36f05624766c42cc9851362"><td class="memItemLeft">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>), dimension(3)&#160;</td><td class="memItemRight"><a class="el" href="namespacem__global__parameters.html#a4d953db2f36f05624766c42cc9851362">m_global_parameters::accel_bf</a></td></tr>

0 commit comments

Comments
 (0)