Skip to content

Commit 04aa6b5

Browse files
author
MFC Action
committed
Docs @ 3291cce
1 parent 2fe9b24 commit 04aa6b5

1,111 files changed

Lines changed: 88743 additions & 90690 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
@@ -427,7 +427,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
427427
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
428428
</ol>
429429
<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>
430-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-29</div> </div></div><!-- contents -->
430+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-30</div> </div></div><!-- contents -->
431431
</div><!-- PageDoc -->
432432
</div><!-- doc-content -->
433433
<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
@@ -1460,7 +1460,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14601460
</table>
14611461
<hr />
14621462
<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>
1463-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-29</div> </div></div><!-- contents -->
1463+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-30</div> </div></div><!-- contents -->
14641464
</div><!-- PageDoc -->
14651465
</div><!-- doc-content -->
14661466
<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
@@ -999,7 +999,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md82"></a>
999999
<h3 class="doxsection"><a class="anchor" id="autotoc_md83"></a>
10001000
Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
10011001
<p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
1002-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-29</div> </div></div><!-- contents -->
1002+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-30</div> </div></div><!-- contents -->
10031003
</div><!-- PageDoc -->
10041004
</div><!-- doc-content -->
10051005
<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
@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md312"></a>
630630
<ul>
631631
<li>Papanastasiou, T. C. (1987). Flows of materials with yield. <em>J. Rheol.</em> 31, 385.</li>
632632
</ul>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-29</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-30</div> </div></div><!-- contents -->
634634
</div><!-- PageDoc -->
635635
</div><!-- doc-content -->
636636
<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
@@ -1775,7 +1775,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md448"></a>
17751775
<div class="line"> </div>
17761776
<div class="line"># Filter by type</div>
17771777
<div class="line">./mfc.sh params -t real weno</div>
1778-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-29</div> </div></div><!-- contents -->
1778+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-30</div> </div></div><!-- contents -->
17791779
</div><!-- PageDoc -->
17801780
</div><!-- doc-content -->
17811781
<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
@@ -691,7 +691,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md505"></a>
691691
<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>
692692
<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>
693693
</ul>
694-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-29</div> </div></div><!-- contents -->
694+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-30</div> </div></div><!-- contents -->
695695
</div><!-- PageDoc -->
696696
</div><!-- doc-content -->
697697
<div id="page-nav" class="page-nav-panel">

post_process/doxygen_crawl.html

Lines changed: 45 additions & 28 deletions
Large diffs are not rendered by default.

post_process/m__boundary__common_8fpp_8f90.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,8 @@
170170
</table><table class="memberdecls">
171171
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
172172
Functions/Subroutines</h2></td></tr>
173-
<tr class="memitem:a564aec3ec22d27138a881ca6bf54d94d" id="r_a564aec3ec22d27138a881ca6bf54d94d"><td class="memItemLeft">impure subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#a564aec3ec22d27138a881ca6bf54d94d">m_boundary_common::s_initialize_boundary_common_module</a> ()</td></tr>
174-
<tr class="memdesc:a564aec3ec22d27138a881ca6bf54d94d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate and set up boundary condition buffer arrays for all coordinate directions. <br /></td></tr>
173+
<tr class="memitem:aed8aa67fa1841280e058e1cbe3860c8f" id="r_aed8aa67fa1841280e058e1cbe3860c8f"><td class="memItemLeft">impure subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#aed8aa67fa1841280e058e1cbe3860c8f">m_boundary_common::s_initialize_boundary_common_module</a> (use_dirichlet_buffers)</td></tr>
174+
<tr class="memdesc:aed8aa67fa1841280e058e1cbe3860c8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate and set up boundary condition buffer arrays for all coordinate directions. <br /></td></tr>
175175
<tr class="memitem:abfbb20311259fa39676228027f156929" id="r_abfbb20311259fa39676228027f156929"><td class="memItemLeft">impure subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#abfbb20311259fa39676228027f156929">m_boundary_common::s_populate_variables_buffers</a> (bc_type, q_prim_vf, pb_in, mv_in, q_t_sf)</td></tr>
176176
<tr class="memdesc:abfbb20311259fa39676228027f156929"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populate the buffers of the primitive variables based on the selected boundary conditions. <br /></td></tr>
177177
<tr class="memitem:a352fa827d9dbbfb0be060dedcce86792" id="r_a352fa827d9dbbfb0be060dedcce86792"><td class="memItemLeft">impure subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#a352fa827d9dbbfb0be060dedcce86792">m_boundary_common::s_populate_bc_direction</a> (bc_dir, bc_loc, bc_bounds, bc_type_edge, q_prim_vf, pb_in, mv_in, q_t_sf)</td></tr>
@@ -184,10 +184,10 @@
184184
<tr class="memdesc:a62b22c0dcabb74e7ff70f8c53a0127a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populate ghost cell buffers for the Jacobian scalar field used in the IGR elliptic solver. <br /></td></tr>
185185
<tr class="memitem:a5014d78d9f42e377a76ac3848880d79d" id="r_a5014d78d9f42e377a76ac3848880d79d"><td class="memItemLeft">impure subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#a5014d78d9f42e377a76ac3848880d79d">m_boundary_common::s_populate_f_igr_bc_direction</a> (bc_dir, bc_loc, bc_bounds, bc_type_edge, jac_sf)</td></tr>
186186
<tr class="memdesc:a5014d78d9f42e377a76ac3848880d79d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populate ghost cell buffers for one IGR Jacobian BC direction and location, via MPI exchange for processor boundaries or by dispatching the per-cell IGR Jacobian BC routines over the boundary face. <br /></td></tr>
187-
<tr class="memitem:aaa280302ca5033a37f9e83f72a7bbd62" id="r_aaa280302ca5033a37f9e83f72a7bbd62"><td class="memItemLeft">subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#aaa280302ca5033a37f9e83f72a7bbd62">m_boundary_common::s_populate_grid_variables_buffers</a></td></tr>
188-
<tr class="memdesc:aaa280302ca5033a37f9e83f72a7bbd62"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populate the buffers of the grid variables, which are constituted of the cell-boundary locations and cell-width distributions, based on the boundary conditions. <br /></td></tr>
189-
<tr class="memitem:ac12f933780819f49894bc843e3df0a92" id="r_ac12f933780819f49894bc843e3df0a92"><td class="memItemLeft">subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#ac12f933780819f49894bc843e3df0a92">m_boundary_common::s_populate_grid_bc_direction</a> (bc_dir, bc_loc, bc_bounds, offset_dir)</td></tr>
190-
<tr class="memdesc:ac12f933780819f49894bc843e3df0a92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populate grid variable buffers (cell widths and centers) for one direction and location. <br /></td></tr>
187+
<tr class="memitem:a02e871669798b1ddc0c433ea6f3e460d" id="r_a02e871669798b1ddc0c433ea6f3e460d"><td class="memItemLeft">subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#a02e871669798b1ddc0c433ea6f3e460d">m_boundary_common::s_populate_grid_variables_buffers</a> (x_cb_in, x_cc_in, dx_in, x_offset, y_offset, z_offset, y_cb_in, y_cc_in, dy_in, z_cb_in, z_cc_in, dz_in, global_bounds)</td></tr>
188+
<tr class="memdesc:a02e871669798b1ddc0c433ea6f3e460d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populate the buffers of the grid variables, which are constituted of the cell-boundary locations and cell-width distributions, based on the boundary conditions. <br /></td></tr>
189+
<tr class="memitem:a172afbc666d73bf565d7d4f4178b7783" id="r_a172afbc666d73bf565d7d4f4178b7783"><td class="memItemLeft">subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#a172afbc666d73bf565d7d4f4178b7783">m_boundary_common::s_populate_grid_bc_direction</a> (cell_boundaries, cell_centers, cell_widths, num_cells, bc_dir, bc_loc, bc_bounds, offset)</td></tr>
190+
<tr class="memdesc:a172afbc666d73bf565d7d4f4178b7783"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populate cell-boundary, cell-center, and cell-width buffers for one coordinate direction. <br /></td></tr>
191191
<tr class="memitem:a69dbc2d02c7be259c30ea62e603f9f4b" id="r_a69dbc2d02c7be259c30ea62e603f9f4b"><td class="memItemLeft">subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#a69dbc2d02c7be259c30ea62e603f9f4b">m_boundary_common::s_finalize_boundary_common_module</a> ()</td></tr>
192192
<tr class="memdesc:a69dbc2d02c7be259c30ea62e603f9f4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deallocate boundary condition buffer arrays allocated during module initialization. <br /></td></tr>
193193
<tr class="memitem:ae7806a27c1ae0de40695f63fe66887f8" id="r_ae7806a27c1ae0de40695f63fe66887f8"><td class="memItemLeft">impure subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#ae7806a27c1ae0de40695f63fe66887f8">m_boundary_common::s_populate_beta_buffers</a> (q_beta, kahan_comp, bc_type, nvar)</td></tr>

post_process/m__boundary__common_8fpp_8f90.js

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)