Skip to content

Commit 2ba980a

Browse files
author
MFC Action
committed
Docs @ 00aa603
1 parent b322691 commit 2ba980a

13 files changed

Lines changed: 1082 additions & 1082 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-27</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-28</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
@@ -1434,7 +1434,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14341434
</table>
14351435
<hr />
14361436
<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>
1437-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-27</div> </div></div><!-- contents -->
1437+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-28</div> </div></div><!-- contents -->
14381438
</div><!-- PageDoc -->
14391439
</div><!-- doc-content -->
14401440
<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-04-27</div> </div></div><!-- contents -->
997+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-28</div> </div></div><!-- contents -->
998998
</div><!-- PageDoc -->
999999
</div><!-- doc-content -->
10001000
<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-04-27</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-28</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
@@ -1575,7 +1575,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md393"></a>
15751575
<div class="line"> </div>
15761576
<div class="line"># Filter by type</div>
15771577
<div class="line">./mfc.sh params -t real weno</div>
1578-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-27</div> </div></div><!-- contents -->
1578+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-04-28</div> </div></div><!-- contents -->
15791579
</div><!-- PageDoc -->
15801580
</div><!-- doc-content -->
15811581
<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_md443"></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-27</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-28</div> </div></div><!-- contents -->
628628
</div><!-- PageDoc -->
629629
</div><!-- doc-content -->
630630
<div id="page-nav" class="page-nav-panel">

documentation/visualization.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md548"></a>
313313
<h2 class="doxsection"><a class="anchor" id="autotoc_md550"></a>
314314
Visualizing with ParaView</h2>
315315
<p>ParaView is an open-source interactive parallel visualization and graphical analysis tool for viewing scientific data. Post-processed data in Silo-HDF5 format (<span class="tt">format=1</span>) can be opened directly in ParaView. Paraview 5.11.0 has been confirmed to work with the MFC databases for some parallel environments. Nevertheless, the installation and configuration of Paraview can be environment-dependent and are left to the user.</p>
316-
<p>The user can launch Paraview and open the index files under <span class="tt">/silo_hdf5/root</span>. Once the database is loaded, flow field variables contained in the database can be added to the render view. Further information on Paraview can be found in its <a href="https://docs.paraview.org/en/latest/">documentation</a>. The figure below shows the iso-contour of the liquid void fraction (<span class="tt">alpha1</span>) in the database generated by the example case <span class="tt">3D_sphbubcollapse</span>.</p>
316+
<p>The user can launch Paraview and open the series file <span class="tt">/silo_hdf5/collection.silo.series</span>. Once the database is loaded, flow field variables contained in the database can be added to the render view. Further information on Paraview can be found in its <a href="https://docs.paraview.org/en/latest/">documentation</a>. The figure below shows the iso-contour of the liquid void fraction (<span class="tt">alpha1</span>) in the database generated by the example case <span class="tt">3D_sphbubcollapse</span>.</p>
317317
<p><img src="../res/paraview.png" alt="" class="inline"/></p>
318318
<h3 class="doxsection"><a class="anchor" id="autotoc_md551"></a>
319319
Visualizing data in cylindrical coordinates</h3>

pre_process/m__global__parameters_8fpp_8f90_source.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -458,15 +458,15 @@
458458
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno"> 320</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_in = dflt_real</div>
459459
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno"> 321</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">bc_x</a>%Twall_out = dflt_real</div>
460460
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno"> 322</span><span class="preprocessor"># 279 &quot;/home/runner/work/MFC/MFC/src/pre_process/m_global_parameters.fpp&quot;</span></div>
461-
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno"> 323</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
462-
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno"> 324</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
463-
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno"> 325</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
464-
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno"> 326</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
461+
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno"> 323</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
462+
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno"> 324</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
463+
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno"> 325</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
464+
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno"> 326</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
465465
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno"> 327</span><span class="preprocessor"># 279 &quot;/home/runner/work/MFC/MFC/src/pre_process/m_global_parameters.fpp&quot;</span></div>
466-
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno"> 328</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_in = .false.</div>
467-
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno"> 329</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%isothermal_out = .false.</div>
468-
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno"> 330</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_in = dflt_real</div>
469-
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno"> 331</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">bc_z</a>%Twall_out = dflt_real</div>
466+
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno"> 328</span><span class="preprocessor"></span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_in = .false.</div>
467+
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno"> 329</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%isothermal_out = .false.</div>
468+
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno"> 330</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_in = dflt_real</div>
469+
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno"> 331</span> <a class="code hl_variable" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">bc_y</a>%Twall_out = dflt_real</div>
470470
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno"> 332</span><span class="preprocessor"># 284 &quot;/home/runner/work/MFC/MFC/src/pre_process/m_global_parameters.fpp&quot;</span></div>
471471
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno"> 333</span><span class="preprocessor"></span> </div>
472472
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno"> 334</span> <a class="code hl_variable" href="namespacem__global__parameters.html#ac127ac2a9036e1cdb7e6c41159cacdfb">parallel_io</a> = .false.</div>

0 commit comments

Comments
 (0)