Skip to content

Commit 15dfabe

Browse files
author
MFC Action
committed
Docs @ bc847bf
1 parent 8e4b98f commit 15dfabe

30 files changed

+716
-787
lines changed

documentation/md_case.html

Lines changed: 19 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ <h3><a class="anchor" id="autotoc_md10"></a>
358358
</ul>
359359
</li>
360360
<li><code>smoothen</code> activates smoothening of the boundary of the patch that alters the existing patch. When smoothening occurs, fluids of the two patches are mixed in the region of the boundary. For instance, in the aforementioned case of the cylindrical patch immersed in the rectangular patch, smoothening occurs when <code>patch_icpp(2)smoothen = 'T'</code>. <code>smooth_coeff</code> controls the thickness of the region of smoothening (sharpness of the mixture region). The default value of <code>smooth_coeff</code> is unity. The region of smoothening is thickened with decreasing the value. Optimal choice of the value of <code>smooth_coeff</code> is case-dependent and left to the user.</li>
361-
<li><code>patch_icpp(j)alpha(i)</code>, <code>patch_icpp(j)alpha_rho(i)</code>, <code>patch_icpp(j)pres</code>, and <code>patch_icpp(j)vel(i)</code> define for $j$-th patch the void fraction of <code>fluid(i)</code>, partial density of <code>fluid(i)</code>, the pressure, and the velocity in the $i$-th coordinate direction. These physical parameters must be consistent with fluid material's parameters defined in the next subsection. See also <code>adv_alphan</code> in table Simulation Algorithm Parameters.</li>
361+
<li><code>patch_icpp(j)alpha(i)</code>, <code>patch_icpp(j)alpha_rho(i)</code>, <code>patch_icpp(j)pres</code>, and <code>patch_icpp(j)vel(i)</code> define for $j$-th patch the void fraction of <code>fluid(i)</code>, partial density of <code>fluid(i)</code>, the pressure, and the velocity in the $i$-th coordinate direction. These physical parameters must be consistent with fluid material's parameters defined in the next subsection.</li>
362362
<li><code>model%scale</code>, <code>model%rotate</code> and <code>model%translate</code> define how the model should be transformed to domain-space by first scaling by <code>model%scale</code>, then rotating about the Z, X, and Y axes (using <code>model%rotate</code>), and finally translating by <code>model%translate</code>.</li>
363363
</ul>
364364
<h2><a class="anchor" id="autotoc_md11"></a>
@@ -449,44 +449,42 @@ <h2><a class="anchor" id="autotoc_md14"></a>
449449
<tr class="markdownTableRowOdd">
450450
<td class="markdownTableBodyRight"><code>alt_soundspeed</code> * </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Alternate sound speed and $K \nabla \cdot u$ for 5-equation model </td></tr>
451451
<tr class="markdownTableRowEven">
452-
<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>
453-
<tr class="markdownTableRowOdd">
454452
<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>
455-
<tr class="markdownTableRowEven">
456-
<td class="markdownTableBodyRight"><code>mpp_lim</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Mixture physical parameters limits </td></tr>
457453
<tr class="markdownTableRowOdd">
458-
<td class="markdownTableBodyRight"><code>mixture_err</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Mixture properties correction </td></tr>
454+
<td class="markdownTableBodyRight"><code>mpp_lim</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Mixture physical parameters limits </td></tr>
459455
<tr class="markdownTableRowEven">
460-
<td class="markdownTableBodyRight"><code>time_stepper</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Runge&ndash;Kutta order [1-3] </td></tr>
456+
<td class="markdownTableBodyRight"><code>mixture_err</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Mixture properties correction </td></tr>
461457
<tr class="markdownTableRowOdd">
462-
<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>
458+
<td class="markdownTableBodyRight"><code>time_stepper</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Runge&ndash;Kutta order [1-3] </td></tr>
463459
<tr class="markdownTableRowEven">
464-
<td class="markdownTableBodyRight"><code>weno_order</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">WENO order [1,3,5] </td></tr>
460+
<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>
465461
<tr class="markdownTableRowOdd">
466-
<td class="markdownTableBodyRight"><code>weno_eps</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">WENO perturbation (avoid division by zero) </td></tr>
462+
<td class="markdownTableBodyRight"><code>weno_order</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">WENO order [1,3,5] </td></tr>
467463
<tr class="markdownTableRowEven">
468-
<td class="markdownTableBodyRight"><code>mapped_weno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">WENO-M (WENO with mapping of nonlinear weights) </td></tr>
464+
<td class="markdownTableBodyRight"><code>weno_eps</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">WENO perturbation (avoid division by zero) </td></tr>
469465
<tr class="markdownTableRowOdd">
470-
<td class="markdownTableBodyRight"><code>wenoz</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">WENO-Z </td></tr>
466+
<td class="markdownTableBodyRight"><code>mapped_weno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">WENO-M (WENO with mapping of nonlinear weights) </td></tr>
471467
<tr class="markdownTableRowEven">
472-
<td class="markdownTableBodyRight"><code>teno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">TENO (Targeted ENO) </td></tr>
468+
<td class="markdownTableBodyRight"><code>wenoz</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">WENO-Z </td></tr>
473469
<tr class="markdownTableRowOdd">
474-
<td class="markdownTableBodyRight"><code>teno_CT</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">TENO threshold for smoothness detection </td></tr>
470+
<td class="markdownTableBodyRight"><code>teno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">TENO (Targeted ENO) </td></tr>
475471
<tr class="markdownTableRowEven">
476-
<td class="markdownTableBodyRight"><code>null_weights</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Null WENO weights at boundaries </td></tr>
472+
<td class="markdownTableBodyRight"><code>teno_CT</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">TENO threshold for smoothness detection </td></tr>
477473
<tr class="markdownTableRowOdd">
478-
<td class="markdownTableBodyRight"><code>mp_weno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Monotonicity preserving WENO </td></tr>
474+
<td class="markdownTableBodyRight"><code>null_weights</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Null WENO weights at boundaries </td></tr>
479475
<tr class="markdownTableRowEven">
480-
<td class="markdownTableBodyRight"><code>riemann_solver</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Riemann solver algorithm: [1] HLL*; [2] HLLC; [3] Exact* </td></tr>
476+
<td class="markdownTableBodyRight"><code>mp_weno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Monotonicity preserving WENO </td></tr>
481477
<tr class="markdownTableRowOdd">
482-
<td class="markdownTableBodyRight"><code>low_Mach</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Low Mach number correction for HLLC Riemann solver: [0] None; [1] Pressure (Chen et al. 2022); [2] Velocity (Thornber et al. 2008) </td></tr>
478+
<td class="markdownTableBodyRight"><code>riemann_solver</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Riemann solver algorithm: [1] HLL*; [2] HLLC; [3] Exact* </td></tr>
483479
<tr class="markdownTableRowEven">
484-
<td class="markdownTableBodyRight"><code>avg_state</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Averaged state evaluation method: [1] Roe averagen*; [2] Arithmetic mean </td></tr>
480+
<td class="markdownTableBodyRight"><code>low_Mach</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Low Mach number correction for HLLC Riemann solver: [0] None; [1] Pressure (Chen et al. 2022); [2] Velocity (Thornber et al. 2008) </td></tr>
485481
<tr class="markdownTableRowOdd">
486-
<td class="markdownTableBodyRight"><code>wave_speeds</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Wave-speed estimation: [1] Direct (Batten et al. 1997); [2] Pressure-velocity* (Toro 1999) </td></tr>
482+
<td class="markdownTableBodyRight"><code>avg_state</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Averaged state evaluation method: [1] Roe averagen*; [2] Arithmetic mean </td></tr>
487483
<tr class="markdownTableRowEven">
488-
<td class="markdownTableBodyRight"><code>weno_Re_flux</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Compute velocity gradient using scaler divergence theorem </td></tr>
484+
<td class="markdownTableBodyRight"><code>wave_speeds</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Wave-speed estimation: [1] Direct (Batten et al. 1997); [2] Pressure-velocity* (Toro 1999) </td></tr>
489485
<tr class="markdownTableRowOdd">
486+
<td class="markdownTableBodyRight"><code>weno_Re_flux</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Compute velocity gradient using scaler divergence theorem </td></tr>
487+
<tr class="markdownTableRowEven">
490488
<td class="markdownTableBodyRight"><code>weno_avg</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Arithmetic mean of left and right, WENO-reconstructed, cell-boundary values </td></tr>
491489
</table>
492490
<ul>
@@ -501,11 +499,6 @@ <h2><a class="anchor" id="autotoc_md14"></a>
501499
<li><code>bc_[x,y,z]%ve[1,2,3]</code> specifies the velocity in the (x,1), (y,2), (z,3) direction applied to <code>bc_[x,y,z]%beg</code> when using <code>bc_[x,y,z]%end = -16</code>. Tangential velocities require viscosity, <code>weno_avg = T</code>, and <code>bc_[x,y,z]%end = 16</code> to work properly. Normal velocities require <code>bc_[x,y,z]%end = -15</code> or <code>\bc_[x,y,z]%end = -16</code> to work properly.</li>
502500
<li><code>model_eqns</code> specifies the choice of the multi-component model that is used to formulate the dynamics of the flow using integers from 1 through 3. <code>model_eqns = 1</code>, <code>2</code>, and <code>3</code> correspond to $\Gamma$-$\Pi_\infty$ model (<a href="references.md#Johnsen08">Johnsen, 2008</a>), 5-equation model (<a href="references.md#Allaire02">Allaire et al., 2002</a>), and 6-equation model (<a href="references.md#Saurel09">Saurel et al., 2009</a>), respectively. The difference of the two models is assessed by (<a href="references.md#Schmidmayer19">Schmidmayer et al., 2019</a>). Note that some code parameters are only compatible with 5-equation model.</li>
503501
<li><code>alt_soundspeed</code> activates the source term in the advection equations for the volume fractions, $K\nabla\cdot \underline{u}$, that regularizes the speed of sound in the mixture region when the 5-equation model is used. The effect and use of the source term are assessed by <a href="references.md#Schmidmayer19">Schmidmayer et al., 2019</a>.</li>
504-
<li><code>adv_alphan</code> activates the advection equations of all the components of fluid. If this parameter is set false, the void fraction of $N$-th component is computed as the residual of the void fraction of the other components at each cell:</li>
505-
</ul>
506-
<p>$$ \alpha_N=1-\sum^{N-1}_{i=1} \alpha_i $$</p>
507-
<p>where $\alpha_i$ is the void fraction of $i$-th component. When a single-component flow is simulated, it requires that <code>adv_alphan = 'T'</code>.</p>
508-
<ul>
509502
<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>
510503
<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>
511504
<li><code>mixture_err</code> activates correction of solutions to avoid imaginary speed of sound at each grid cell.</li>

post_process/doxygen_crawl.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,6 @@
470470
<a href="m__global__parameters_8fpp_8f90.html#ab8488205257dab4e94258eee55d0d1aa"/>
471471
<a href="m__global__parameters_8fpp_8f90.html#ab89002e709bc1eba6703aa37c68d0d06"/>
472472
<a href="m__global__parameters_8fpp_8f90.html#abd9ada93ee5222de406111ee9c91ddf0"/>
473-
<a href="m__global__parameters_8fpp_8f90.html#abebd95d9d0271fbda40f47f75a2d829b"/>
474473
<a href="m__global__parameters_8fpp_8f90.html#abeca739b09557ccbf37b2ec35b0e73cc"/>
475474
<a href="m__global__parameters_8fpp_8f90.html#ac040dbf547e6d5de8df08e864d8131e7"/>
476475
<a href="m__global__parameters_8fpp_8f90.html#ac127ac2a9036e1cdb7e6c41159cacdfb"/>
@@ -851,7 +850,6 @@
851850
<a href="namespacem__global__parameters.html#ab8488205257dab4e94258eee55d0d1aa"/>
852851
<a href="namespacem__global__parameters.html#ab89002e709bc1eba6703aa37c68d0d06"/>
853852
<a href="namespacem__global__parameters.html#abd9ada93ee5222de406111ee9c91ddf0"/>
854-
<a href="namespacem__global__parameters.html#abebd95d9d0271fbda40f47f75a2d829b"/>
855853
<a href="namespacem__global__parameters.html#abeca739b09557ccbf37b2ec35b0e73cc"/>
856854
<a href="namespacem__global__parameters.html#ac040dbf547e6d5de8df08e864d8131e7"/>
857855
<a href="namespacem__global__parameters.html#ac127ac2a9036e1cdb7e6c41159cacdfb"/>

post_process/m__global__parameters_8fpp_8f90.html

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -294,9 +294,6 @@
294294
<tr class="memitem:a5cedf3ff171416c31d59851103792c58" id="r_a5cedf3ff171416c31d59851103792c58"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a5cedf3ff171416c31d59851103792c58">m_global_parameters::relax_model</a></td></tr>
295295
<tr class="memdesc:a5cedf3ff171416c31d59851103792c58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Phase change relaxation model. <br /></td></tr>
296296
<tr class="separator:a5cedf3ff171416c31d59851103792c58"><td class="memSeparator" colspan="2">&#160;</td></tr>
297-
<tr class="memitem:abebd95d9d0271fbda40f47f75a2d829b" id="r_abebd95d9d0271fbda40f47f75a2d829b"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#abebd95d9d0271fbda40f47f75a2d829b">m_global_parameters::adv_alphan</a></td></tr>
298-
<tr class="memdesc:abebd95d9d0271fbda40f47f75a2d829b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advection of the last volume fraction. <br /></td></tr>
299-
<tr class="separator:abebd95d9d0271fbda40f47f75a2d829b"><td class="memSeparator" colspan="2">&#160;</td></tr>
300297
<tr class="memitem:adc35ba450a192812db36f1d6659d64e6" id="r_adc35ba450a192812db36f1d6659d64e6"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#adc35ba450a192812db36f1d6659d64e6">m_global_parameters::mpp_lim</a></td></tr>
301298
<tr class="memdesc:adc35ba450a192812db36f1d6659d64e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum volume fraction limiter. <br /></td></tr>
302299
<tr class="separator:adc35ba450a192812db36f1d6659d64e6"><td class="memSeparator" colspan="2">&#160;</td></tr>

post_process/m__global__parameters_8fpp_8f90.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ var m__global__parameters_8fpp_8f90 =
55
[ "s_initialize_global_parameters_module", "m__global__parameters_8fpp_8f90.html#a0ab7a5fabf3176ffda10bd9b5b6bf410", null ],
66
[ "s_initialize_parallel_io", "m__global__parameters_8fpp_8f90.html#a8bba2f308a8b95fbe6290466f58206d5", null ],
77
[ "adv", "m__global__parameters_8fpp_8f90.html#ab08373aff5e7867fd0d6a24f4eb1238d", null ],
8-
[ "adv_alphan", "m__global__parameters_8fpp_8f90.html#abebd95d9d0271fbda40f47f75a2d829b", null ],
98
[ "adv_idx", "m__global__parameters_8fpp_8f90.html#ab73a1c5c3f6815695771323454db2a81", null ],
109
[ "adv_n", "m__global__parameters_8fpp_8f90.html#aaf85bdfa4c053e4366099e4f4520fb71", null ],
1110
[ "advxb", "m__global__parameters_8fpp_8f90.html#af4751a18db30b97d83e7f0372182a18d", null ],

post_process/namespacem__global__parameters.html

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -290,9 +290,6 @@
290290
<tr class="memitem:a5cedf3ff171416c31d59851103792c58" id="r_a5cedf3ff171416c31d59851103792c58"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5cedf3ff171416c31d59851103792c58">relax_model</a></td></tr>
291291
<tr class="memdesc:a5cedf3ff171416c31d59851103792c58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Phase change relaxation model. <br /></td></tr>
292292
<tr class="separator:a5cedf3ff171416c31d59851103792c58"><td class="memSeparator" colspan="2">&#160;</td></tr>
293-
<tr class="memitem:abebd95d9d0271fbda40f47f75a2d829b" id="r_abebd95d9d0271fbda40f47f75a2d829b"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abebd95d9d0271fbda40f47f75a2d829b">adv_alphan</a></td></tr>
294-
<tr class="memdesc:abebd95d9d0271fbda40f47f75a2d829b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advection of the last volume fraction. <br /></td></tr>
295-
<tr class="separator:abebd95d9d0271fbda40f47f75a2d829b"><td class="memSeparator" colspan="2">&#160;</td></tr>
296293
<tr class="memitem:adc35ba450a192812db36f1d6659d64e6" id="r_adc35ba450a192812db36f1d6659d64e6"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adc35ba450a192812db36f1d6659d64e6">mpp_lim</a></td></tr>
297294
<tr class="memdesc:adc35ba450a192812db36f1d6659d64e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum volume fraction limiter. <br /></td></tr>
298295
<tr class="separator:adc35ba450a192812db36f1d6659d64e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -649,22 +646,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab08373aff5e7867fd0d6a24f
649646

650647
<p>Advection variables. </p>
651648

652-
</div>
653-
</div>
654-
<a id="abebd95d9d0271fbda40f47f75a2d829b" name="abebd95d9d0271fbda40f47f75a2d829b"></a>
655-
<h2 class="memtitle"><span class="permalink"><a href="#abebd95d9d0271fbda40f47f75a2d829b">&#9670;&#160;</a></span>adv_alphan</h2>
656-
657-
<div class="memitem">
658-
<div class="memproto">
659-
<table class="memname">
660-
<tr>
661-
<td class="memname">logical m_global_parameters::adv_alphan</td>
662-
</tr>
663-
</table>
664-
</div><div class="memdoc">
665-
666-
<p>Advection of the last volume fraction. </p>
667-
668649
</div>
669650
</div>
670651
<a id="ab73a1c5c3f6815695771323454db2a81" name="ab73a1c5c3f6815695771323454db2a81"></a>

0 commit comments

Comments
 (0)