Skip to content

Commit a2081d2

Browse files
author
MFC Action
committed
Docs @ ca26c4c
1 parent d3e35bb commit a2081d2

9 files changed

Lines changed: 491 additions & 475 deletions

documentation/architecture.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
429429
<li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
430430
</ol>
431431
<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>
432-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-17</div> </div></div><!-- contents -->
432+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-18</div> </div></div><!-- contents -->
433433
</div><!-- PageDoc -->
434434
</div><!-- doc-content -->
435435
<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
@@ -1494,7 +1494,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14941494
</table>
14951495
<hr />
14961496
<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>
1497-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-17</div> </div></div><!-- contents -->
1497+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-18</div> </div></div><!-- contents -->
14981498
</div><!-- PageDoc -->
14991499
</div><!-- doc-content -->
15001500
<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-08-17</div> </div></div><!-- contents -->
1002+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-18</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
<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-08-17</div> </div></div><!-- contents -->
633+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-18</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
@@ -1750,7 +1750,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md447"></a>
17501750
<div class="line"> </div>
17511751
<div class="line"># Filter by type</div>
17521752
<div class="line">./mfc.sh params -t real weno</div>
1753-
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-17</div> </div></div><!-- contents -->
1753+
</div><!-- fragment --><div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-18</div> </div></div><!-- contents -->
17541754
</div><!-- PageDoc -->
17551755
</div><!-- doc-content -->
17561756
<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
@@ -705,7 +705,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md504"></a>
705705
<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>
706706
<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>
707707
</ul>
708-
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-17</div> </div></div><!-- contents -->
708+
<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-08-18</div> </div></div><!-- contents -->
709709
</div><!-- PageDoc -->
710710
</div><!-- doc-content -->
711711
<div id="page-nav" class="page-nav-panel">

simulation/m__data__output_8fpp_8f90_source.html

Lines changed: 479 additions & 463 deletions
Large diffs are not rendered by default.

simulation/m__start__up_8fpp_8f90_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2665,7 +2665,7 @@
26652665
<div class="ttc" id="anamespacem__constants_html_aebabd2fb9ed006bca8fefcc295b1547d"><div class="ttname"><a href="namespacem__constants.html#aebabd2fb9ed006bca8fefcc295b1547d">m_constants::model_eqns_6eq</a></div><div class="ttdeci">integer, parameter model_eqns_6eq</div><div class="ttdef"><b>Definition</b> <a href="m__constants_8fpp_8f90_source.html#l00139">m_constants.fpp.f90:139</a></div></div>
26662666
<div class="ttc" id="anamespacem__constants_html_af02e45a1fd278a47990b046d12a3bf7c"><div class="ttname"><a href="namespacem__constants.html#af02e45a1fd278a47990b046d12a3bf7c">m_constants::bc_periodic</a></div><div class="ttdeci">integer, parameter bc_periodic</div><div class="ttdef"><b>Definition</b> <a href="m__constants_8fpp_8f90_source.html#l00099">m_constants.fpp.f90:99</a></div></div>
26672667
<div class="ttc" id="anamespacem__data__output_html"><div class="ttname"><a href="namespacem__data__output.html">m_data_output</a></div><div class="ttdoc">Writes solution data, run-time stability diagnostics (ICFL, VCFL, CCFL, Rc), and probe/center-of-mass...</div><div class="ttdef"><b>Definition</b> <a href="m__data__output_8fpp_8f90_source.html#l00334">m_data_output.fpp.f90:334</a></div></div>
2668-
<div class="ttc" id="anamespacem__data__output_html_a795efa6dc563a04a903c13a960089a58"><div class="ttname"><a href="namespacem__data__output.html#a795efa6dc563a04a903c13a960089a58">m_data_output::s_initialize_data_output_module</a></div><div class="ttdeci">impure subroutine, public s_initialize_data_output_module</div><div class="ttdoc">Initialize the data output module.</div><div class="ttdef"><b>Definition</b> <a href="m__data__output_8fpp_8f90_source.html#l02056">m_data_output.fpp.f90:2057</a></div></div>
2668+
<div class="ttc" id="anamespacem__data__output_html_a795efa6dc563a04a903c13a960089a58"><div class="ttname"><a href="namespacem__data__output.html#a795efa6dc563a04a903c13a960089a58">m_data_output::s_initialize_data_output_module</a></div><div class="ttdeci">impure subroutine, public s_initialize_data_output_module</div><div class="ttdoc">Initialize the data output module.</div><div class="ttdef"><b>Definition</b> <a href="m__data__output_8fpp_8f90_source.html#l02072">m_data_output.fpp.f90:2073</a></div></div>
26692669
<div class="ttc" id="anamespacem__data__output_html_a9eea8de093f055adb3b786bff3cab2d8"><div class="ttname"><a href="namespacem__data__output.html#a9eea8de093f055adb3b786bff3cab2d8">m_data_output::s_write_data_files</a></div><div class="ttdeci">impure subroutine, public s_write_data_files(q_cons_vf, q_t_sf, q_prim_vf, t_step, bc_type, beta)</div><div class="ttdoc">Write data files. Dispatch subroutine that replaces procedure pointer.</div><div class="ttdef"><b>Definition</b> <a href="m__data__output_8fpp_8f90_source.html#l00383">m_data_output.fpp.f90:384</a></div></div>
26702670
<div class="ttc" id="anamespacem__data__output_html_ad7b2f63ea430ad1518152658c5488dcf"><div class="ttname"><a href="namespacem__data__output.html#ad7b2f63ea430ad1518152658c5488dcf">m_data_output::s_write_ib_state_file</a></div><div class="ttdeci">impure subroutine, public s_write_ib_state_file(time_step)</div><div class="ttdoc">Writes IB state records to restart_data/ib_state.dat. Must be called only on rank 0.</div><div class="ttdef"><b>Definition</b> <a href="m__data__output_8fpp_8f90_source.html#l01474">m_data_output.fpp.f90:1475</a></div></div>
26712671
<div class="ttc" id="anamespacem__derived__types_html"><div class="ttname"><a href="namespacem__derived__types.html">m_derived_types</a></div><div class="ttdoc">Shared derived types for field data, patch geometry, bubble dynamics, and MPI I/O structures.</div><div class="ttdef"><b>Definition</b> <a href="m__derived__types_8fpp_8f90_source.html#l00323">m_derived_types.fpp.f90:323</a></div></div>

simulation/namespacem__data__output.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac19d0dbc33765e1f78a4e1e2
235235

236236
<p>Closes communication files. </p>
237237

238-
<p class="definition">Definition at line <a class="el" href="m__data__output_8fpp_8f90_source.html#l02034">2034</a> of file <a class="el" href="m__data__output_8fpp_8f90_source.html">m_data_output.fpp.f90</a>.</p>
238+
<p class="definition">Definition at line <a class="el" href="m__data__output_8fpp_8f90_source.html#l02050">2050</a> of file <a class="el" href="m__data__output_8fpp_8f90_source.html">m_data_output.fpp.f90</a>.</p>
239239

240240
</div>
241241
</div>
@@ -253,7 +253,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#abeb42ab4ffa4110da8e14af7
253253

254254
<p>Closes probe files. </p>
255255

256-
<p class="definition">Definition at line <a class="el" href="m__data__output_8fpp_8f90_source.html#l02045">2045</a> of file <a class="el" href="m__data__output_8fpp_8f90_source.html">m_data_output.fpp.f90</a>.</p>
256+
<p class="definition">Definition at line <a class="el" href="m__data__output_8fpp_8f90_source.html#l02061">2061</a> of file <a class="el" href="m__data__output_8fpp_8f90_source.html">m_data_output.fpp.f90</a>.</p>
257257

258258
</div>
259259
</div>
@@ -271,7 +271,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a897ce85a3bae7848132ce991
271271

272272
<p>Write footer with stability criteria extrema and run-time to the information file, then close it. </p>
273273

274-
<p class="definition">Definition at line <a class="el" href="m__data__output_8fpp_8f90_source.html#l02012">2012</a> of file <a class="el" href="m__data__output_8fpp_8f90_source.html">m_data_output.fpp.f90</a>.</p>
274+
<p class="definition">Definition at line <a class="el" href="m__data__output_8fpp_8f90_source.html#l02028">2028</a> of file <a class="el" href="m__data__output_8fpp_8f90_source.html">m_data_output.fpp.f90</a>.</p>
275275

276276
</div>
277277
</div>
@@ -289,7 +289,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a81d3138233e0f1a797c930db
289289

290290
<p>Module deallocation and/or disassociation procedures. </p>
291291

292-
<p class="definition">Definition at line <a class="el" href="m__data__output_8fpp_8f90_source.html#l02121">2121</a> of file <a class="el" href="m__data__output_8fpp_8f90_source.html">m_data_output.fpp.f90</a>.</p>
292+
<p class="definition">Definition at line <a class="el" href="m__data__output_8fpp_8f90_source.html#l02137">2137</a> of file <a class="el" href="m__data__output_8fpp_8f90_source.html">m_data_output.fpp.f90</a>.</p>
293293

294294
</div>
295295
</div>
@@ -307,7 +307,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a795efa6dc563a04a903c13a9
307307

308308
<p>Initialize the data output module. </p>
309309

310-
<p class="definition">Definition at line <a class="el" href="m__data__output_8fpp_8f90_source.html#l02056">2056</a> of file <a class="el" href="m__data__output_8fpp_8f90_source.html">m_data_output.fpp.f90</a>.</p>
310+
<p class="definition">Definition at line <a class="el" href="m__data__output_8fpp_8f90_source.html#l02072">2072</a> of file <a class="el" href="m__data__output_8fpp_8f90_source.html">m_data_output.fpp.f90</a>.</p>
311311
<div class="dynheader">
312312
Here is the caller graph for this function:</div>
313313
<div class="dyncontent">

0 commit comments

Comments
 (0)