Docs @ 55e62be

Author: MFC Action

documentation/architecture.html

@@ -311,7 +311,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md8"></a>
 <tr class="markdownTableHead">
 <th class="markdownTableHeadNone">Module  </th><th class="markdownTableHeadNone">Role  </th></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyNone"><span class="tt">m_cbc</span>  </td><td class="markdownTableBodyNone">Characteristic boundary conditions (CBC) for slip walls, non-reflecting subsonic inflow/outflow, and supersonic boundaries  </td></tr>
+<td class="markdownTableBodyNone"><span class="tt">m_cbc</span>  </td><td class="markdownTableBodyNone">Characteristic boundary conditions (CBCs) for slip walls, non-reflecting subsonic inflow/outflow, and supersonic boundaries  </td></tr>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyNone"><span class="tt">m_compute_cbc</span>  </td><td class="markdownTableBodyNone">Characteristic boundary condition (CBC) computations for subsonic inflow, outflow, and slip walls  </td></tr>
 <tr class="markdownTableRowOdd">
@@ -429,7 +429,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-09-14</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-15</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/case.html

@@ -1597,17 +1597,24 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md39"></a>
 <tr class="markdownTableRowEven">
 <td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%vel_in</span>  </td><td class="markdownTableBodyCenter">Real Array  </td><td class="markdownTableBodyLeft">Inflow velocities in x, y and z directions  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%vel_out</span>  </td><td class="markdownTableBodyCenter">Real Array  </td><td class="markdownTableBodyLeft">Outflow velocities in x, y and z directions  </td></tr>
+<td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%vel_in_ramp</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Duration of a smooth start-up of the inflow velocity (0 = none)  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%pres_in</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Inflow pressure  </td></tr>
+<td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%vel_in_t0</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Time at which that ramp begins  </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%pres_out</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Outflow pressure  </td></tr>
+<td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%vel_in_frac0</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Fraction of the final inflow velocity held before the ramp  </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%alpha_rho_in</span>  </td><td class="markdownTableBodyCenter">Real Array  </td><td class="markdownTableBodyLeft">Inflow density  </td></tr>
+<td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%vel_out</span>  </td><td class="markdownTableBodyCenter">Real Array  </td><td class="markdownTableBodyLeft">Outflow velocities in x, y and z directions  </td></tr>
 <tr class="markdownTableRowOdd">
+<td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%pres_in</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Inflow pressure  </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%pres_out</span>  </td><td class="markdownTableBodyCenter">Real  </td><td class="markdownTableBodyLeft">Outflow pressure  </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%alpha_rho_in</span>  </td><td class="markdownTableBodyCenter">Real Array  </td><td class="markdownTableBodyLeft">Inflow density  </td></tr>
+<tr class="markdownTableRowEven">
 <td class="markdownTableBodyRight"><span class="tt">bc_[x,y,z]%alpha_in</span>  </td><td class="markdownTableBodyCenter">Real Array  </td><td class="markdownTableBodyLeft">Inflow void fraction  </td></tr>
 </table>
 <p>This boundary condition can be used for subsonic inflow (<span class="tt">bc_[x,y,z]%[beg,end]</span> = -7) and subsonic outflow (<span class="tt">bc_[x,y,z]%[beg,end]</span> = -8) characteristic boundary conditions. These are based on Pirozzoli and Colonius <a class="el" href="citelist.html#CITEREF_pirozzoli13">[39]</a>. This enables to provide inflow and outflow conditions outside the computational domain.</p>
+<p><span class="tt">bc_[x,y,z]%vel_in_ramp</span> starts the inflow smoothly instead of holding it constant, which is what a jet or a tunnel accelerating from rest requires: the start-up is the event of interest, not a transient to be discarded. The inflow velocity is scaled by \(f(t) = f_0 + (1 - f_0)\left[1 + \tanh\left(6 (t - t_0)/\tau - 3\right)\right]/2\), with \(\tau\) = <span class="tt">vel_in_ramp</span>, \(t_0\) = <span class="tt">vel_in_t0</span> and \(f_0\) = <span class="tt">vel_in_frac0</span>, so it leaves \(f_0\) of the final velocity at \(t_0\) and is within half a percent of it at \(t_0 + \tau\). A boundary with <span class="tt">vel_in_ramp = 0</span> is held constant, as before.</p>
 <h3 class="doxsection"><a class="anchor" id="patch-types"></a>
 Patch types</h3>
 <table class="markdownTable">

documentation/case_constraints.html

@@ -1617,7 +1617,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-09-14</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-15</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/cli-reference.html

@@ -991,7 +991,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md80"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md81"></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-09-14</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-15</div> </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <div id="page-nav" class="page-nav-panel">

documentation/doxygen_crawl.html

@@ -425,12 +425,12 @@
 <a href="gpuParallelization.html#silent-failure-traps"/>
 <a href="graph_legend.html"/>
 <a href="index.html"/>
-<a href="index.html#autotoc_md518"/>
 <a href="index.html#autotoc_md519"/>
 <a href="index.html#autotoc_md520"/>
 <a href="index.html#autotoc_md521"/>
 <a href="index.html#autotoc_md522"/>
 <a href="index.html#autotoc_md523"/>
+<a href="index.html#autotoc_md524"/>
 <a href="pages.html"/>
 <a href="papers.html"/>
 <a href="papers.html#autotoc_md384"/>
@@ -528,11 +528,11 @@
 <a href="physics_constraints.html#autotoc_md480"/>
 <a href="physics_constraints.html#autotoc_md482"/>
 <a href="physics_constraints.html#autotoc_md483"/>
-<a href="physics_constraints.html#autotoc_md485"/>
+<a href="physics_constraints.html#autotoc_md484"/>
 <a href="physics_constraints.html#autotoc_md486"/>
 <a href="physics_constraints.html#autotoc_md487"/>
 <a href="physics_constraints.html#autotoc_md488"/>
-<a href="physics_constraints.html#autotoc_md490"/>
+<a href="physics_constraints.html#autotoc_md489"/>
 <a href="physics_constraints.html#autotoc_md491"/>
 <a href="physics_constraints.html#autotoc_md492"/>
 <a href="physics_constraints.html#autotoc_md493"/>
@@ -541,25 +541,25 @@
 <a href="physics_constraints.html#autotoc_md496"/>
 <a href="physics_constraints.html#autotoc_md497"/>
 <a href="physics_constraints.html#autotoc_md498"/>
-<a href="physics_constraints.html#autotoc_md500"/>
+<a href="physics_constraints.html#autotoc_md499"/>
 <a href="physics_constraints.html#autotoc_md501"/>
 <a href="physics_constraints.html#autotoc_md502"/>
 <a href="physics_constraints.html#autotoc_md503"/>
 <a href="physics_constraints.html#autotoc_md504"/>
-<a href="physics_constraints.html#autotoc_md506"/>
+<a href="physics_constraints.html#autotoc_md505"/>
 <a href="physics_constraints.html#autotoc_md507"/>
-<a href="physics_constraints.html#autotoc_md509"/>
+<a href="physics_constraints.html#autotoc_md508"/>
 <a href="physics_constraints.html#autotoc_md510"/>
 <a href="physics_constraints.html#autotoc_md511"/>
-<a href="physics_constraints.html#autotoc_md513"/>
+<a href="physics_constraints.html#autotoc_md512"/>
 <a href="physics_constraints.html#autotoc_md514"/>
-<a href="physics_constraints.html#autotoc_md516"/>
+<a href="physics_constraints.html#autotoc_md515"/>
 <a href="physics_constraints.html#autotoc_md517"/>
+<a href="physics_constraints.html#autotoc_md518"/>
 <a href="running.html"/>
-<a href="running.html#autotoc_md524"/>
 <a href="running.html#autotoc_md525"/>
-<a href="running.html#autotoc_md527"/>
-<a href="running.html#autotoc_md529"/>
+<a href="running.html#autotoc_md526"/>
+<a href="running.html#autotoc_md528"/>
 <a href="running.html#autotoc_md530"/>
 <a href="running.html#autotoc_md531"/>
 <a href="running.html#autotoc_md532"/>
@@ -568,70 +568,70 @@
 <a href="running.html#autotoc_md535"/>
 <a href="running.html#autotoc_md536"/>
 <a href="running.html#autotoc_md537"/>
-<a href="running.html#autotoc_md539"/>
+<a href="running.html#autotoc_md538"/>
 <a href="running.html#autotoc_md540"/>
 <a href="running.html#autotoc_md541"/>
 <a href="running.html#autotoc_md542"/>
 <a href="running.html#autotoc_md543"/>
 <a href="running.html#autotoc_md544"/>
-<a href="running.html#autotoc_md546"/>
-<a href="running.html#autotoc_md548"/>
+<a href="running.html#autotoc_md545"/>
+<a href="running.html#autotoc_md547"/>
+<a href="running.html#autotoc_md549"/>
 <a href="testing.html"/>
-<a href="testing.html#autotoc_md549"/>
 <a href="testing.html#autotoc_md550"/>
 <a href="testing.html#autotoc_md551"/>
+<a href="testing.html#autotoc_md552"/>
 <a href="testing.html#selection-and-execution-pitfalls"/>
 <a href="troubleshooting.html"/>
-<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_md558"/>
+<a href="troubleshooting.html#autotoc_md557"/>
 <a href="troubleshooting.html#autotoc_md559"/>
 <a href="troubleshooting.html#autotoc_md560"/>
 <a href="troubleshooting.html#autotoc_md561"/>
-<a href="troubleshooting.html#autotoc_md563"/>
+<a href="troubleshooting.html#autotoc_md562"/>
 <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_md570"/>
+<a href="troubleshooting.html#autotoc_md569"/>
 <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_md576"/>
+<a href="troubleshooting.html#autotoc_md575"/>
 <a href="troubleshooting.html#autotoc_md577"/>
 <a href="troubleshooting.html#autotoc_md578"/>
 <a href="troubleshooting.html#autotoc_md579"/>
 <a href="troubleshooting.html#autotoc_md580"/>
 <a href="troubleshooting.html#autotoc_md581"/>
-<a href="troubleshooting.html#autotoc_md583"/>
+<a href="troubleshooting.html#autotoc_md582"/>
 <a href="troubleshooting.html#autotoc_md584"/>
 <a href="troubleshooting.html#autotoc_md585"/>
 <a href="troubleshooting.html#autotoc_md586"/>
-<a href="troubleshooting.html#autotoc_md588"/>
+<a href="troubleshooting.html#autotoc_md587"/>
 <a href="troubleshooting.html#autotoc_md589"/>
 <a href="troubleshooting.html#autotoc_md590"/>
 <a href="troubleshooting.html#autotoc_md591"/>
 <a href="troubleshooting.html#autotoc_md592"/>
 <a href="troubleshooting.html#autotoc_md593"/>
-<a href="troubleshooting.html#autotoc_md595"/>
+<a href="troubleshooting.html#autotoc_md594"/>
 <a href="troubleshooting.html#autotoc_md596"/>
 <a href="troubleshooting.html#autotoc_md597"/>
 <a href="troubleshooting.html#autotoc_md598"/>
 <a href="troubleshooting.html#autotoc_md599"/>
-<a href="troubleshooting.html#autotoc_md601"/>
+<a href="troubleshooting.html#autotoc_md600"/>
 <a href="troubleshooting.html#autotoc_md602"/>
 <a href="troubleshooting.html#autotoc_md603"/>
 <a href="troubleshooting.html#autotoc_md604"/>
 <a href="troubleshooting.html#autotoc_md605"/>
-<a href="troubleshooting.html#autotoc_md607"/>
+<a href="troubleshooting.html#autotoc_md606"/>
+<a href="troubleshooting.html#autotoc_md608"/>
 <a href="visualization.html"/>
-<a href="visualization.html#autotoc_md608"/>
-<a href="visualization.html#autotoc_md610"/>
+<a href="visualization.html#autotoc_md609"/>
 <a href="visualization.html#autotoc_md611"/>
 <a href="visualization.html#autotoc_md612"/>
 <a href="visualization.html#autotoc_md613"/>
@@ -644,13 +644,14 @@
 <a href="visualization.html#autotoc_md620"/>
 <a href="visualization.html#autotoc_md621"/>
 <a href="visualization.html#autotoc_md622"/>
-<a href="visualization.html#autotoc_md624"/>
+<a href="visualization.html#autotoc_md623"/>
 <a href="visualization.html#autotoc_md625"/>
 <a href="visualization.html#autotoc_md626"/>
 <a href="visualization.html#autotoc_md627"/>
 <a href="visualization.html#autotoc_md628"/>
 <a href="visualization.html#autotoc_md629"/>
 <a href="visualization.html#autotoc_md630"/>
 <a href="visualization.html#autotoc_md631"/>
+<a href="visualization.html#autotoc_md632"/>
 </body>
 </html>

documentation/examples.html

@@ -673,7 +673,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md317"></a>
 <h3 class="doxsection"><a class="anchor" id="autotoc_md318"></a>
 Result</h3>
 <p><img src="result-2D_shockdroplet-example.png" alt="" height="400" class="inline"/></p>
-<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-14</div> </div></div><!-- contents -->
+<div style="text-align:center; font-size:0.75rem; color:#888; padding:16px 0 0;">Page last updated: 2026-09-15</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_md518"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md519"></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_md519"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md520"></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_md519"></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_md520"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md521"></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_md521"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md522"></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_md521"></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_md522"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md523"></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_md523"></a>
+<h2 class="doxsection"><a class="anchor" id="autotoc_md524"></a>
 About</h2>
 <ul>
 <li><a class="el" href="papers.html" title="Papers">Papers</a> - Publications using MFC</li>