Docs @ 2b1087c

Author: MFC Action

documentation/architecture.html

@@ -427,7 +427,7 @@ <h1 class="doxsection"><a class="anchor" id="autotoc_md13"></a>
 <li><b>Add the module to <span class="tt">docs/module_categories.json</span></b> so it appears in this page</li>
 </ol>
 <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>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-07</div> </div></div><!-- contents -->
+<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 -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/case.html

@@ -392,7 +392,7 @@ <h4 class="doxsection"><a class="anchor" id="autotoc_md20"></a>
 <li><span class="tt">case(270)</span>: Extrude 1D data to 2D domain</li>
 <li><span class="tt">case(370)</span>: Extrude 2D data to 3D domain</li>
 </ul>
-<p>Setup: Only requires specifying <span class="tt">init_dir</span> and filename pattern via <span class="tt">zeros_default</span>. Grid dimensions are automatically detected from the data files. Implementation: All variables and file handling are managed in <span class="tt">src/common/include/ExtrusionHardcodedIC.fpp</span> with no manual grid configuration needed. Usage: Ideal for initializing simulations from lower-dimensional solutions, enabling users to add perturbations or modifications to the base extruded fields for flow instability studies.</p>
+<p>Setup: Only requires specifying <span class="tt">files_dir</span> and filename pattern via <span class="tt">file_extension</span>. The files are located, for example, at <span class="tt">examples/1D_flamelet/IC</span>, and their format is <span class="tt">prim.XX.YY.file_extension.dat</span>. Implementation: All variables and file handling are managed in the <span class="tt">case.py</span> file of the simulation. Usage: Ideal for initializing simulations from lower-dimensional solutions, enabling users to add perturbations or modifications to the base extruded fields for flow instability studies.</p>
 <h4 class="doxsection"><a class="anchor" id="autotoc_md22"></a>
 Parameter Descriptions</h4>
 <ul>

documentation/case_constraints.html

@@ -1462,7 +1462,7 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
 </table>
 <hr  />
 <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>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-07</div> </div></div><!-- contents -->
+<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 -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

@@ -999,7 +999,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md81"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md82"></a>
 Debug Logging (<span class="tt">-d, --debug-log</span>)</h3>
 <p>Enables debug logging for the Python toolchain (mfc.sh internals). This is for troubleshooting the build system, not the MFC simulation code.</p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-07</div> </div></div><!-- contents -->
+<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 -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/doxygen_crawl.html

@@ -414,12 +414,12 @@
 <a href="gpuParallelization.html#autotoc_md372"/>
 <a href="graph_legend.html"/>
 <a href="index.html"/>
-<a href="index.html#autotoc_md486"/>
-<a href="index.html#autotoc_md487"/>
-<a href="index.html#autotoc_md488"/>
 <a href="index.html#autotoc_md489"/>
 <a href="index.html#autotoc_md490"/>
 <a href="index.html#autotoc_md491"/>
+<a href="index.html#autotoc_md492"/>
+<a href="index.html#autotoc_md493"/>
+<a href="index.html#autotoc_md494"/>
 <a href="pages.html"/>
 <a href="papers.html"/>
 <a href="papers.html#autotoc_md373"/>
@@ -525,84 +525,83 @@
 <a href="physics_constraints.html#autotoc_md483"/>
 <a href="physics_constraints.html#autotoc_md484"/>
 <a href="physics_constraints.html#autotoc_md485"/>
+<a href="physics_constraints.html#autotoc_md487"/>
+<a href="physics_constraints.html#autotoc_md488"/>
 <a href="running.html"/>
-<a href="running.html#autotoc_md492"/>
-<a href="running.html#autotoc_md493"/>
 <a href="running.html#autotoc_md495"/>
-<a href="running.html#autotoc_md497"/>
+<a href="running.html#autotoc_md496"/>
 <a href="running.html#autotoc_md498"/>
-<a href="running.html#autotoc_md499"/>
 <a href="running.html#autotoc_md500"/>
 <a href="running.html#autotoc_md501"/>
 <a href="running.html#autotoc_md502"/>
 <a href="running.html#autotoc_md503"/>
 <a href="running.html#autotoc_md504"/>
 <a href="running.html#autotoc_md505"/>
+<a href="running.html#autotoc_md506"/>
 <a href="running.html#autotoc_md507"/>
 <a href="running.html#autotoc_md508"/>
-<a href="running.html#autotoc_md509"/>
 <a href="running.html#autotoc_md510"/>
 <a href="running.html#autotoc_md511"/>
 <a href="running.html#autotoc_md512"/>
+<a href="running.html#autotoc_md513"/>
 <a href="running.html#autotoc_md514"/>
-<a href="running.html#autotoc_md516"/>
+<a href="running.html#autotoc_md515"/>
+<a href="running.html#autotoc_md517"/>
+<a href="running.html#autotoc_md519"/>
 <a href="testing.html"/>
-<a href="testing.html#autotoc_md517"/>
-<a href="testing.html#autotoc_md518"/>
-<a href="testing.html#autotoc_md519"/>
+<a href="testing.html#autotoc_md520"/>
+<a href="testing.html#autotoc_md521"/>
+<a href="testing.html#autotoc_md522"/>
 <a href="troubleshooting.html"/>
-<a href="troubleshooting.html#autotoc_md520"/>
-<a href="troubleshooting.html#autotoc_md521"/>
-<a href="troubleshooting.html#autotoc_md522"/>
 <a href="troubleshooting.html#autotoc_md523"/>
 <a href="troubleshooting.html#autotoc_md524"/>
+<a href="troubleshooting.html#autotoc_md525"/>
 <a href="troubleshooting.html#autotoc_md526"/>
 <a href="troubleshooting.html#autotoc_md527"/>
-<a href="troubleshooting.html#autotoc_md528"/>
 <a href="troubleshooting.html#autotoc_md529"/>
+<a href="troubleshooting.html#autotoc_md530"/>
 <a href="troubleshooting.html#autotoc_md531"/>
 <a href="troubleshooting.html#autotoc_md532"/>
-<a href="troubleshooting.html#autotoc_md533"/>
 <a href="troubleshooting.html#autotoc_md534"/>
 <a href="troubleshooting.html#autotoc_md535"/>
 <a href="troubleshooting.html#autotoc_md536"/>
+<a href="troubleshooting.html#autotoc_md537"/>
 <a href="troubleshooting.html#autotoc_md538"/>
 <a href="troubleshooting.html#autotoc_md539"/>
-<a href="troubleshooting.html#autotoc_md540"/>
 <a href="troubleshooting.html#autotoc_md541"/>
 <a href="troubleshooting.html#autotoc_md542"/>
+<a href="troubleshooting.html#autotoc_md543"/>
 <a href="troubleshooting.html#autotoc_md544"/>
 <a href="troubleshooting.html#autotoc_md545"/>
-<a href="troubleshooting.html#autotoc_md546"/>
 <a href="troubleshooting.html#autotoc_md547"/>
 <a href="troubleshooting.html#autotoc_md548"/>
 <a href="troubleshooting.html#autotoc_md549"/>
+<a href="troubleshooting.html#autotoc_md550"/>
 <a href="troubleshooting.html#autotoc_md551"/>
 <a href="troubleshooting.html#autotoc_md552"/>
-<a href="troubleshooting.html#autotoc_md553"/>
 <a href="troubleshooting.html#autotoc_md554"/>
+<a href="troubleshooting.html#autotoc_md555"/>
 <a href="troubleshooting.html#autotoc_md556"/>
 <a href="troubleshooting.html#autotoc_md557"/>
-<a href="troubleshooting.html#autotoc_md558"/>
 <a href="troubleshooting.html#autotoc_md559"/>
 <a href="troubleshooting.html#autotoc_md560"/>
 <a href="troubleshooting.html#autotoc_md561"/>
+<a href="troubleshooting.html#autotoc_md562"/>
 <a href="troubleshooting.html#autotoc_md563"/>
 <a href="troubleshooting.html#autotoc_md564"/>
-<a href="troubleshooting.html#autotoc_md565"/>
 <a href="troubleshooting.html#autotoc_md566"/>
 <a href="troubleshooting.html#autotoc_md567"/>
+<a href="troubleshooting.html#autotoc_md568"/>
 <a href="troubleshooting.html#autotoc_md569"/>
 <a href="troubleshooting.html#autotoc_md570"/>
-<a href="troubleshooting.html#autotoc_md571"/>
 <a href="troubleshooting.html#autotoc_md572"/>
 <a href="troubleshooting.html#autotoc_md573"/>
+<a href="troubleshooting.html#autotoc_md574"/>
 <a href="troubleshooting.html#autotoc_md575"/>
+<a href="troubleshooting.html#autotoc_md576"/>
+<a href="troubleshooting.html#autotoc_md578"/>
 <a href="visualization.html"/>
-<a href="visualization.html#autotoc_md576"/>
-<a href="visualization.html#autotoc_md578"/>
 <a href="visualization.html#autotoc_md579"/>
-<a href="visualization.html#autotoc_md580"/>
 <a href="visualization.html#autotoc_md581"/>
 <a href="visualization.html#autotoc_md582"/>
 <a href="visualization.html#autotoc_md583"/>
@@ -613,13 +612,16 @@
 <a href="visualization.html#autotoc_md588"/>
 <a href="visualization.html#autotoc_md589"/>
 <a href="visualization.html#autotoc_md590"/>
+<a href="visualization.html#autotoc_md591"/>
 <a href="visualization.html#autotoc_md592"/>
 <a href="visualization.html#autotoc_md593"/>
-<a href="visualization.html#autotoc_md594"/>
 <a href="visualization.html#autotoc_md595"/>
 <a href="visualization.html#autotoc_md596"/>
 <a href="visualization.html#autotoc_md597"/>
 <a href="visualization.html#autotoc_md598"/>
 <a href="visualization.html#autotoc_md599"/>
+<a href="visualization.html#autotoc_md600"/>
+<a href="visualization.html#autotoc_md601"/>
+<a href="visualization.html#autotoc_md602"/>
 </body>
 </html>

documentation/examples.html

@@ -630,7 +630,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md313"></a>
 <p><img src="result-2D_shockdroplet-example.png" alt="" height="400" class="inline"/></p>
 <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>
 <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>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-07-07</div> </div></div><!-- contents -->
+<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 -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/index.html

@@ -158,15 +158,15 @@
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><p>Welcome to the Multi-component Flow Code (MFC) documentation.</p>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md486"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md489"></a>
 Getting Started</h2>
 <ul>
 <li><a class="el" href="getting-started.html" title="Getting Started">Getting Started</a> - Installation and first steps</li>
 <li><a class="el" href="running.html" title="Running">Running</a> - How to run simulations (interactive, batch, GPU)</li>
 <li><a class="el" href="case.html" title="Case Files">Case Files</a> - Setting up input files</li>
 <li><a class="el" href="testing.html" title="Testing">Testing</a> - Running the test suite</li>
 </ul>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md487"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md490"></a>
 Reference</h2>
 <ul>
 <li><a class="el" href="equations.html" title="Equations">Equations</a> - Comprehensive equations reference</li>
@@ -175,13 +175,13 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md487"></a>
 <li><a class="el" href="case_constraints.html" title="Case Creator Guide">Case Creator Guide</a> - Feature compatibility</li>
 <li><a class="el" href="physics_constraints.html" title="Physics Constraints">Physics Constraints</a> - Mathematical basis for validation rules</li>
 </ul>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md488"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md491"></a>
 Examples &amp; Visualization</h2>
 <ul>
 <li><a class="el" href="examples.html" title="Example Cases">Example Cases</a> - Sample simulations</li>
 <li><a class="el" href="visualization.html" title="Flow visualization">Flow Visualization</a> - Post-processing</li>
 </ul>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md489"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md492"></a>
 Advanced Topics</h2>
 <ul>
 <li><a class="el" href="architecture.html" title="Code Architecture">Code Architecture</a> - How the source code is organized, data flow, and module map</li>
@@ -190,13 +190,13 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md489"></a>
 <li><a class="el" href="docker.html" title="Containers">Containers</a> - Docker usage</li>
 <li><a class="el" href="troubleshooting.html" title="Troubleshooting Guide">Troubleshooting</a> - Debugging and common issues</li>
 </ul>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md490"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md493"></a>
 Development</h2>
 <ul>
 <li><a class="el" href="contributing.html" title="Contributing">Contributing</a> - Developer guide and coding standards</li>
 <li><a href="../api/index.html">API Documentation</a> - Source code reference for all three components</li>
 </ul>
-<h2 class="doxsection"><a class="anchor" id="autotoc_md491"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md494"></a>
 About</h2>
 <ul>
 <li><a class="el" href="papers.html" title="Papers">Papers</a> - Publications using MFC</li>