Skip to content

Commit 832bd8b

Browse files
author
MFC Action
committed
Docs @ 437e2d1
1 parent 28208f7 commit 832bd8b

File tree

427 files changed

+34462
-23408
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

427 files changed

+34462
-23408
lines changed

documentation/doxygen_crawl.html

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
<a href="doxygen_crawl.html"/>
2323
<a href="pages.html"/>
2424
<a href="index.html"/>
25-
<a href="index.html#autotoc_md71"/>
2625
<a href="index.html#autotoc_md72"/>
26+
<a href="index.html#autotoc_md73"/>
2727
<a href="md_authors.html"/>
2828
<a href="md_case.html"/>
2929
<a href="md_case.html#autotoc_md10"/>
@@ -44,6 +44,7 @@
4444
<a href="md_case.html#autotoc_md24"/>
4545
<a href="md_case.html#autotoc_md25"/>
4646
<a href="md_case.html#autotoc_md26"/>
47+
<a href="md_case.html#autotoc_md27"/>
4748
<a href="md_case.html#autotoc_md3"/>
4849
<a href="md_case.html#autotoc_md4"/>
4950
<a href="md_case.html#autotoc_md5"/>
@@ -52,7 +53,6 @@
5253
<a href="md_case.html#autotoc_md8"/>
5354
<a href="md_case.html#autotoc_md9"/>
5455
<a href="md_examples.html"/>
55-
<a href="md_examples.html#autotoc_md28"/>
5656
<a href="md_examples.html#autotoc_md29"/>
5757
<a href="md_examples.html#autotoc_md30"/>
5858
<a href="md_examples.html#autotoc_md31"/>
@@ -77,8 +77,8 @@
7777
<a href="md_examples.html#autotoc_md50"/>
7878
<a href="md_examples.html#autotoc_md51"/>
7979
<a href="md_examples.html#autotoc_md52"/>
80+
<a href="md_examples.html#autotoc_md53"/>
8081
<a href="md_expectedPerformance.html"/>
81-
<a href="md_expectedPerformance.html#autotoc_md54"/>
8282
<a href="md_expectedPerformance.html#autotoc_md55"/>
8383
<a href="md_expectedPerformance.html#autotoc_md56"/>
8484
<a href="md_expectedPerformance.html#autotoc_md57"/>
@@ -88,30 +88,31 @@
8888
<a href="md_expectedPerformance.html#autotoc_md61"/>
8989
<a href="md_expectedPerformance.html#autotoc_md62"/>
9090
<a href="md_expectedPerformance.html#autotoc_md63"/>
91+
<a href="md_expectedPerformance.html#autotoc_md64"/>
9192
<a href="md_getting-started.html"/>
92-
<a href="md_getting-started.html#autotoc_md65"/>
9393
<a href="md_getting-started.html#autotoc_md66"/>
9494
<a href="md_getting-started.html#autotoc_md67"/>
9595
<a href="md_getting-started.html#autotoc_md68"/>
9696
<a href="md_getting-started.html#autotoc_md69"/>
97+
<a href="md_getting-started.html#autotoc_md70"/>
9798
<a href="md_references.html"/>
9899
<a href="md_running.html"/>
99-
<a href="md_running.html#autotoc_md75"/>
100100
<a href="md_running.html#autotoc_md76"/>
101101
<a href="md_running.html#autotoc_md77"/>
102102
<a href="md_running.html#autotoc_md78"/>
103103
<a href="md_running.html#autotoc_md79"/>
104104
<a href="md_running.html#autotoc_md80"/>
105105
<a href="md_running.html#autotoc_md81"/>
106+
<a href="md_running.html#autotoc_md82"/>
106107
<a href="md_testing.html"/>
107-
<a href="md_testing.html#autotoc_md83"/>
108108
<a href="md_testing.html#autotoc_md84"/>
109+
<a href="md_testing.html#autotoc_md85"/>
109110
<a href="md_visualization.html"/>
110-
<a href="md_visualization.html#autotoc_md86"/>
111111
<a href="md_visualization.html#autotoc_md87"/>
112112
<a href="md_visualization.html#autotoc_md88"/>
113113
<a href="md_visualization.html#autotoc_md89"/>
114114
<a href="md_visualization.html#autotoc_md90"/>
115115
<a href="md_visualization.html#autotoc_md91"/>
116+
<a href="md_visualization.html#autotoc_md92"/>
116117
</body>
117118
</html>

documentation/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@
135135
</div><!--header-->
136136
<div class="contents">
137137
<div class="textblock"><p><a class="anchor" id="md_readme"></a> </p>
138-
<h1><a class="anchor" id="autotoc_md71"></a>
138+
<h1><a class="anchor" id="autotoc_md72"></a>
139139
User Documentation</h1>
140140
<ul>
141141
<li><a class="el" href="md_getting-started.html">Getting Started</a></li>
@@ -148,7 +148,7 @@ <h1><a class="anchor" id="autotoc_md71"></a>
148148
<li><a class="el" href="md_authors.html">MFC's Authors</a></li>
149149
<li><a class="el" href="md_references.html">References</a></li>
150150
</ul>
151-
<h1><a class="anchor" id="autotoc_md72"></a>
151+
<h1><a class="anchor" id="autotoc_md73"></a>
152152
Code/API Documentation</h1>
153153
<p>MFC's three codes have their own documentation:</p>
154154
<ul>

documentation/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
var index =
22
[
3-
[ "User Documentation", "index.html#autotoc_md71", null ],
4-
[ "Code/API Documentation", "index.html#autotoc_md72", null ]
3+
[ "User Documentation", "index.html#autotoc_md72", null ],
4+
[ "Code/API Documentation", "index.html#autotoc_md73", null ]
55
];

documentation/md_case.html

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,7 @@ <h1><a class="anchor" id="autotoc_md3"></a>
183183
<li>(Optional) Ensemble-Averaged Bubble Model Parameters</li>
184184
<li>(Optional) Velocity Field Setup Parameters</li>
185185
<li>(Optional) Phase Change Parameters</li>
186+
<li>(Optional) Artificial Mach Number Parameters</li>
186187
</ol>
187188
<p>Items 7, 8, 9, and 10 are optional sets of parameters that activate the acoustic source model, ensemble-averaged bubble model, initial velocity field setup, and phase change, respectively. Definition of the parameters is described in the following subsections.</p>
188189
<h2><a class="anchor" id="autotoc_md5"></a>
@@ -434,11 +435,15 @@ <h2><a class="anchor" id="autotoc_md14"></a>
434435
<tr class="markdownTableRowEven">
435436
<td class="markdownTableBodyRight"><code>adv_alphan</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Equations for all $N$ volume fractions (instead of $N-1$) </td></tr>
436437
<tr class="markdownTableRowOdd">
437-
<td class="markdownTableBodyRight"><code>mpp_lim</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Mixture physical parameters limits </td></tr>
438+
<td class="markdownTableBodyRight"><code>adv_n</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Solving directly for the number density (in the method of classes) and compute void fraction from the number density </td></tr>
438439
<tr class="markdownTableRowEven">
440+
<td class="markdownTableBodyRight"><code>mpp_lim</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Mixture physical parameters limits </td></tr>
441+
<tr class="markdownTableRowOdd">
439442
<td class="markdownTableBodyRight"><code>mixture_err</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Mixture properties correction </td></tr>
443+
<tr class="markdownTableRowEven">
444+
<td class="markdownTableBodyRight"><code>time_stepper</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Runge&ndash;Kutta order [1-3] </td></tr>
440445
<tr class="markdownTableRowOdd">
441-
<td class="markdownTableBodyRight"><code>time_stepper</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Runge-Kutta order [1-3] </td></tr>
446+
<td class="markdownTableBodyRight"><code>adap_dt</code> </td><td class="markdownTableBodyCenter">Loginal </td><td class="markdownTableBodyLeft">Strang splitting scheme with adaptive time stepping </td></tr>
442447
<tr class="markdownTableRowEven">
443448
<td class="markdownTableBodyRight"><code>weno_order</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">WENO order [1,3,5] </td></tr>
444449
<tr class="markdownTableRowOdd">
@@ -477,9 +482,11 @@ <h2><a class="anchor" id="autotoc_md14"></a>
477482
<p>$$ \alpha_N=1-\sum^{N-1}_{i=1} \alpha_i $$</p>
478483
<p>where $\alpha_i$ is the void fraction of $i$-th component. When a single-component flow is simulated, it requires that &lsquo;adv_alphan = 'T&rsquo;`.</p>
479484
<ul>
485+
<li><code>adv_n</code> activates the direct computation of number density by the Riemann solver instead of computing number density from the void fraction in the method of classes.</li>
480486
<li><code>mpp_lim</code> activates correction of solutions to avoid a negative void fraction of each component in each grid cell, such that $\alpha_i&gt;\varepsilon$ is satisfied at each time step.</li>
481487
<li><code>mixture_err</code> activates correction of solutions to avoid imaginary speed of sound at each grid cell.</li>
482488
<li><code>time_stepper</code> specifies the order of the Runge-Kutta (RK) time integration scheme that is used for temporal integration in simulation, from the 1st to 5th order by corresponding integer. Note that <code>time_stepper = 3</code> specifies the total variation diminishing (TVD), third order RK scheme (<a href="references.md#Gottlieb98">Gottlieb and Shu, 1998</a>).</li>
489+
<li><code>adap_dt</code> activates the Strang operator splitting scheme which splits flux and source terms in time marching, and an adaptive time stepping strategy is implemented for the source term. It requires &lsquo;bubbles = 'T&rsquo;<code>,</code>polytropic = 'T'<code>,</code>adv_n = 'T'<code>and</code>time_stepper = 3`.</li>
483490
<li><code>weno_order</code> specifies the order of WENO scheme that is used for spatial reconstruction of variables by an integer of 1, 3, and 5, that correspond to the 1st, 3rd, and 5th order, respectively.</li>
484491
<li><code>weno_eps</code> specifies the lower bound of the WENO nonlinear weights. Practically, <code>weno_eps</code> $&lt;10^{-6}$ is used.</li>
485492
<li><code>mapped_weno</code> activates mapping of the nonlinear WENO weights to the more accurate nonlinear weights in order to reinstate the optimal order of accuracy of the reconstruction in the proximity of critical points (<a href="references.md#Henrick05">Henrick et al., 2005</a>).</li>
@@ -707,7 +714,7 @@ <h2><a class="anchor" id="autotoc_md18"></a>
707714
<li><code>perturb_sph</code> activates the perturbation of initial partial density by random noise.</li>
708715
<li><code>perturb_sph_fluid</code> specifies the fluid component whose partial density is to be perturbed.</li>
709716
<li><code>vel_profile</code> activates setting the mean streamwise velocity to hyperbolic tangent profile. This option works only for 2D and 3D cases.</li>
710-
<li><code>instability_wave</code> activates the perturbation of initial velocity by instability waves obtained from linear stability analysis for a mixing layer with hyperbolic tangent mean streamwise velocity profile. This option only works for 2D and 3D cases, together with &lsquo;vel_profile = 'T&rsquo;`.</li>
717+
<li><code>instability_wave</code> activates the perturbation of initial velocity by instability waves obtained from linear stability analysis for a mixing layer with hyperbolic tangent mean streamwise velocity profile. This option only works for <code>n &gt; 0</code>, <code>bc_y%[beg,end] = -5</code>, and &lsquo;vel_profile = 'T&rsquo;`.</li>
711718
</ul>
712719
<h2><a class="anchor" id="autotoc_md19"></a>
713720
11. Phase Change Model</h2>
@@ -729,9 +736,20 @@ <h2><a class="anchor" id="autotoc_md19"></a>
729736
<li><code>palpha_eps</code> Specifies the tolerance used for the Newton Solvers used in the pT-equilibrium model.</li>
730737
<li><code>ptgalpha_eps</code> Specifies the tolerance used for the Newton Solvers used in the pTg-equilibrium model.</li>
731738
</ul>
732-
<h1><a class="anchor" id="autotoc_md20"></a>
739+
<h2><a class="anchor" id="autotoc_md20"></a>
740+
11. Artificial Mach Number</h2>
741+
<table class="markdownTable">
742+
<tr class="markdownTableHead">
743+
<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>
744+
<tr class="markdownTableRowOdd">
745+
<td class="markdownTableBodyRight"><code>pi_fac</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Ratio of artificial and true <code>pi_\infty</code> values </td></tr>
746+
</table>
747+
<ul>
748+
<li><code>pi_fac</code> specifies the ratio of artificial and true <code>pi_\infty</code> values (<code>=</code> artificial <code>pi_\infty</code> / true <code>pi_\infty</code>). This parameter enables the use of true <code>pi_\infty</code> in bubble dynamics models, when the <code>pi_\infty</code> given in the <code>case.py</code> file is an artificial value.</li>
749+
</ul>
750+
<h1><a class="anchor" id="autotoc_md21"></a>
733751
Enumerations</h1>
734-
<h2><a class="anchor" id="autotoc_md21"></a>
752+
<h2><a class="anchor" id="autotoc_md22"></a>
735753
Boundary conditions</h2>
736754
<table class="markdownTable">
737755
<tr class="markdownTableHead">
@@ -769,7 +787,7 @@ <h2><a class="anchor" id="autotoc_md21"></a>
769787
</table>
770788
<p>*: This boundary condition is only used for <code>bc_ybeg</code> when using cylindrical coordinates (&lsquo;cyl_coord = 'T&rsquo;<code>and 3D). For axisymmetric problems, use</code>bc_ybeg = -2<code>with</code>cyl_coord = 'T'` in 2D.</p>
771789
<p>The boundary condition supported by the MFC are listed in table Boundary Conditions. Their number (<code>#</code>) corresponds to the input value in <code>input.py</code> labeled <code>bc_[x,y,z]%[beg,end]</code> (see table Simulation Algorithm Parameters). The entries labeled "Characteristic." are characteristic boundary conditions based on <a href="references.md#Thompson87">Thompson (1987)</a> and <a href="references.md#Thompson90">Thompson (1990)</a>.</p>
772-
<h2><a class="anchor" id="autotoc_md22"></a>
790+
<h2><a class="anchor" id="autotoc_md23"></a>
773791
Patch types</h2>
774792
<table class="markdownTable">
775793
<tr class="markdownTableHead">
@@ -818,7 +836,7 @@ <h2><a class="anchor" id="autotoc_md22"></a>
818836
<td class="markdownTableBodyRight">21 </td><td class="markdownTableBodyCenter">Model </td><td class="markdownTableBodyCenter">2 &amp; 3 </td><td class="markdownTableBodyCenter">Y </td><td class="markdownTableBodyLeft">Imports a Model (STL/OBJ). Requires <code>modelfilepath</code>. </td></tr>
819837
</table>
820838
<p>The patch types supported by the MFC are listed in table Patch Types. This includes types exclusive to one-, two-, and three-dimensional problems. The patch type number (<code>#</code>) corresponds to the input value in <code>input.py</code> labeled <code>patch_icpp(j)geometry</code> where $j$ is the patch index. Each patch requires a different set of parameters, which are also listed in this table.</p>
821-
<h2><a class="anchor" id="autotoc_md23"></a>
839+
<h2><a class="anchor" id="autotoc_md24"></a>
822840
Immersed Boundary Patch Types</h2>
823841
<table class="markdownTable">
824842
<tr class="markdownTableHead">
@@ -836,7 +854,7 @@ <h2><a class="anchor" id="autotoc_md23"></a>
836854
<tr class="markdownTableRowEven">
837855
<td class="markdownTableBodyRight">11 </td><td class="markdownTableBodyCenter">3D Airfoil </td><td class="markdownTableBodyLeft">3 </td></tr>
838856
</table>
839-
<h2><a class="anchor" id="autotoc_md24"></a>
857+
<h2><a class="anchor" id="autotoc_md25"></a>
840858
Monopole supports</h2>
841859
<table class="markdownTable">
842860
<tr class="markdownTableHead">
@@ -855,7 +873,7 @@ <h2><a class="anchor" id="autotoc_md24"></a>
855873
<td class="markdownTableBodyNone">6 </td><td class="markdownTableBodyNone">Cyl_coord along axial-dir </td></tr>
856874
</table>
857875
<p>The monopole support types available in MFC are listed in table Monopole supports. This includes types exclusive to one-, two-, and three-dimensional problems with special sauce geometry like transducers as well as coordinate systems such as cylindrical coordinates. The monopole support number (<code>#</code>) corresponds to the input value in <code>input.py</code> labeled <code>Mono(i)support</code> where $i$ is the monopole source index.</p>
858-
<h2><a class="anchor" id="autotoc_md25"></a>
876+
<h2><a class="anchor" id="autotoc_md26"></a>
859877
Conservative Variables Ordering</h2>
860878
<table class="markdownTable">
861879
<tr class="markdownTableHead">
@@ -881,7 +899,7 @@ <h2><a class="anchor" id="autotoc_md25"></a>
881899
<td class="markdownTableBodyNone">hypoelastic variables </td><td class="markdownTableBodyNone">N/A </td></tr>
882900
</table>
883901
<p>The above variables correspond to optional physics.</p>
884-
<h2><a class="anchor" id="autotoc_md26"></a>
902+
<h2><a class="anchor" id="autotoc_md27"></a>
885903
Primitive Variables Ordering</h2>
886904
<table class="markdownTable">
887905
<tr class="markdownTableHead">

0 commit comments

Comments
 (0)