Skip to content

Commit d206a7a

Browse files
author
MFC Action
committed
Docs @ 47568a0
1 parent 9ed80ca commit d206a7a

200 files changed

Lines changed: 11321 additions & 9203 deletions

File tree

Some content is hidden

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

‎documentation/architecture.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
433433
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
434434
</ol>
435435
<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>
436-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-14</div> </div></div><!-- contents -->
436+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-15</div> </div></div><!-- contents -->
437437
</div><!-- PageDoc -->
438438
</div><!-- doc-content -->
439439
<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
@@ -1618,7 +1618,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
16181618
</table>
16191619
<hr />
16201620
<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>
1621-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-14</div> </div></div><!-- contents -->
1621+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-15</div> </div></div><!-- contents -->
16221622
</div><!-- PageDoc -->
16231623
</div><!-- doc-content -->
16241624
<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
@@ -993,7 +993,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
993993
<h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
994994
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
995995
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
996-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-14</div> </div></div><!-- contents -->
996+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-15</div> </div></div><!-- contents -->
997997
</div><!-- PageDoc -->
998998
</div><!-- doc-content -->
999999
<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
@@ -974,7 +974,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md350"></a>
974974
<h3 class="doxsection"><a class="anchor" id="autotoc_md351"></a>
975975
Density Norms</h3>
976976
<p><img src="density_norms-2D_isentropicvortex-example.png" alt="" height="400" class="inline"/></p>
977-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-14</div> </div></div><!-- contents -->
977+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-15</div> </div></div><!-- contents -->
978978
</div><!-- PageDoc -->
979979
</div><!-- doc-content -->
980980
<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
@@ -1870,7 +1870,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md490"></a>
18701870
<div class="line"> </div>
18711871
<div class="line"># Filter by type</div>
18721872
<div class="line">./mfc.sh params -t real weno</div>
1873-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-14</div> </div></div><!-- contents -->
1873+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-15</div> </div></div><!-- contents -->
18741874
</div><!-- PageDoc -->
18751875
</div><!-- doc-content -->
18761876
<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
@@ -819,7 +819,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md553"></a>
819819
<li><code class="f90l">patch_icpp(i)%</code><code class="f90r">hcid</code>=hcid requires <span class="tt">files_dir</span> to be set</li>
820820
<li><code class="f90l">patch_icpp(i)%</code><code class="f90r">hcid</code>=hcid requires <span class="tt">file_extension</span> to be set</li>
821821
</ul>
822-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-14</div> </div></div><!-- contents -->
822+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-10-15</div> </div></div><!-- contents -->
823823
</div><!-- PageDoc -->
824824
</div><!-- doc-content -->
825825
<div id="page-nav" class="page-nav-panel">

‎post_process/doxygen_crawl.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,8 @@
168168
<a href="namespacem__boundary__io.html#a6bd453bc00436c7cbb2d823169f9dd10"/>
169169
<a href="namespacem__boundary__io.html#a74922617e3b2c7a414056d32bc6aa14d"/>
170170
<a href="namespacem__boundary__io.html#a8ed3282a661e5072782b8d824a7c6646"/>
171-
<a href="namespacem__boundary__io.html#ab6281588667a9843f9e3829c2a68c851"/>
171+
<a href="namespacem__boundary__io.html#a913e50a8381702d2886b419f225a78b9"/>
172+
<a href="namespacem__boundary__io.html#ad452cf79e517a22fdf7ee3fd757bca58"/>
172173
<a href="namespacem__boundary__io.html#af7a9587cc23f69c87bb9d34be4a6fec5"/>
173174
<a href="namespacem__boundary__primitives.html"/>
174175
<a href="namespacem__boundary__primitives.html#a05ca273856b144071a18d55dc2e31ed1"/>

‎post_process/m__boundary__io_8fpp_8f90.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,8 +178,10 @@
178178
<tr class="memdesc:a1b6a5f4b89c0cc5313f8f448ce1a9b2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write boundary condition type and buffer data to per-rank parallel files using MPI I/O. <br /></td></tr>
179179
<tr class="memitem:a6bd453bc00436c7cbb2d823169f9dd10" id="r_a6bd453bc00436c7cbb2d823169f9dd10"><td class="memItemLeft">subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__io.html#a6bd453bc00436c7cbb2d823169f9dd10">m_boundary_io::s_read_serial_boundary_condition_files</a> (step_dirpath, bc_type)</td></tr>
180180
<tr class="memdesc:a6bd453bc00436c7cbb2d823169f9dd10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read boundary condition type and buffer data from serial (unformatted) restart files. <br /></td></tr>
181-
<tr class="memitem:ab6281588667a9843f9e3829c2a68c851" id="r_ab6281588667a9843f9e3829c2a68c851"><td class="memItemLeft">subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__io.html#ab6281588667a9843f9e3829c2a68c851">m_boundary_io::s_read_parallel_boundary_condition_files</a> (bc_type)</td></tr>
182-
<tr class="memdesc:ab6281588667a9843f9e3829c2a68c851"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read boundary condition type and buffer data from per-rank parallel files using MPI I/O. <br /></td></tr>
181+
<tr class="memitem:a913e50a8381702d2886b419f225a78b9" id="r_a913e50a8381702d2886b419f225a78b9"><td class="memItemLeft">subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__io.html#a913e50a8381702d2886b419f225a78b9">m_boundary_io::s_read_parallel_boundary_condition_files</a> (bc_type, strict)</td></tr>
182+
<tr class="memdesc:a913e50a8381702d2886b419f225a78b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read boundary condition type and buffer data from per-rank parallel files using MPI I/O. <br /></td></tr>
183+
<tr class="memitem:ad452cf79e517a22fdf7ee3fd757bca58" id="r_ad452cf79e517a22fdf7ee3fd757bca58"><td class="memItemLeft">impure subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__io.html#ad452cf79e517a22fdf7ee3fd757bca58">m_boundary_io::s_check_bc_decomposition</a> (file_loc, strict)</td></tr>
184+
<tr class="memdesc:ad452cf79e517a22fdf7ee3fd757bca58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check that the per-rank boundary files in file_loc were written for this run's decomposition: abort if strict, else warn. They are read by rank index, so on another decomposition each rank would silently read another rank's boundary slab. Files written before decomposition.dat existed are not checked. <br /></td></tr>
183185
<tr class="memitem:a8ed3282a661e5072782b8d824a7c6646" id="r_a8ed3282a661e5072782b8d824a7c6646"><td class="memItemLeft">subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__io.html#a8ed3282a661e5072782b8d824a7c6646">m_boundary_io::s_pack_boundary_condition_buffers</a> (q_prim_vf, q_t_sf)</td></tr>
184186
<tr class="memdesc:a8ed3282a661e5072782b8d824a7c6646"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pack primitive variable boundary slices into bc_buffers arrays for serialization. <br /></td></tr>
185187
<tr class="memitem:a54cc36c0c0b8f86ec53db19e98570fc7" id="r_a54cc36c0c0b8f86ec53db19e98570fc7"><td class="memItemLeft">subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__io.html#a54cc36c0c0b8f86ec53db19e98570fc7">m_boundary_io::s_assign_default_bc_type</a> (bc_type)</td></tr>

‎post_process/m__boundary__io_8fpp_8f90.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
var m__boundary__io_8fpp_8f90 =
22
[
33
[ "m_boundary_io::s_assign_default_bc_type", "namespacem__boundary__io.html#a54cc36c0c0b8f86ec53db19e98570fc7", null ],
4+
[ "m_boundary_io::s_check_bc_decomposition", "namespacem__boundary__io.html#ad452cf79e517a22fdf7ee3fd757bca58", null ],
45
[ "m_boundary_io::s_create_mpi_types", "namespacem__boundary__io.html#a74922617e3b2c7a414056d32bc6aa14d", null ],
56
[ "m_boundary_io::s_pack_boundary_condition_buffers", "namespacem__boundary__io.html#a8ed3282a661e5072782b8d824a7c6646", null ],
6-
[ "m_boundary_io::s_read_parallel_boundary_condition_files", "namespacem__boundary__io.html#ab6281588667a9843f9e3829c2a68c851", null ],
7+
[ "m_boundary_io::s_read_parallel_boundary_condition_files", "namespacem__boundary__io.html#a913e50a8381702d2886b419f225a78b9", null ],
78
[ "m_boundary_io::s_read_serial_boundary_condition_files", "namespacem__boundary__io.html#a6bd453bc00436c7cbb2d823169f9dd10", null ],
89
[ "m_boundary_io::s_write_parallel_boundary_condition_files", "namespacem__boundary__io.html#a1b6a5f4b89c0cc5313f8f448ce1a9b2c", null ],
910
[ "m_boundary_io::s_write_serial_boundary_condition_files", "namespacem__boundary__io.html#af7a9587cc23f69c87bb9d34be4a6fec5", null ],

0 commit comments

Comments
 (0)