Skip to content

Commit 4697870

Browse files
author
MFC Action
committed
Docs @ a1f3f47
1 parent 1d78a7f commit 4697870

Some content is hidden

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

49 files changed

+321
-577
lines changed

documentation/doxygen_crawl.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
<body>
1111
<a href="md_authors.html"/>
1212
<a href="md_case.html"/>
13-
<a href="md_CODE__OF__CONDUCT.html"/>
1413
<a href="md_examples.html"/>
1514
<a href="md_expectedPerformance.html"/>
1615
<a href="md_getting-started.html"/>

documentation/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@
127127
</div><!--header-->
128128
<div class="contents">
129129
<div class="textblock"><p><a class="anchor" id="md_readme"></a> </p>
130-
<h1><a class="anchor" id="autotoc_md80"></a>
130+
<h1><a class="anchor" id="autotoc_md68"></a>
131131
User Documentation</h1>
132132
<ul>
133133
<li><a class="el" href="md_getting-started.html">Getting Started</a></li>
@@ -140,7 +140,7 @@ <h1><a class="anchor" id="autotoc_md80"></a>
140140
<li><a class="el" href="md_authors.html">MFC's Authors</a></li>
141141
<li><a class="el" href="md_references.html">References</a></li>
142142
</ul>
143-
<h1><a class="anchor" id="autotoc_md81"></a>
143+
<h1><a class="anchor" id="autotoc_md69"></a>
144144
Code/API Documentation</h1>
145145
<p>MFC's three codes have their own documentation:</p>
146146
<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_md80", null ],
4-
[ "Code/API Documentation", "index.html#autotoc_md81", null ]
3+
[ "User Documentation", "index.html#autotoc_md68", null ],
4+
[ "Code/API Documentation", "index.html#autotoc_md69", null ]
55
];

documentation/md_CODE__OF__CONDUCT.html

Lines changed: 0 additions & 198 deletions
This file was deleted.

documentation/md_case.html

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,9 @@ <h2><a class="anchor" id="autotoc_md7"></a>
283283
<tr class="markdownTableRowOdd">
284284
<td class="markdownTableBodyRight"><code>modeltranslate(i)</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyCenter">Not Supported </td><td class="markdownTableBodyLeft">Model's $i$-th component of (applied) translation. </td></tr>
285285
<tr class="markdownTableRowEven">
286-
<td class="markdownTableBodyRight"><code>modelspc</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyCenter">Not Supported </td><td class="markdownTableBodyLeft">Number of samples per cell when discretizing the model into the grid. </td></tr>
286+
<td class="markdownTableBodyRight"><code>modelspc</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyCenter">Not Supported </td><td class="markdownTableBodyLeft">Number of samples per cell when discretizing the model into the grid. </td></tr>
287+
<tr class="markdownTableRowOdd">
288+
<td class="markdownTableBodyRight"><code>modelthreshold</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyCenter">Not Supported </td><td class="markdownTableBodyLeft">Ray fraction inside the model patch above which the fraction is set to one. </td></tr>
287289
</table>
288290
<p>*: These parameters should be prepended with <code>patch_icpp(j)%</code> where $j$ is the patch index.</p>
289291
<p>The Table lists the patch parameters. The parameters define the geometries and physical parameters of fluid components (patch) in the domain at initial condition. Note that the domain must be fully filled with patche(s). The code outputs error messages when an empty region is left in the domain.</p>
@@ -536,12 +538,14 @@ <h2><a class="anchor" id="autotoc_md14"></a>
536538
<tr class="markdownTableRowOdd">
537539
<td class="markdownTableBodyRight"><code>Mono(i)support</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Type of the spatial support of the acoustic source : [1] 1D [2] Finite width (2D) [3] Support for finite line/patch [4] General support for 3D simulation in cartesian systems [5] Support along monopole acoustic transducer [6] Support for cylindrical coordinate system along axial-dir </td></tr>
538540
<tr class="markdownTableRowEven">
539-
<td class="markdownTableBodyRight"><code>Mono(i)loc(j)</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">$j$-th coordinate of the point that consists of $i$-th source plane </td></tr>
541+
<td class="markdownTableBodyRight"><code>Mono(i)support_width</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">The width of the monopole support in terms of cell width </td></tr>
540542
<tr class="markdownTableRowOdd">
541-
<td class="markdownTableBodyRight"><code>Mono(i)dir</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Direction of acoustic propagation </td></tr>
543+
<td class="markdownTableBodyRight"><code>Mono(i)loc(j)</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">$j$-th coordinate of the point that consists of $i$-th source plane </td></tr>
542544
<tr class="markdownTableRowEven">
543-
<td class="markdownTableBodyRight"><code>Mono(i)mag</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Pulse magnitude </td></tr>
545+
<td class="markdownTableBodyRight"><code>Mono(i)dir</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Direction of acoustic propagation </td></tr>
544546
<tr class="markdownTableRowOdd">
547+
<td class="markdownTableBodyRight"><code>Mono(i)mag</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Pulse magnitude </td></tr>
548+
<tr class="markdownTableRowEven">
545549
<td class="markdownTableBodyRight"><code>Mono(i)length</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Spatial pulse length </td></tr>
546550
</table>
547551
<p>The table lists acoustic source parameters. The parameters are optionally used to define a source plane in the domain that generates an acoustic wave that propagates in a specified direction normal to the source plane (one-way acoustic source). Details of the acoustic source model can be found in <a href="references.md#Maeda17">Maeda and Colonius (2017)</a>.</p>
@@ -553,6 +557,7 @@ <h2><a class="anchor" id="autotoc_md14"></a>
553557
<li><code>Mono(i)mag</code> defines the peak amplitude of the acoustic wave generated from $i$-th source plane with a given wave form.</li>
554558
<li><code>Mono(i)length</code> defines the characteristic wavelength of the acoustic wave generated from $i$-th source plane.</li>
555559
<li><code>Mono(i)support</code> specifies the choice of the geometry of acoustic source distribution of $i$-th source plane by an integer from 1 through 3:\ <code>Mono(i)support</code> $=1$ specifies an infinite source plane that is normal to the $x$-axis and intersects with the axis at $x=$ <code>Mono(i)loc(1)</code> in 1-D simulation.\ <code>Mono(i)support</code> $=2$ specifies a semi-infinite source plane in 2-D simulation. The $i$-th source plane is determined by the point at [<code>Mono(i)loc(1)</code>, <code>Mono(i)loc(2)</code>] and the normal vector [$\mathrm{cos}$(<code>Mono(i)dir</code>), $\mathrm{sin}$(<code>Mono(i)dir</code>)] that consists of this point. The source plane is defined in the finite region of the domain: $x\in[-\infty,\infty]$ and $y\in$[-<code>mymono_length</code>/2, <code>mymono_length</code>/2].\ <code>Mono(i)support</code> $=3$ specifies a semi-infinite source plane in 3-D simulation. The $i$-th source plane is determined by the point at [<code>Mono(i)loc(1)</code>, <code>Mono(i)loc(2)</code>, <code>Mono(i)loc(3)</code>] and the normal vector [$\mathrm{cos}$(<code>Mono(i)dir</code>), $\mathrm{sin}$(<code>Mono(i)dir</code>), 1] that consists of this point. The source plane is defined in the finite region of the domain: $x\in[-\infty,\infty]$ and $y,z\in$[-<code>mymono_length</code>/2, <code>mymono_length</code>/2]. There are a few additional spatial support types available for special source types and coordinate systems tabulated in Monopole supports.</li>
560+
<li><code>Mono(i)support_width</code> defines how many cell width the monopole support function extended by. Large <code>Mono(i)support_width</code> is preferred when <code>Mono(i)mag</code> is large.</li>
556561
</ul>
557562
<h2><a class="anchor" id="autotoc_md15"></a>
558563
8. Ensemble-Averaged Bubble Model</h2>

0 commit comments

Comments
 (0)