Skip to content

Commit 3d60287

Browse files
author
MFC Action
committed
Docs @ 28863b1
1 parent 6490736 commit 3d60287

33 files changed

Lines changed: 34473 additions & 34478 deletions

documentation/architecture.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
405405
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
406406
</ol>
407407
<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>
408-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-12</div> </div></div><!-- contents -->
408+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-13</div> </div></div><!-- contents -->
409409
</div><!-- PageDoc -->
410410
</div><!-- doc-content -->
411411
<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
@@ -1456,7 +1456,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14561456
</table>
14571457
<hr />
14581458
<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>
1459-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-12</div> </div></div><!-- contents -->
1459+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-13</div> </div></div><!-- contents -->
14601460
</div><!-- PageDoc -->
14611461
</div><!-- doc-content -->
14621462
<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
@@ -996,7 +996,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
996996
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
997997
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
998998
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
999-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-12</div> </div></div><!-- contents -->
999+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-13</div> </div></div><!-- contents -->
10001000
</div><!-- PageDoc -->
10011001
</div><!-- doc-content -->
10021002
<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_md276"></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-05-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-05-13</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
@@ -1577,7 +1577,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></a>
15771577
<div class="line"> </div>
15781578
<div class="line"># Filter by type</div>
15791579
<div class="line">./mfc.sh params -t real weno</div>
1580-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-12</div> </div></div><!-- contents -->
1580+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-13</div> </div></div><!-- contents -->
15811581
</div><!-- PageDoc -->
15821582
</div><!-- doc-content -->
15831583
<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
@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md443"></a>
630630
<li>FFT WRT incompatible with cylindrical coordinates</li>
631631
<li>FFT WRT requires global dimensions divisible by 2</li>
632632
</ul>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-12</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-05-13</div> </div></div><!-- contents -->
634634
</div><!-- PageDoc -->
635635
</div><!-- doc-content -->
636636
<div id="page-nav" class="page-nav-panel">

post_process/m__global__parameters_8fpp_8f90_source.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -514,15 +514,15 @@
514514
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno"> 376</span><span class="preprocessor"></span><span class="preprocessor"># 338 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
515515
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno"> 377</span><span class="preprocessor"></span> </div>
516516
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno"> 378</span><span class="preprocessor"># 340 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
517-
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno"> 379</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
518-
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno"> 380</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
519-
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno"> 381</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
520-
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno"> 382</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
517+
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno"> 379</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
518+
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno"> 380</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
519+
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno"> 381</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
520+
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno"> 382</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
521521
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno"> 383</span><span class="preprocessor"># 340 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
522-
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno"> 384</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
523-
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno"> 385</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
524-
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"> 386</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
525-
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno"> 387</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
522+
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno"> 384</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
523+
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno"> 385</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
524+
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"> 386</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
525+
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno"> 387</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
526526
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno"> 388</span><span class="preprocessor"># 340 &quot;/home/runner/work/MFC/MFC/src/post_process/m_global_parameters.fpp&quot;</span></div>
527527
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno"> 389</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_in = .false.</div>
528528
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno"> 390</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%isothermal_out = .false.</div>

pre_process/m__assign__variables_8fpp_8f90_source.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -572,15 +572,15 @@
572572
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno"> 430</span> </div>
573573
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno"> 431</span> <span class="keywordflow">do</span> i = 1, <a class="code hl_variable" href="namespacem__global__parameters.html#af450e59f07548be6596c3b9ecd707200">eqn_idx</a>%E - <a class="code hl_variable" href="namespacem__global__parameters.html#af450e59f07548be6596c3b9ecd707200">eqn_idx</a>%mom%beg</div>
574574
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno"> 432</span> q_prim_vf(i + 1)%sf(<a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ace2eaec12668a4d4eedb46c8c99c94f2">j</a>, <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a>, <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>) = 1._wp/q_prim_vf(1)%sf(<a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ace2eaec12668a4d4eedb46c8c99c94f2">j</a>, <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a>, &amp;</div>
575-
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno"> 433</span> &amp; <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>)*(eta*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(patch_id)%rho*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(patch_id)%vel(i) + (1._wp - eta)*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(smooth_patch_id) &amp;</div>
576-
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno"> 434</span> &amp; %rho*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(smooth_patch_id)%vel(i))</div>
575+
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno"> 433</span> &amp; <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>)*(eta*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(patch_id)%rho*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(patch_id)%vel(i) + (1._wp - eta) &amp;</div>
576+
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno"> 434</span> &amp; *<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(smooth_patch_id)%rho*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(smooth_patch_id)%vel(i))</div>
577577
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno"> 435</span><span class="keywordflow"> end do</span></div>
578578
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno"> 436</span> </div>
579579
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno"> 437</span> q_prim_vf(<a class="code hl_variable" href="namespacem__global__parameters.html#af450e59f07548be6596c3b9ecd707200">eqn_idx</a>%gamma)%sf(<a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ace2eaec12668a4d4eedb46c8c99c94f2">j</a>, <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a>, <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>) = eta*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(patch_id)%gamma + (1._wp - eta)*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(smooth_patch_id)%gamma</div>
580580
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno"> 438</span> </div>
581581
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno"> 439</span> q_prim_vf(<a class="code hl_variable" href="namespacem__global__parameters.html#af450e59f07548be6596c3b9ecd707200">eqn_idx</a>%E)%sf(<a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ace2eaec12668a4d4eedb46c8c99c94f2">j</a>, <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a>, <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>) = 1._wp/q_prim_vf(<a class="code hl_variable" href="namespacem__global__parameters.html#af450e59f07548be6596c3b9ecd707200">eqn_idx</a>%gamma)%sf(<a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ace2eaec12668a4d4eedb46c8c99c94f2">j</a>, <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a>, &amp;</div>
582-
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno"> 440</span> &amp; <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>)*(eta*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(patch_id)%gamma*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(patch_id)%pres + (1._wp - eta)*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(smooth_patch_id) &amp;</div>
583-
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno"> 441</span> &amp; %gamma*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(smooth_patch_id)%pres)</div>
582+
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno"> 440</span> &amp; <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>)*(eta*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(patch_id)%gamma*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(patch_id)%pres + (1._wp - eta) &amp;</div>
583+
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno"> 441</span> &amp; *<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(smooth_patch_id)%gamma*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(smooth_patch_id)%pres)</div>
584584
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno"> 442</span> </div>
585585
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno"> 443</span> q_prim_vf(<a class="code hl_variable" href="namespacem__global__parameters.html#af450e59f07548be6596c3b9ecd707200">eqn_idx</a>%pi_inf)%sf(<a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ace2eaec12668a4d4eedb46c8c99c94f2">j</a>, <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ab59687ec5969af6d5b7b9ba5cf2835aa">k</a>, <a class="code hl_variable" href="m__phase__change_8fpp_8f90.html#ae9acc6b70aad4473254a118fe7e38e72">l</a>) = eta*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(patch_id)%pi_inf + (1._wp - eta)*<a class="code hl_variable" href="namespacem__global__parameters.html#ab5fc97fce88eefa124865cab08aa2250">patch_icpp</a>(smooth_patch_id)%pi_inf</div>
586586
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno"> 444</span> </div>

0 commit comments

Comments
 (0)