Skip to content

Commit 0eb62ca

Browse files
author
MFC Action
committed
Docs @ 16de11c
1 parent 31675e3 commit 0eb62ca

File tree

92 files changed

+1013
-1110
lines changed

Some content is hidden

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

92 files changed

+1013
-1110
lines changed

documentation/md_case.html

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -483,6 +483,10 @@ <h2><a class="anchor" id="autotoc_md15"></a>
483483
<tr class="markdownTableRowEven">
484484
<td class="markdownTableBodyRight"><code>adap_dt</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Strang splitting scheme with adaptive time stepping </td></tr>
485485
<tr class="markdownTableRowOdd">
486+
<td class="markdownTableBodyRight"><code>adap_dt_tol</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Tolerance for adaptive time stepping in Strang splitting scheme </td></tr>
487+
<tr class="markdownTableRowEven">
488+
<td class="markdownTableBodyRight"><code>adap_dt_max_iters</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Max iteration for adaptive time stepping in Strang splitting scheme </td></tr>
489+
<tr class="markdownTableRowOdd">
486490
<td class="markdownTableBodyRight"><code>weno_order</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">WENO order [1,3,5] </td></tr>
487491
<tr class="markdownTableRowEven">
488492
<td class="markdownTableBodyRight"><code>weno_eps</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">WENO perturbation (avoid division by zero) </td></tr>
@@ -571,7 +575,7 @@ <h2><a class="anchor" id="autotoc_md15"></a>
571575
<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>
572576
<li><code>mixture_err</code> activates correction of solutions to avoid imaginary speed of sound at each grid cell.</li>
573577
<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 class="el" href="md_references.html">Gottlieb and Shu, 1998</a>).</li>
574-
<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 <code>bubbles_euler = 'T'</code>, <code>polytropic = 'T'</code>, <code>adv_n = 'T'</code> and <code>time_stepper = 3</code>. Additionally, it can be used with <code>bubbles_lagrange = 'T'</code> and <code>time_stepper = 3</code></li>
578+
<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 <code>bubbles_euler = 'T'</code>, <code>polytropic = 'T'</code>, <code>adv_n = 'T'</code> and <code>time_stepper = 3</code>. Additionally, it can be used with <code>bubbles_lagrange = 'T'</code> and <code>time_stepper = 3</code>. <code>adap_dt_tol</code> and <code>adap_dt_max_iters</code> are 1e-4 and 100, respectively, by default.</li>
575579
<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, 5, and 7, that correspond to the 1st, 3rd, 5th, and 7th order, respectively.</li>
576580
<li><code>weno_eps</code> specifies the lower bound of the WENO nonlinear weights. It is recommended to set <code>weno_eps</code> to $10^{-6}$ for WENO-JS, and to $10^{-40}$ for other WENO variants.</li>
577581
<li><code>mapped_weno</code> activates the WENO-M scheme in place of the default WENO-JS scheme (<a class="el" href="md_references.html">Henrick et al., 2005</a>). WENO-M a variant of the WENO scheme that remaps the nonlinear WENO-JS weights by assigning larger weights to non-smooth stencils, reducing dissipation compared to the default WENO-JS scheme, at the expense of higher computational cost. Only one of <code>mapped_weno</code>, <code>wenoz</code>, and <code>teno</code> can be activated.</li>
@@ -862,32 +866,29 @@ <h3><a class="anchor" id="autotoc_md21"></a>
862866
<tr class="markdownTableRowOdd">
863867
<td class="markdownTableBodyRight"><code>poly_sigma</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Standard deviation for probability density function of polydisperse bubble populations </td></tr>
864868
<tr class="markdownTableRowEven">
865-
<td class="markdownTableBodyRight"><code>R0_type</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Quadrature rule for probability density function of polydisperse bubble populations </td></tr>
866-
<tr class="markdownTableRowOdd">
867869
<td class="markdownTableBodyRight"><code>Ca</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Cavitation number </td></tr>
868-
<tr class="markdownTableRowEven">
869-
<td class="markdownTableBodyRight"><code>Web</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Weber number </td></tr>
870870
<tr class="markdownTableRowOdd">
871-
<td class="markdownTableBodyRight"><code>Re_inv</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Inverse Reynolds number </td></tr>
871+
<td class="markdownTableBodyRight"><code>Web</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Weber number </td></tr>
872872
<tr class="markdownTableRowEven">
873-
<td class="markdownTableBodyRight"><code>qbmm</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Quadrature by method of moments </td></tr>
873+
<td class="markdownTableBodyRight"><code>Re_inv</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Inverse Reynolds number </td></tr>
874874
<tr class="markdownTableRowOdd">
875-
<td class="markdownTableBodyRight"><code>dist_type</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Joint probability density function for bubble radius and velocity (only for <code>qbmm = 'T'</code>) </td></tr>
875+
<td class="markdownTableBodyRight"><code>qbmm</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Quadrature by method of moments </td></tr>
876876
<tr class="markdownTableRowEven">
877-
<td class="markdownTableBodyRight"><code>sigR</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Standard deviation for the probability density function of bubble radius (only for <code>qbmm = 'T'</code>) (EE) </td></tr>
877+
<td class="markdownTableBodyRight"><code>dist_type</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Joint probability density function for bubble radius and velocity (only for <code>qbmm = 'T'</code>) </td></tr>
878878
<tr class="markdownTableRowOdd">
879-
<td class="markdownTableBodyRight"><code>sigV</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Standard deviation for the probability density function of bubble velocity (only for <code>qbmm = 'T'</code>) (EE) </td></tr>
879+
<td class="markdownTableBodyRight"><code>sigR</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Standard deviation for the probability density function of bubble radius (only for <code>qbmm = 'T'</code>) (EE) </td></tr>
880880
<tr class="markdownTableRowEven">
881+
<td class="markdownTableBodyRight"><code>sigV</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Standard deviation for the probability density function of bubble velocity (only for <code>qbmm = 'T'</code>) (EE) </td></tr>
882+
<tr class="markdownTableRowOdd">
881883
<td class="markdownTableBodyRight"><code>rhoRV</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Correlation coefficient for the joint probability density function of bubble radius and velocity (only for <code>qbmm = 'T'</code>) </td></tr>
882884
</table>
883885
<p>This table lists the ensemble-averaged bubble model parameters.</p>
884886
<ul>
885887
<li><code>polytropic</code> activates polytropic gas compression in the bubble. When <code>polytropic = 'F'</code>, the gas compression is modeled as non-polytropic due to heat and mass transfer across the bubble wall with constant heat and mass transfer coefficients based on (<a class="el" href="md_references.html">Preston et al., 2007</a>).</li>
886888
<li><code>thermal</code> specifies a model for heat transfer across the bubble interface by an integer from 1 through 3. <code>thermal = 1</code>, <code>2</code>, and <code>3</code> correspond to no heat transfer (adiabatic gas compression), isothermal heat transfer, and heat transfer with a constant heat transfer coefficient based on <a class="el" href="md_references.html">Preston et al., 2007</a>, respectively.</li>
887-
<li><code>polydisperse</code> activates polydispersity in the bubble model through a probability density function (PDF) of the equilibrium bubble radius.</li>
889+
<li><code>polydisperse</code> activates polydispersity in the bubble model through a probability density function (PDF) of the equilibrium bubble radius. Simpson's rule is used for integrating the log-normal PDF of equilibrium bubble radius for polydisperse populations.</li>
888890
<li><code>R0ref</code> specifies the reference bubble radius.</li>
889891
<li><code>nb</code> specifies the number of discrete bins that define the probability density function (PDF) of the equilibrium bubble radius.</li>
890-
<li><code>R0_type</code> specifies the quadrature rule for integrating the log-normal PDF of equilibrium bubble radius for polydisperse populations. <code>R0_type = 1</code> corresponds to Simpson's rule.</li>
891892
<li><code>poly_sigma</code> specifies the standard deviation of the log-normal PDF of equilibrium bubble radius for polydisperse populations.</li>
892893
<li><code>Ca</code>, <code>Web</code>, and <code>Re_inv</code> respectively specify the Cavitation number, Weber number, and the inverse Reynolds number that characterize the offset of the gas pressure from the vapor pressure, surface tension, and liquid viscosity when the polytropic gas compression model is used.</li>
893894
<li><code>qbmm</code> activates quadrature by method of moments, which assumes a PDF for bubble radius and velocity.</li>

post_process/doxygen_crawl.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,6 @@
196196
<a href="namespacem__constants.html#a40dd8e42f1d768ce7c112ea571ba9a7d"/>
197197
<a href="namespacem__constants.html#a4313ade00be58e197e9c0f4a109eadac"/>
198198
<a href="namespacem__constants.html#a4363660e82e633cc1947ab968706b26b"/>
199-
<a href="namespacem__constants.html#a477a840004aa506fa11f1d934d037d44"/>
200199
<a href="namespacem__constants.html#a515fed125471f30a2d2b1036e3c0d645"/>
201200
<a href="namespacem__constants.html#a519657d0f4b6e1301eedfbd71926c5cc"/>
202201
<a href="namespacem__constants.html#a53cf8dfd06fcfa36c018ab624ef988b6"/>
@@ -226,6 +225,7 @@
226225
<a href="namespacem__constants.html#aa66c5f6942d6776bdc0152bbb26177fd"/>
227226
<a href="namespacem__constants.html#aa923ad8ff5f55c9b4701a5cb97cf8fb7"/>
228227
<a href="namespacem__constants.html#aac0bc72075d1ecb51762a15ded73bf9a"/>
228+
<a href="namespacem__constants.html#ab4e2edff4a650d9f7610dfc9c2f01132"/>
229229
<a href="namespacem__constants.html#ab669e1862f7d937318cd697cd2a68a04"/>
230230
<a href="namespacem__constants.html#ab66dfe89cea87b9c55fbfb4f6783c5d3"/>
231231
<a href="namespacem__constants.html#ab6a85a618a05e2cd09a2ad06b27d7d45"/>
@@ -374,7 +374,6 @@
374374
<a href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7"/>
375375
<a href="namespacem__global__parameters.html#a2ecfbf52a2e6ff070bbe7a121bb37ada"/>
376376
<a href="namespacem__global__parameters.html#a2f0b96a5aef3925aa7e3cc816754e17e"/>
377-
<a href="namespacem__global__parameters.html#a305998f039363f4b293d7f4e49948a45"/>
378377
<a href="namespacem__global__parameters.html#a32791d9d5fef0213f01fc31713b17ae8"/>
379378
<a href="namespacem__global__parameters.html#a329bdc21184f2d058145d236c3c1b699"/>
380379
<a href="namespacem__global__parameters.html#a34bbf8acae0d925bb193265fb2966d1c"/>

post_process/m__constants_8fpp_8f90.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -258,9 +258,9 @@
258258
<tr class="memitem:a75d5411a4b261c3d2ace983fa082f41f" id="r_a75d5411a4b261c3d2ace983fa082f41f"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>), parameter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__constants.html#a75d5411a4b261c3d2ace983fa082f41f">m_constants::dflt_adap_dt_tol</a> = 1.e-4_wp</td></tr>
259259
<tr class="memdesc:a75d5411a4b261c3d2ace983fa082f41f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default tolerance for adaptive step size. <br /></td></tr>
260260
<tr class="separator:a75d5411a4b261c3d2ace983fa082f41f"><td class="memSeparator" colspan="2">&#160;</td></tr>
261-
<tr class="memitem:a477a840004aa506fa11f1d934d037d44" id="r_a477a840004aa506fa11f1d934d037d44"><td class="memItemLeft" align="right" valign="top">integer, parameter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__constants.html#a477a840004aa506fa11f1d934d037d44">m_constants::adap_dt_max_iters</a> = 100</td></tr>
262-
<tr class="memdesc:a477a840004aa506fa11f1d934d037d44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of iterations. <br /></td></tr>
263-
<tr class="separator:a477a840004aa506fa11f1d934d037d44"><td class="memSeparator" colspan="2">&#160;</td></tr>
261+
<tr class="memitem:ab4e2edff4a650d9f7610dfc9c2f01132" id="r_ab4e2edff4a650d9f7610dfc9c2f01132"><td class="memItemLeft" align="right" valign="top">integer, parameter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__constants.html#ab4e2edff4a650d9f7610dfc9c2f01132">m_constants::dflt_adap_dt_max_iters</a> = 100</td></tr>
262+
<tr class="memdesc:ab4e2edff4a650d9f7610dfc9c2f01132"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default max iteration for adaptive step size. <br /></td></tr>
263+
<tr class="separator:ab4e2edff4a650d9f7610dfc9c2f01132"><td class="memSeparator" colspan="2">&#160;</td></tr>
264264
<tr class="memitem:ad6a16fddedb72d1e8a561901042ccd4a" id="r_ad6a16fddedb72d1e8a561901042ccd4a"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>), parameter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__constants.html#ad6a16fddedb72d1e8a561901042ccd4a">m_constants::threshold_first_guess</a> = 1.e-5_wp</td></tr>
265265
<tr class="separator:ad6a16fddedb72d1e8a561901042ccd4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
266266
<tr class="memitem:aa03b80d8ec31c8a1edf63511b1948ec7" id="r_aa03b80d8ec31c8a1edf63511b1948ec7"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>), parameter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__constants.html#aa03b80d8ec31c8a1edf63511b1948ec7">m_constants::threshold_second_guess</a> = 1.e-15_wp</td></tr>

post_process/m__constants_8fpp_8f90.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
var m__constants_8fpp_8f90 =
22
[
33
[ "m_constants::acoustic_spatial_support_width", "namespacem__constants.html#a92bc4d3446d8473183e165116932778f", null ],
4-
[ "m_constants::adap_dt_max_iters", "namespacem__constants.html#a477a840004aa506fa11f1d934d037d44", null ],
54
[ "m_constants::amplifier", "namespacem__constants.html#a1f52e85430eb7f1fba1d46370791e877", null ],
65
[ "m_constants::bc_axis", "namespacem__constants.html#a5c4bf41667b9de3aadb9f48071d37c7a", null ],
76
[ "m_constants::bc_char_cp_sub_outflow", "namespacem__constants.html#aa923ad8ff5f55c9b4701a5cb97cf8fb7", null ],
@@ -25,6 +24,7 @@ var m__constants_8fpp_8f90 =
2524
[ "m_constants::capillary_cutoff", "namespacem__constants.html#ad2919a9016acfe411dfc41e18beb1140", null ],
2625
[ "m_constants::case_file_error_code", "namespacem__constants.html#a78dc466963174e056c559059e09704cc", null ],
2726
[ "m_constants::decimal_trim", "namespacem__constants.html#a661e16fd10454ba78431f0053c08bd32", null ],
27+
[ "m_constants::dflt_adap_dt_max_iters", "namespacem__constants.html#ab4e2edff4a650d9f7610dfc9c2f01132", null ],
2828
[ "m_constants::dflt_adap_dt_tol", "namespacem__constants.html#a75d5411a4b261c3d2ace983fa082f41f", null ],
2929
[ "m_constants::dflt_alf_factor", "namespacem__constants.html#a5d89c349567c67a10150e73627911cc3", null ],
3030
[ "m_constants::dflt_char", "namespacem__constants.html#a89491724fc8077006ff1b62f981400ac", null ],

post_process/m__global__parameters_8fpp_8f90.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -563,8 +563,6 @@
563563
<tr class="separator:a4e7f6ce2432690cb619f78639791f6ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
564564
<tr class="memitem:a7c02cc28add79f8e14e3ed53517e74d0" id="r_a7c02cc28add79f8e14e3ed53517e74d0"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>), dimension(:), allocatable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a7c02cc28add79f8e14e3ed53517e74d0">m_global_parameters::r0</a></td></tr>
565565
<tr class="separator:a7c02cc28add79f8e14e3ed53517e74d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
566-
<tr class="memitem:a305998f039363f4b293d7f4e49948a45" id="r_a305998f039363f4b293d7f4e49948a45"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>), dimension(:), allocatable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a305998f039363f4b293d7f4e49948a45">m_global_parameters::v0</a></td></tr>
567-
<tr class="separator:a305998f039363f4b293d7f4e49948a45"><td class="memSeparator" colspan="2">&#160;</td></tr>
568566
<tr class="memitem:a04cbfd496a4957519236d8be24b343bd" id="r_a04cbfd496a4957519236d8be24b343bd"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a04cbfd496a4957519236d8be24b343bd">m_global_parameters::bubbles_euler</a></td></tr>
569567
<tr class="separator:a04cbfd496a4957519236d8be24b343bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
570568
<tr class="memitem:a9648048cbecc834252ec7e0c259b1111" id="r_a9648048cbecc834252ec7e0c259b1111"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a9648048cbecc834252ec7e0c259b1111">m_global_parameters::qbmm</a></td></tr>

post_process/m__global__parameters_8fpp_8f90.js

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)