Skip to content

Commit a10e89e

Browse files
author
MFC Action
committed
Docs @ 5cbb962
1 parent 4acfbb6 commit a10e89e

390 files changed

Lines changed: 31221 additions & 22360 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-08</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-09</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
@@ -1462,7 +1462,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14621462
</table>
14631463
<hr />
14641464
<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>
1465-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-08</div> </div></div><!-- contents -->
1465+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-09</div> </div></div><!-- contents -->
14661466
</div><!-- PageDoc -->
14671467
</div><!-- doc-content -->
14681468
<div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,7 @@ <h3 class="doxsection"><a class="anchor" id="validate"></a>
482482
<p><b>Usage:</b> <span class="tt">./mfc.sh validate INPUT [OPTIONS]</span></p>
483483
<p><b>Arguments:</b></p>
484484
<ul>
485-
<li><span class="tt">INPUT</span> - Path to case file to validate.</li>
485+
<li><span class="tt">INPUT</span> - Path(s) to case file(s) to validate. Multiple files validate in one process (used by precheck).</li>
486486
</ul>
487487
<p><b>Options:</b></p>
488488
<table class="markdownTable">
@@ -999,7 +999,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
999999
<h3 class="doxsection"><a class="anchor" id="autotoc_md82"></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-08</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-09</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_md313"></a>
630630
<p><img src="result-2D_shockdroplet-example.png" alt="" height="400" class="inline"/></p>
631631
<p>This example case contains an automated convergence test using a 1D, two-component advection case. The case can be run by executing the bash script <span class="tt">./submitJobs.sh</span> in a terminal after enabling execution permissions with <span class="tt">chmod +x ./submitJobs.sh</span> and setting the <span class="tt">ROOT_DIR</span> and <span class="tt">MFC_DIR</span> variables. By default the script runs the case for 6 different grid resolutions with 1st, 3rd, and 5th, order spatial reconstructions. These settings can be modified by editing the variables at the top of the script. You can also run different model equations by setting the <span class="tt">ME</span> variable and different Riemann solvers by setting the <span class="tt">RS</span> variable.</p>
632632
<p>Once the simulations have been run, you can generate convergence plots with matplotlib by running <span class="tt">python3 plot.py</span> in a terminal. This will generate plots of the L1, L2, and Linf error norms and save the results to <span class="tt">errors.csv</span>.</p>
633-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-08</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-09</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
@@ -1609,7 +1609,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md434"></a>
16091609
<div class="line"> </div>
16101610
<div class="line"># Filter by type</div>
16111611
<div class="line">./mfc.sh params -t real weno</div>
1612-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-08</div> </div></div><!-- contents -->
1612+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-09</div> </div></div><!-- contents -->
16131613
</div><!-- PageDoc -->
16141614
</div><!-- doc-content -->
16151615
<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
@@ -668,7 +668,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md488"></a>
668668
<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>
669669
<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>
670670
</ul>
671-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-08</div> </div></div><!-- contents -->
671+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-09</div> </div></div><!-- contents -->
672672
</div><!-- PageDoc -->
673673
</div><!-- doc-content -->
674674
<div id="page-nav" class="page-nav-panel">

post_process/doxygen_crawl.html

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -144,33 +144,43 @@
144144
<a href="m__variables__conversion_8fpp_8f90_source.html"/>
145145
<a href="namespacem__boundary__common.html"/>
146146
<a href="namespacem__boundary__common.html#a352fa827d9dbbfb0be060dedcce86792"/>
147+
<a href="namespacem__boundary__common.html#a3ae990b28166105211eb26fe8360880c"/>
148+
<a href="namespacem__boundary__common.html#a5014d78d9f42e377a76ac3848880d79d"/>
147149
<a href="namespacem__boundary__common.html#a564aec3ec22d27138a881ca6bf54d94d"/>
150+
<a href="namespacem__boundary__common.html#a62b22c0dcabb74e7ff70f8c53a0127a7"/>
148151
<a href="namespacem__boundary__common.html#a69dbc2d02c7be259c30ea62e603f9f4b"/>
152+
<a href="namespacem__boundary__common.html#aaa280302ca5033a37f9e83f72a7bbd62"/>
149153
<a href="namespacem__boundary__common.html#abfbb20311259fa39676228027f156929"/>
154+
<a href="namespacem__boundary__common.html#ac12f933780819f49894bc843e3df0a92"/>
155+
<a href="namespacem__boundary__common.html#adc1afccea975d65f8825dd140280ade7"/>
150156
<a href="namespacem__boundary__io.html"/>
151157
<a href="namespacem__boundary__io.html#a08a01f94849046589e0337b0068adec0"/>
152158
<a href="namespacem__boundary__io.html#a1b6a5f4b89c0cc5313f8f448ce1a9b2c"/>
153-
<a href="namespacem__boundary__io.html#a1c1561e52ef2119fd1b48523c45ae2f0"/>
154-
<a href="namespacem__boundary__io.html#a231fadc5cbbb83a52954a0306dd5c4bf"/>
155159
<a href="namespacem__boundary__io.html#a358f0f61cd25c20cda6384220f38214b"/>
156-
<a href="namespacem__boundary__io.html#a38d99e155ccb0652ed708dd5a8dd0f16"/>
157160
<a href="namespacem__boundary__io.html#a54cc36c0c0b8f86ec53db19e98570fc7"/>
158161
<a href="namespacem__boundary__io.html#a6bd453bc00436c7cbb2d823169f9dd10"/>
159162
<a href="namespacem__boundary__io.html#a74922617e3b2c7a414056d32bc6aa14d"/>
160-
<a href="namespacem__boundary__io.html#a8bb3fd54063d6b92147b941583df3719"/>
161163
<a href="namespacem__boundary__io.html#a8ed3282a661e5072782b8d824a7c6646"/>
162164
<a href="namespacem__boundary__io.html#ab6281588667a9843f9e3829c2a68c851"/>
163-
<a href="namespacem__boundary__io.html#acf38966b8172d09b4c3e3bc26aca42b2"/>
164-
<a href="namespacem__boundary__io.html#adb6a0e442aa3216e2e0191fa7a0da914"/>
165165
<a href="namespacem__boundary__io.html#af7a9587cc23f69c87bb9d34be4a6fec5"/>
166166
<a href="namespacem__boundary__primitives.html"/>
167167
<a href="namespacem__boundary__primitives.html#a05ca273856b144071a18d55dc2e31ed1"/>
168+
<a href="namespacem__boundary__primitives.html#a329160cb0839032e54fd4d01a8eded30"/>
169+
<a href="namespacem__boundary__primitives.html#a4b995d226e9523496015760b69b64e46"/>
170+
<a href="namespacem__boundary__primitives.html#a55342895e5e8de409f6c701463f97b01"/>
168171
<a href="namespacem__boundary__primitives.html#a5a16ad022cc238854bb910adc2a65351"/>
172+
<a href="namespacem__boundary__primitives.html#a5be3ade20ce66a7d2ea2b43bb5a198d1"/>
173+
<a href="namespacem__boundary__primitives.html#a6794d2fd357d28efd590c1dd4e9ef6cc"/>
169174
<a href="namespacem__boundary__primitives.html#a6d251d3646237eeb340d1aa13b9ec5ed"/>
170175
<a href="namespacem__boundary__primitives.html#a882379d572d555c1b5f73fd360cb1d79"/>
171176
<a href="namespacem__boundary__primitives.html#a977f09bf86f219050a313e91f50631a7"/>
177+
<a href="namespacem__boundary__primitives.html#a99d77a99c6bbc0951fb6f1c9226f0bb6"/>
178+
<a href="namespacem__boundary__primitives.html#ac441d6b798d2523f0bfd45e779c702e3"/>
179+
<a href="namespacem__boundary__primitives.html#acb01a57c4c815a86d43a2669ddf1c766"/>
172180
<a href="namespacem__boundary__primitives.html#ad10333190190876242b9a1da980badc6"/>
173181
<a href="namespacem__boundary__primitives.html#ad26198443f21dd0000bd07e68168e697"/>
182+
<a href="namespacem__boundary__primitives.html#ad2625a2f84af16dc0459c5b421770774"/>
183+
<a href="namespacem__boundary__primitives.html#ae18204f041ac1ddafadba998425ffd9b"/>
174184
<a href="namespacem__boundary__primitives.html#af5f3a62e2d024e5e307ba669dcbfeb49"/>
175185
<a href="namespacem__boundary__primitives.html#aff77027a69840a149990776fe2432c7a"/>
176186
<a href="namespacem__checker.html"/>
@@ -679,11 +689,11 @@
679689
<a href="namespacem__mpi__common.html#a2427f77cebecdbb0d52fafc4b458b369"/>
680690
<a href="namespacem__mpi__common.html#a2e27b3212956af624c8da826f0c2c529"/>
681691
<a href="namespacem__mpi__common.html#a2e3bdaffd98ab167782c6f43f182f89e"/>
682-
<a href="namespacem__mpi__common.html#a30bc077674966874fec000b8afcbf2e9"/>
683692
<a href="namespacem__mpi__common.html#a3681f17d9e7b2cac992b6ae14aac0f15"/>
684693
<a href="namespacem__mpi__common.html#a3b287a39841538011798d6f5e59d41ac"/>
685694
<a href="namespacem__mpi__common.html#a3deaeac1e239299664faa426e15f3285"/>
686695
<a href="namespacem__mpi__common.html#a40f3c1242840a184d017acef92cce7d4"/>
696+
<a href="namespacem__mpi__common.html#a49a4131e4f0405e6bc53763ccc6ad801"/>
687697
<a href="namespacem__mpi__common.html#a4d03f5fc95657b6bec1f89221295b0cc"/>
688698
<a href="namespacem__mpi__common.html#a50d271a607262a2f55d7a00f7e692e38"/>
689699
<a href="namespacem__mpi__common.html#a564644bad898d940dc6caea3297bb424"/>

post_process/interfacem__data__input_1_1s__read__abstract__data__files.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@
168168
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
169169
<div class="textblock"><p>Subroutine for reading data files. </p>
170170

171-
<p class="definition">Definition at line <a class="el" href="m__data__input_8f90_source.html#l00028">28</a> of file <a class="el" href="m__data__input_8f90_source.html">m_data_input.f90</a>.</p>
171+
<p class="definition">Definition at line <a class="el" href="m__data__input_8f90_source.html#l00029">29</a> of file <a class="el" href="m__data__input_8f90_source.html">m_data_input.f90</a>.</p>
172172
</div><a name="doc-constructors" id="doc-constructors"></a><h2 id="header-doc-constructors" class="groupheader">Constructor &amp; Destructor Documentation</h2>
173173
<a id="a89c89545cbc2e0cf07f5885879885d0b" name="a89c89545cbc2e0cf07f5885879885d0b"></a>
174174
<h2 class="memtitle"><span class="permalink"><a href="#a89c89545cbc2e0cf07f5885879885d0b">&#9670;&#160;</a></span>s_read_abstract_data_files()</h2>
@@ -193,7 +193,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a89c89545cbc2e0cf07f58858
193193
</table>
194194
</div><div class="memdoc">
195195

196-
<p class="definition">Definition at line <a class="el" href="m__data__input_8f90_source.html#l00028">28</a> of file <a class="el" href="m__data__input_8f90_source.html">m_data_input.f90</a>.</p>
196+
<p class="definition">Definition at line <a class="el" href="m__data__input_8f90_source.html#l00029">29</a> of file <a class="el" href="m__data__input_8f90_source.html">m_data_input.f90</a>.</p>
197197

198198
</div>
199199
</div>

post_process/m__boundary__common_8fpp_8f90.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,18 @@
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>
178178
<tr class="memdesc:a352fa827d9dbbfb0be060dedcce86792"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populate the variable buffers along one direction and location, via MPI exchange for processor boundaries or by dispatching the per-cell BC routines over the boundary face. <br /></td></tr>
179+
<tr class="memitem:adc1afccea975d65f8825dd140280ade7" id="r_adc1afccea975d65f8825dd140280ade7"><td class="memItemLeft">impure subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#adc1afccea975d65f8825dd140280ade7">m_boundary_common::s_populate_capillary_buffers</a> (c_divs, bc_type, bc)</td></tr>
180+
<tr class="memdesc:adc1afccea975d65f8825dd140280ade7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populate ghost cell buffers for the color function and its divergence used in capillary surface tension. <br /></td></tr>
181+
<tr class="memitem:a3ae990b28166105211eb26fe8360880c" id="r_a3ae990b28166105211eb26fe8360880c"><td class="memItemLeft">impure subroutine&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#a3ae990b28166105211eb26fe8360880c">m_boundary_common::s_populate_capillary_bc_direction</a> (bc_dir, bc_loc, bc_bounds, bc_type_edge, c_divs)</td></tr>
182+
<tr class="memdesc:a3ae990b28166105211eb26fe8360880c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Populate ghost cell buffers for one capillary BC direction and location, via MPI exchange for processor boundaries or by dispatching the per-cell capillary BC routines over the boundary face. <br /></td></tr>
183+
<tr class="memitem:a62b22c0dcabb74e7ff70f8c53a0127a7" id="r_a62b22c0dcabb74e7ff70f8c53a0127a7"><td class="memItemLeft">impure subroutine, public&#160;</td><td class="memItemRight"><a class="el" href="namespacem__boundary__common.html#a62b22c0dcabb74e7ff70f8c53a0127a7">m_boundary_common::s_populate_f_igr_buffers</a> (bc_type, jac_sf)</td></tr>
184+
<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>
185+
<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>
186+
<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>
179191
<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>
180192
<tr class="memdesc:a69dbc2d02c7be259c30ea62e603f9f4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deallocate boundary condition buffer arrays allocated during module initialization. <br /></td></tr>
181193
</table>

post_process/m__boundary__common_8fpp_8f90.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,11 @@ var m__boundary__common_8fpp_8f90 =
33
[ "m_boundary_common::s_finalize_boundary_common_module", "namespacem__boundary__common.html#a69dbc2d02c7be259c30ea62e603f9f4b", null ],
44
[ "m_boundary_common::s_initialize_boundary_common_module", "namespacem__boundary__common.html#a564aec3ec22d27138a881ca6bf54d94d", null ],
55
[ "m_boundary_common::s_populate_bc_direction", "namespacem__boundary__common.html#a352fa827d9dbbfb0be060dedcce86792", null ],
6+
[ "m_boundary_common::s_populate_capillary_bc_direction", "namespacem__boundary__common.html#a3ae990b28166105211eb26fe8360880c", null ],
7+
[ "m_boundary_common::s_populate_capillary_buffers", "namespacem__boundary__common.html#adc1afccea975d65f8825dd140280ade7", null ],
8+
[ "m_boundary_common::s_populate_f_igr_bc_direction", "namespacem__boundary__common.html#a5014d78d9f42e377a76ac3848880d79d", null ],
9+
[ "m_boundary_common::s_populate_f_igr_buffers", "namespacem__boundary__common.html#a62b22c0dcabb74e7ff70f8c53a0127a7", null ],
10+
[ "m_boundary_common::s_populate_grid_bc_direction", "namespacem__boundary__common.html#ac12f933780819f49894bc843e3df0a92", null ],
11+
[ "m_boundary_common::s_populate_grid_variables_buffers", "namespacem__boundary__common.html#aaa280302ca5033a37f9e83f72a7bbd62", null ],
612
[ "m_boundary_common::s_populate_variables_buffers", "namespacem__boundary__common.html#abfbb20311259fa39676228027f156929", null ]
713
];

0 commit comments

Comments
 (0)