Skip to content

Commit 08d1e0c

Browse files
author
MFC Action
committed
Docs @ bb21236
1 parent 3bb56eb commit 08d1e0c

File tree

116 files changed

+9943
-8844
lines changed

Some content is hidden

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

116 files changed

+9943
-8844
lines changed

documentation/md_case.html

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -643,7 +643,7 @@ <h2><a class="anchor" id="acoustic-source"></a>
643643
<tr class="markdownTableRowOdd">
644644
<td class="markdownTableBodyRight"><code>acoustic(i)%loc(j)</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">$j$-th coordinate of the point that defines the acoustic source location </td></tr>
645645
<tr class="markdownTableRowEven">
646-
<td class="markdownTableBodyRight"><code>acoustic(i)%pulse</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Acoustic wave form: [1] Sine [2] Gaussian [3] Square </td></tr>
646+
<td class="markdownTableBodyRight"><code>acoustic(i)%pulse</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Acoustic wave form: [1] Sine [2] Gaussian [3] Square [4] Broadband </td></tr>
647647
<tr class="markdownTableRowOdd">
648648
<td class="markdownTableBodyRight"><code>acoustic(i)%npulse</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Number of pulse cycles </td></tr>
649649
<tr class="markdownTableRowEven">
@@ -677,7 +677,13 @@ <h2><a class="anchor" id="acoustic-source"></a>
677677
<tr class="markdownTableRowEven">
678678
<td class="markdownTableBodyRight"><code>acoustic(i)%element_polygon_ratio</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">3D Transducer array - Ratio of polygon side length to transducer element radius </td></tr>
679679
<tr class="markdownTableRowOdd">
680-
<td class="markdownTableBodyRight"><code>acoustic(i)%rotate_angle</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">3D Transducer array - Rotation angle of the transducer array (optional; default = 0) </td></tr>
680+
<td class="markdownTableBodyRight"><code>acoustic(i)%rotate_angle</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">3D Transducer array - Rotation angle of the transducer array (optional; default = 0) </td></tr>
681+
<tr class="markdownTableRowEven">
682+
<td class="markdownTableBodyRight"><code>acoustic(i)%bb_num_freq</code> </td><td class="markdownTableBodyCenter">integer </td><td class="markdownTableBodyLeft">Number of frequencies in broadband wave </td></tr>
683+
<tr class="markdownTableRowOdd">
684+
<td class="markdownTableBodyRight"><code>acoustic(i)%bb_bandwidth</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">The bandwidth of each frequency in the broadband wave </td></tr>
685+
<tr class="markdownTableRowEven">
686+
<td class="markdownTableBodyRight"><code>acoustic(i)%bb_lowest_freq</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">The lower frequency bound of the broadband wave </td></tr>
681687
</table>
682688
<p>Details of the transducer acoustic source model can be found in <a href="references.md#Maeda17">Maeda and Colonius (2017)</a>.</p>
683689
<ul>
@@ -686,7 +692,7 @@ <h2><a class="anchor" id="acoustic-source"></a>
686692
<li><code>%support</code> specifies the choice of the geometry of acoustic source distribution. See table <a class="el" href="#acoustic-supports">Acoustic Supports</a> for details.</li>
687693
<li><code>%dipole</code> changes the default monopole (one-sided) source to a dipole source. It is only available for planar waves.</li>
688694
<li><code>%loc(j)</code> specifies the location of the acoustic source in the $j$-th coordinate direction. For planer support, the location defines midpoint of the source plane. For transducer arrays, the location defines the center of the transducer or transducer array (not the focal point; for 3D it's the tip of the spherical cap, for 2D it's the tip of the arc).</li>
689-
<li><code>%pulse</code> specifies the acoustic wave form. <code>%pulse = 1</code>, <code>2</code>, and <code>3</code> correspond to sinusoidal wave, Gaussian wave, and square wave, respectively.</li>
695+
<li><code>%pulse</code> specifies the acoustic wave form. <code>%pulse = 1</code>, <code>2</code>, <code>3</code> and <code>4</code> correspond to sinusoidal wave, Gaussian wave, square wave and broadband wave, respectively. The implementation of the broadband wave is based on <a href="references.md#Tam05">Tam (2005)</a></li>
690696
<li><code>%npulse</code> specifies the number of cycles of the acoustic wave generated. Only applies to <code>%pulse = 1 and 3</code> (sine and square waves), and must be an integer for non-planar waves.</li>
691697
<li><code>%mag</code> specifies the peak amplitude of the acoustic wave.</li>
692698
<li><code>%frequency</code> and <code>%wavelength</code> specify the frequency and wavelength of the acoustic wave, respectively. These parameters are exclusive and exactly one of them must be specified for <code>%pulse = 1</code> or <code>3</code> (sine or square waves). They are related by the speed of sound in the medium: <code>frequency = speed_of_sound / wavelength</code>.</li>
@@ -702,6 +708,9 @@ <h2><a class="anchor" id="acoustic-source"></a>
702708
<li><code>%element_spacing_angle</code> specifies the spacing angle between adjacent transducers in radians. The total aperture (<code>%aperture</code>) is set, so each transducer element is smaller if <code>%element_spacing_angle</code> is larger.</li>
703709
<li><code>%element_polygon_ratio</code> specifies the ratio of the polygon side length to the aperture diameter of each transducer element in a circular 3D transducer array. The polygon side length is calculated by using the total aperture (<code>%aperture</code>) as the circumcircle diameter and <code>%num_elements</code> as the number of sides of the polygon. The ratio is used to specify the aperture size of each transducer element in the array as a ratio of the total aperture.</li>
704710
<li><code>%rotate_angle</code> specifies the rotation angle of the 3D circular transducer array along the x-axis (principal axis). It is optional and defaults to 0.</li>
711+
<li><code>%bb_num_freq</code> specifies the number discretized frequencies in the broadband acoustic wave. If <code>%bb_num_freq</code> is 1, the acoustic wave will be a discrete tone (i.e. single frequency sine wave).</li>
712+
<li><code>%bb_bandwidth</code> specifies the bandwidth of the discretized frequencies.</li>
713+
<li><code>%bb_lowest_freq</code> specifies the lower frequency bound of the broadband acoustic wave. The upper frequency bound will be calculated as <code>%bb_lowest_freq + %bb_num_freq * %bb_bandwidth</code>. The wave is no longer broadband below the lower bound and above the upper bound.</li>
705714
</ul>
706715
<h2><a class="anchor" id="autotoc_md18"></a>
707716
9. Ensemble-Averaged Bubble Model</h2>

documentation/md_references.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,9 @@
197197
<li><a class="anchor" id="Suresh97"></a>Suresh, A. and Huynh, H. (1997). Accurate monotonicity-preserving schemes with runge–kutta time stepping. Journal of Computational Physics, 136(1):83–99.</li>
198198
</ul>
199199
<ul>
200+
<li><a class="anchor" id="Tam05"></a>Tam, C. K., Ju, H., Jones, M. G., Watson, W. R., and Parrott, T. L. (2005). A computational and experimental study of slit resonators. Journal of Sound and Vibration, 284(3-5), 947-984.</li>
201+
</ul>
202+
<ul>
200203
<li><a class="anchor" id="Thompson87"></a>Thompson, K. W. (1987). Time dependent boundary conditions for hyperbolic systems. Journal of computational physics, 68(1):1–24.</li>
201204
</ul>
202205
<ul>

post_process/doxygen_crawl.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,11 +147,13 @@
147147
<a href="namespacem__constants.html"/>
148148
<a href="namespacem__constants.html#a0b285066be796589a964ce4906432334"/>
149149
<a href="namespacem__constants.html#a0cf16707988911557a1775d347cc048b"/>
150+
<a href="namespacem__constants.html#a12e49665abc8df12f5d31790ad170ce3"/>
150151
<a href="namespacem__constants.html#a1de9ebff81a0be652121ae336ffb8757"/>
151152
<a href="namespacem__constants.html#a2678965621459e6045edb254772ffdb5"/>
152153
<a href="namespacem__constants.html#a36d9e57f65f9235b1e7b4abb690345a6"/>
153154
<a href="namespacem__constants.html#a3a14ef6d3e63d1d44ded46d378a9fff4"/>
154155
<a href="namespacem__constants.html#a3a243a8d9d072460385568d352ab338c"/>
156+
<a href="namespacem__constants.html#a4ed795abc33229c6dc7a0202337608e5"/>
155157
<a href="namespacem__constants.html#a7307e61136aff6d037cfe3fb99eefd14"/>
156158
<a href="namespacem__constants.html#a78c3f6cc5d1faa23da2ff4283e31fe4a"/>
157159
<a href="namespacem__constants.html#a89491724fc8077006ff1b62f981400ac"/>
@@ -504,6 +506,7 @@
504506
<a href="readme_8md.html"/>
505507
<a href="structacoustic__parameters-members.html"/>
506508
<a href="structacoustic__parameters.html"/>
509+
<a href="structacoustic__parameters.html#a030e7617e484fe015aa1c97946c93eb7"/>
507510
<a href="structacoustic__parameters.html#a2b60f883def3e468336e04ba9f372e6d"/>
508511
<a href="structacoustic__parameters.html#a30528827a005f7ab9864782e71266dde"/>
509512
<a href="structacoustic__parameters.html#a342ed1cd317962edd1f48ab1257a0be5"/>
@@ -520,6 +523,8 @@
520523
<a href="structacoustic__parameters.html#abd8535a1cf213fc02879a77b8d00a75c"/>
521524
<a href="structacoustic__parameters.html#abf704c6f69d01692703a38f9e1d60746"/>
522525
<a href="structacoustic__parameters.html#ae4dbcd70b9c3e83dddd95eee75534f1b"/>
526+
<a href="structacoustic__parameters.html#ae83d8b7ed9cafe8cc5fea4f537d49753"/>
527+
<a href="structacoustic__parameters.html#aeb87af0ef7e9ad023dbcb8306f2e5af8"/>
523528
<a href="structacoustic__parameters.html#aecde4c229e2b34ec696327c5bbc7c7a8"/>
524529
<a href="structacoustic__parameters.html#af2c66666b1de7af176cd2b3d45107d10"/>
525530
<a href="structacoustic__parameters.html#af3f69d9e1b857d80673bbc8e9515bc5d"/>

post_process/functions.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,9 @@ <h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
144144

145145

146146
<h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
147+
<li>bb_bandwidth&#160;:&#160;<a class="el" href="structacoustic__parameters.html#ae83d8b7ed9cafe8cc5fea4f537d49753">acoustic_parameters</a></li>
148+
<li>bb_lowest_freq&#160;:&#160;<a class="el" href="structacoustic__parameters.html#aeb87af0ef7e9ad023dbcb8306f2e5af8">acoustic_parameters</a></li>
149+
<li>bb_num_freq&#160;:&#160;<a class="el" href="structacoustic__parameters.html#a030e7617e484fe015aa1c97946c93eb7">acoustic_parameters</a></li>
147150
<li>beg&#160;:&#160;<a class="el" href="structbounds__info.html#a783d882ee47029bd1ee3541b9a026aa5">bounds_info</a>, <a class="el" href="structbub__bounds__info.html#ae7ba9f466a7c1600e636c59e19868452">bub_bounds_info</a>, <a class="el" href="structint__bounds__info.html#ad2f75876eb0cfa41efb1bbf84ae9da4b">int_bounds_info</a></li>
148151
<li>beta&#160;:&#160;<a class="el" href="structic__patch__parameters.html#ad33465b4315fa58d1a721807813c8c47">ic_patch_parameters</a></li>
149152
</ul>

post_process/functions_vars.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,9 @@ <h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
144144

145145

146146
<h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
147+
<li>bb_bandwidth&#160;:&#160;<a class="el" href="structacoustic__parameters.html#ae83d8b7ed9cafe8cc5fea4f537d49753">acoustic_parameters</a></li>
148+
<li>bb_lowest_freq&#160;:&#160;<a class="el" href="structacoustic__parameters.html#aeb87af0ef7e9ad023dbcb8306f2e5af8">acoustic_parameters</a></li>
149+
<li>bb_num_freq&#160;:&#160;<a class="el" href="structacoustic__parameters.html#a030e7617e484fe015aa1c97946c93eb7">acoustic_parameters</a></li>
147150
<li>beg&#160;:&#160;<a class="el" href="structbounds__info.html#a783d882ee47029bd1ee3541b9a026aa5">bounds_info</a>, <a class="el" href="structbub__bounds__info.html#ae7ba9f466a7c1600e636c59e19868452">bub_bounds_info</a>, <a class="el" href="structint__bounds__info.html#ad2f75876eb0cfa41efb1bbf84ae9da4b">int_bounds_info</a></li>
148151
<li>beta&#160;:&#160;<a class="el" href="structic__patch__parameters.html#ad33465b4315fa58d1a721807813c8c47">ic_patch_parameters</a></li>
149152
</ul>

post_process/m__constants_8fpp_8f90.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,12 @@
201201
<tr class="memitem:a3a243a8d9d072460385568d352ab338c" id="r_a3a243a8d9d072460385568d352ab338c"><td class="memItemLeft" align="right" valign="top">real(kind(0d0)), parameter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__constants.html#a3a243a8d9d072460385568d352ab338c">m_constants::dflt_vcfl_dt</a> = 100d0</td></tr>
202202
<tr class="memdesc:a3a243a8d9d072460385568d352ab338c"><td class="mdescLeft">&#160;</td><td class="mdescRight">value of vcfl_dt when viscosity is off for computing adaptive timestep size <br /></td></tr>
203203
<tr class="separator:a3a243a8d9d072460385568d352ab338c"><td class="memSeparator" colspan="2">&#160;</td></tr>
204+
<tr class="memitem:a12e49665abc8df12f5d31790ad170ce3" id="r_a12e49665abc8df12f5d31790ad170ce3"><td class="memItemLeft" align="right" valign="top">real(kind(0d0)), parameter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__constants.html#a12e49665abc8df12f5d31790ad170ce3">m_constants::broadband_spectral_level_constant</a> = 20d0</td></tr>
205+
<tr class="memdesc:a12e49665abc8df12f5d31790ad170ce3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The constant to scale the spectral level at the lower frequency bound. <br /></td></tr>
206+
<tr class="separator:a12e49665abc8df12f5d31790ad170ce3"><td class="memSeparator" colspan="2">&#160;</td></tr>
207+
<tr class="memitem:a4ed795abc33229c6dc7a0202337608e5" id="r_a4ed795abc33229c6dc7a0202337608e5"><td class="memItemLeft" align="right" valign="top">real(kind(0d0)), parameter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__constants.html#a4ed795abc33229c6dc7a0202337608e5">m_constants::broadband_spectral_level_growth_rate</a> = 10d0</td></tr>
208+
<tr class="memdesc:a4ed795abc33229c6dc7a0202337608e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The spectral level constant to correct the magnitude at each frqeuency to ensure the source is overall broadband. <br /></td></tr>
209+
<tr class="separator:a4ed795abc33229c6dc7a0202337608e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
204210
</table>
205211
</div><!-- contents -->
206212
</div><!-- doc-content -->

post_process/m__constants_8fpp_8f90.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
var m__constants_8fpp_8f90 =
22
[
33
[ "m_constants::acoustic_spatial_support_width", "namespacem__constants.html#ab6dedacbf78b91cd293dcd12dc1d5cd1", null ],
4+
[ "m_constants::broadband_spectral_level_constant", "namespacem__constants.html#a12e49665abc8df12f5d31790ad170ce3", null ],
5+
[ "m_constants::broadband_spectral_level_growth_rate", "namespacem__constants.html#a4ed795abc33229c6dc7a0202337608e5", null ],
46
[ "m_constants::capillary_cutoff", "namespacem__constants.html#a0cf16707988911557a1775d347cc048b", null ],
57
[ "m_constants::dflt_char", "namespacem__constants.html#a89491724fc8077006ff1b62f981400ac", null ],
68
[ "m_constants::dflt_int", "namespacem__constants.html#a36d9e57f65f9235b1e7b4abb690345a6", null ],

post_process/namespacem__constants.html

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,12 @@
195195
<tr class="memitem:a3a243a8d9d072460385568d352ab338c" id="r_a3a243a8d9d072460385568d352ab338c"><td class="memItemLeft" align="right" valign="top">real(kind(0d0)), parameter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3a243a8d9d072460385568d352ab338c">dflt_vcfl_dt</a> = 100d0</td></tr>
196196
<tr class="memdesc:a3a243a8d9d072460385568d352ab338c"><td class="mdescLeft">&#160;</td><td class="mdescRight">value of vcfl_dt when viscosity is off for computing adaptive timestep size <br /></td></tr>
197197
<tr class="separator:a3a243a8d9d072460385568d352ab338c"><td class="memSeparator" colspan="2">&#160;</td></tr>
198+
<tr class="memitem:a12e49665abc8df12f5d31790ad170ce3" id="r_a12e49665abc8df12f5d31790ad170ce3"><td class="memItemLeft" align="right" valign="top">real(kind(0d0)), parameter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a12e49665abc8df12f5d31790ad170ce3">broadband_spectral_level_constant</a> = 20d0</td></tr>
199+
<tr class="memdesc:a12e49665abc8df12f5d31790ad170ce3"><td class="mdescLeft">&#160;</td><td class="mdescRight">The constant to scale the spectral level at the lower frequency bound. <br /></td></tr>
200+
<tr class="separator:a12e49665abc8df12f5d31790ad170ce3"><td class="memSeparator" colspan="2">&#160;</td></tr>
201+
<tr class="memitem:a4ed795abc33229c6dc7a0202337608e5" id="r_a4ed795abc33229c6dc7a0202337608e5"><td class="memItemLeft" align="right" valign="top">real(kind(0d0)), parameter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ed795abc33229c6dc7a0202337608e5">broadband_spectral_level_growth_rate</a> = 10d0</td></tr>
202+
<tr class="memdesc:a4ed795abc33229c6dc7a0202337608e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The spectral level constant to correct the magnitude at each frqeuency to ensure the source is overall broadband. <br /></td></tr>
203+
<tr class="separator:a4ed795abc33229c6dc7a0202337608e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
198204
</table>
199205
<h2 class="groupheader">Variable Documentation</h2>
200206
<a id="ab6dedacbf78b91cd293dcd12dc1d5cd1" name="ab6dedacbf78b91cd293dcd12dc1d5cd1"></a>
@@ -211,6 +217,38 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab6dedacbf78b91cd293dcd12
211217

212218
<p>Spatial support width of acoustic source, used in s_source_spatial. </p>
213219

220+
</div>
221+
</div>
222+
<a id="a12e49665abc8df12f5d31790ad170ce3" name="a12e49665abc8df12f5d31790ad170ce3"></a>
223+
<h2 class="memtitle"><span class="permalink"><a href="#a12e49665abc8df12f5d31790ad170ce3">&#9670;&#160;</a></span>broadband_spectral_level_constant</h2>
224+
225+
<div class="memitem">
226+
<div class="memproto">
227+
<table class="memname">
228+
<tr>
229+
<td class="memname">real(kind(0d0)), parameter m_constants::broadband_spectral_level_constant = 20d0</td>
230+
</tr>
231+
</table>
232+
</div><div class="memdoc">
233+
234+
<p>The constant to scale the spectral level at the lower frequency bound. </p>
235+
236+
</div>
237+
</div>
238+
<a id="a4ed795abc33229c6dc7a0202337608e5" name="a4ed795abc33229c6dc7a0202337608e5"></a>
239+
<h2 class="memtitle"><span class="permalink"><a href="#a4ed795abc33229c6dc7a0202337608e5">&#9670;&#160;</a></span>broadband_spectral_level_growth_rate</h2>
240+
241+
<div class="memitem">
242+
<div class="memproto">
243+
<table class="memname">
244+
<tr>
245+
<td class="memname">real(kind(0d0)), parameter m_constants::broadband_spectral_level_growth_rate = 10d0</td>
246+
</tr>
247+
</table>
248+
</div><div class="memdoc">
249+
250+
<p>The spectral level constant to correct the magnitude at each frqeuency to ensure the source is overall broadband. </p>
251+
214252
</div>
215253
</div>
216254
<a id="a0cf16707988911557a1775d347cc048b" name="a0cf16707988911557a1775d347cc048b"></a>

post_process/namespacemembers_b.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,8 @@ <h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
138138
<li>bc_x&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a91304734742c36abcb4dbf0712545344">m_global_parameters</a></li>
139139
<li>bc_y&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a7a7bb7c9caddde4f86bd27169b0f150d">m_global_parameters</a></li>
140140
<li>bc_z&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a2d3a5d211f996a1fff3238a8b7fe5fe7">m_global_parameters</a></li>
141+
<li>broadband_spectral_level_constant&#160;:&#160;<a class="el" href="namespacem__constants.html#a12e49665abc8df12f5d31790ad170ce3">m_constants</a></li>
142+
<li>broadband_spectral_level_growth_rate&#160;:&#160;<a class="el" href="namespacem__constants.html#a4ed795abc33229c6dc7a0202337608e5">m_constants</a></li>
141143
<li>bub_idx&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a9a425d1bd91d1765043adf8410b98bf7">m_global_parameters</a></li>
142144
<li>bubbles&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a4a22ed160838f8fbe6bd506f334b8815">m_global_parameters</a></li>
143145
<li>bubxb&#160;:&#160;<a class="el" href="namespacem__global__parameters.html#a0b5e4db635f8e008713c89bd4b476341">m_global_parameters</a></li>

0 commit comments

Comments
 (0)