Skip to content

Commit 414b1b1

Browse files
author
MFC Action
committed
Docs @ 530e1a5
1 parent 2a6b73f commit 414b1b1

File tree

171 files changed

+14292
-13740
lines changed

Some content is hidden

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

171 files changed

+14292
-13740
lines changed

documentation/md_case.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ <h2><a class="anchor" id="acoustic-source"></a>
601601
<tr class="markdownTableRowOdd">
602602
<td class="markdownTableBodyRight"><code>acoustic(i)%support</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Geometry of spatial support for the acoustic source </td></tr>
603603
<tr class="markdownTableRowEven">
604-
<td class="markdownTableBodyRight"><code>acoustic(i)%dipole</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Dipole source activation (optional; default = false for monopole) </td></tr>
604+
<td class="markdownTableBodyRight"><code>acoustic(i)%dipole</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Dipole source activation (optional; default = false -&gt; monopole) </td></tr>
605605
<tr class="markdownTableRowOdd">
606606
<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>
607607
<tr class="markdownTableRowEven">
@@ -633,7 +633,7 @@ <h2><a class="anchor" id="acoustic-source"></a>
633633
<tr class="markdownTableRowOdd">
634634
<td class="markdownTableBodyRight"><code>acoustic(i)%num_elements</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Transducer array - Number of transducer elements in a transducer array </td></tr>
635635
<tr class="markdownTableRowEven">
636-
<td class="markdownTableBodyRight"><code>acoustic(i)%element_on</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Transducer array - Element number that is on (optional; default = 0 for all elements) </td></tr>
636+
<td class="markdownTableBodyRight"><code>acoustic(i)%element_on</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Transducer array - Element number that is on (optional; default = 0 -&gt; all elements) </td></tr>
637637
<tr class="markdownTableRowOdd">
638638
<td class="markdownTableBodyRight"><code>acoustic(i)%element_spacing_angle</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">2D Transducer array - Spacing angle (in rad) between adjacent transducer elements </td></tr>
639639
<tr class="markdownTableRowEven">
@@ -964,7 +964,7 @@ <h2><a class="anchor" id="acoustic-supports"></a>
964964
<tr class="markdownTableRowEven">
965965
<td class="markdownTableBodyRight">10 </td><td class="markdownTableBodyCenter">Annular Transducer Array </td><td class="markdownTableBodyCenter">2D-Axisym </td><td class="markdownTableBodyLeft">#9 requirements </td></tr>
966966
<tr class="markdownTableRowOdd">
967-
<td class="markdownTableBodyRight">11 </td><td class="markdownTableBodyCenter">Circular Transducer Array </td><td class="markdownTableBodyCenter">3D </td><td class="markdownTableBodyLeft">#7 requirements, <code>%element_polygon_ratio</code>, and <code>%rotate_angle</code>(optional; default = 0) </td></tr>
967+
<td class="markdownTableBodyRight">11 </td><td class="markdownTableBodyCenter">Circular Transducer Array </td><td class="markdownTableBodyCenter">3D </td><td class="markdownTableBodyLeft">#7 requirements, <code>%element_polygon_ratio</code>, and <code>%rotate_angle</code> </td></tr>
968968
</table>
969969
<p>Details of the required parameters for each acoustic support type are listed in <a class="el" href="#acoustic-source">Acoustic Source</a>. The acoustic support number (<code>#</code>) corresponds to the acoustic support type <code>Acoustic(i)%support</code>, where $i$ is the acoustic source index. For each <code>%parameter</code>, prepend the parameter with <code>acoustic(i)%</code>.</p>
970970
<p>Additional requirements for all acoustic support types:</p><ul>

documentation/md_getting-started.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ <h1><a class="anchor" id="autotoc_md78"></a>
151151
<li><b>On supported clusters:</b> Load environment modules</li>
152152
</ul>
153153
<div class="fragment"><div class="line">. ./mfc.sh load</div>
154-
</div><!-- fragment --><p><a class="anchor" id="via-aptitude"></a></p><ul>
154+
</div><!-- fragment --><ul>
155155
<li><b>Via <a href="https://wiki.debian.org/Aptitude">Aptitude</a>:</b></li>
156156
</ul>
157157
<div class="fragment"><div class="line">sudo apt update</div>
@@ -195,7 +195,7 @@ <h1><a class="anchor" id="autotoc_md78"></a>
195195
<li><a href="https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701">Windows Terminal</a></li>
196196
<li><a href="https://code.visualstudio.com/">Visual Studio Code</a> and the <a href="https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl">Remote - WSL</a> extension</li>
197197
</ul>
198-
<p>Once you have WSL installed, you can follow the instructions for *nix systems above (for Ubuntu, see Via Aptitude).</p>
198+
<p>Once you have WSL installed, you can follow the instructions for *nix systems above (for Ubuntu, see <code>Via Aptitude</code> section).</p>
199199
<p></p>
200200
</details>
201201
<details >

post_process/annotated.html

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -156,11 +156,12 @@
156156
<tr id="row_16_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpres__field.html" target="_self">pres_field</a></td><td class="desc">Derived type for bubble variables pb and mv at quadrature nodes (qbmm) </td></tr>
157157
<tr id="row_17_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structprobe__parameters.html" target="_self">probe_parameters</a></td><td class="desc">Derived type annexing the flow probe location </td></tr>
158158
<tr id="row_18_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structscalar__field.html" target="_self">scalar_field</a></td><td class="desc">Derived type annexing a scalar field (SF) </td></tr>
159-
<tr id="row_19_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__bbox.html" target="_self">t_bbox</a></td><td class="desc"></td></tr>
160-
<tr id="row_20_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__model.html" target="_self">t_model</a></td><td class="desc"></td></tr>
161-
<tr id="row_21_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__ray.html" target="_self">t_ray</a></td><td class="desc"></td></tr>
162-
<tr id="row_22_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__triangle.html" target="_self">t_triangle</a></td><td class="desc"></td></tr>
163-
<tr id="row_23_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvector__field.html" target="_self">vector_field</a></td><td class="desc">Derived type annexing a vector field (VF) </td></tr>
159+
<tr id="row_19_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsource__spatial__type.html" target="_self">source_spatial_type</a></td><td class="desc">Acoustic source source_spatial pre-calculated values </td></tr>
160+
<tr id="row_20_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__bbox.html" target="_self">t_bbox</a></td><td class="desc"></td></tr>
161+
<tr id="row_21_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__model.html" target="_self">t_model</a></td><td class="desc"></td></tr>
162+
<tr id="row_22_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__ray.html" target="_self">t_ray</a></td><td class="desc"></td></tr>
163+
<tr id="row_23_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structt__triangle.html" target="_self">t_triangle</a></td><td class="desc"></td></tr>
164+
<tr id="row_24_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structvector__field.html" target="_self">vector_field</a></td><td class="desc">Derived type annexing a vector field (VF) </td></tr>
164165
</table>
165166
</div><!-- directory -->
166167
</div><!-- contents -->

post_process/annotated_dup.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ var annotated_dup =
2121
[ "pres_field", "structpres__field.html", "structpres__field" ],
2222
[ "probe_parameters", "structprobe__parameters.html", "structprobe__parameters" ],
2323
[ "scalar_field", "structscalar__field.html", "structscalar__field" ],
24+
[ "source_spatial_type", "structsource__spatial__type.html", "structsource__spatial__type" ],
2425
[ "t_bbox", "structt__bbox.html", null ],
2526
[ "t_model", "structt__model.html", "structt__model" ],
2627
[ "t_ray", "structt__ray.html", null ],

post_process/classes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@
159159
<dd><a class="el" href="structphysical__parameters.html">physical_parameters</a></dd><dd><a class="el" href="structpres__field.html">pres_field</a></dd><dd><a class="el" href="structprobe__parameters.html">probe_parameters</a></dd></dl>
160160
<dl class="classindex odd">
161161
<dt class="alphachar"><a id="letter_S" name="letter_S">S</a></dt>
162-
<dd><a class="el" href="interfacem__data__input_1_1s__read__abstract__data__files.html">s_read_abstract_data_files</a> (<a class="el" href="namespacem__data__input.html">m_data_input</a>)</dd><dd><a class="el" href="structscalar__field.html">scalar_field</a></dd></dl>
162+
<dd><a class="el" href="interfacem__data__input_1_1s__read__abstract__data__files.html">s_read_abstract_data_files</a> (<a class="el" href="namespacem__data__input.html">m_data_input</a>)</dd><dd><a class="el" href="structscalar__field.html">scalar_field</a></dd><dd><a class="el" href="structsource__spatial__type.html">source_spatial_type</a></dd></dl>
163163
<dl class="classindex even">
164164
<dt class="alphachar"><a id="letter_T" name="letter_T">T</a></dt>
165165
<dd><a class="el" href="structt__bbox.html">t_bbox</a></dd><dd><a class="el" href="structt__model.html">t_model</a></dd><dd><a class="el" href="structt__ray.html">t_ray</a></dd><dd><a class="el" href="structt__triangle.html">t_triangle</a></dd></dl>

post_process/doxygen_crawl.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@
6464
<a href="structprobe__parameters-members.html"/>
6565
<a href="structscalar__field.html"/>
6666
<a href="structscalar__field-members.html"/>
67+
<a href="structsource__spatial__type.html"/>
68+
<a href="structsource__spatial__type-members.html"/>
6769
<a href="structt__bbox.html"/>
6870
<a href="structt__model.html"/>
6971
<a href="structt__model-members.html"/>
@@ -1125,6 +1127,11 @@
11251127
<a href="structprobe__parameters.html#ad037d50888db04c05a05d4587c6ca1e9"/>
11261128
<a href="structscalar__field.html"/>
11271129
<a href="structscalar__field.html#a7211e3e27133d75fe14cf95313d22b95"/>
1130+
<a href="structsource__spatial__type.html"/>
1131+
<a href="structsource__spatial__type.html#a2094446268a51778f9846f053ef7e758"/>
1132+
<a href="structsource__spatial__type.html#a4719a19afe06dbf206e31eed1733929c"/>
1133+
<a href="structsource__spatial__type.html#a6547060dff8eb0d6860486118df71264"/>
1134+
<a href="structsource__spatial__type.html#a911e89938c3cbc54d115895a10ae9195"/>
11281135
<a href="structt__bbox.html"/>
11291136
<a href="structt__model.html"/>
11301137
<a href="structt__model.html#a2263885506ecea0b2c00f9de9c103848"/>

post_process/functions.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ <h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
137137
<li>alpha&#160;:&#160;<a class="el" href="structic__patch__parameters.html#a0838c73a398dbe9c779bcc57d274d768">ic_patch_parameters</a></li>
138138
<li>alpha_rho&#160;:&#160;<a class="el" href="structic__patch__parameters.html#a38e1f7414e57b23f1c12882b8d658a09">ic_patch_parameters</a></li>
139139
<li>alter_patch&#160;:&#160;<a class="el" href="structic__patch__parameters.html#a10f9edd7266af0f6df917f44f739133e">ic_patch_parameters</a></li>
140+
<li>angle&#160;:&#160;<a class="el" href="structsource__spatial__type.html#a4719a19afe06dbf206e31eed1733929c">source_spatial_type</a></li>
140141
<li>aperture&#160;:&#160;<a class="el" href="structacoustic__parameters.html#af2c66666b1de7af176cd2b3d45107d10">acoustic_parameters</a></li>
141142
</ul>
142143

@@ -150,6 +151,7 @@ <h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
150151
<h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
151152
<li>c&#160;:&#160;<a class="el" href="structib__patch__parameters.html#a35d7e9123ec3b3bb3fda981da75944dc">ib_patch_parameters</a></li>
152153
<li>cf_val&#160;:&#160;<a class="el" href="structic__patch__parameters.html#ae1b668d59b9015be4fda1039eb535c11">ic_patch_parameters</a></li>
154+
<li>coord&#160;:&#160;<a class="el" href="structsource__spatial__type.html#a911e89938c3cbc54d115895a10ae9195">source_spatial_type</a></li>
153155
<li>cv&#160;:&#160;<a class="el" href="structic__patch__parameters.html#a4ea2714f2984f0fbe34f79e41ff7d311">ic_patch_parameters</a>, <a class="el" href="structphysical__parameters.html#a82e92f193d2ba4bbe654b8fcabdaa5b2">physical_parameters</a></li>
154156
</ul>
155157

@@ -292,6 +294,7 @@ <h3><a id="index_t" name="index_t"></a>- t -</h3><ul>
292294
<h3><a id="index_v" name="index_v"></a>- v -</h3><ul>
293295
<li>v&#160;:&#160;<a class="el" href="structt__triangle.html#ab52f0d7e206e92ace1517c07751a9116">t_triangle</a></li>
294296
<li>v0&#160;:&#160;<a class="el" href="structic__patch__parameters.html#a0837815fead87148dbf9e1834b6888be">ic_patch_parameters</a></li>
297+
<li>val&#160;:&#160;<a class="el" href="structsource__spatial__type.html#a6547060dff8eb0d6860486118df71264">source_spatial_type</a></li>
295298
<li>var&#160;:&#160;<a class="el" href="structmpi__io__airfoil__ib__var.html#affafefc777142fe06d1351c654c854db">mpi_io_airfoil_ib_var</a>, <a class="el" href="structmpi__io__ib__var.html#a68a91a0048aeace0afff29388fca2ddc">mpi_io_ib_var</a>, <a class="el" href="structmpi__io__var.html#a0bbaa5dabe397616a7df8164d4255c53">mpi_io_var</a></li>
296299
<li>vb1&#160;:&#160;<a class="el" href="structint__bounds__info.html#a55fa9ed7d8e81c703ae4d44c657c746a">int_bounds_info</a></li>
297300
<li>vb2&#160;:&#160;<a class="el" href="structint__bounds__info.html#a79976af3f2dff298b18518db8c41493c">int_bounds_info</a></li>
@@ -316,6 +319,7 @@ <h3><a id="index_x" name="index_x"></a>- x -</h3><ul>
316319
<li>x_centroid&#160;:&#160;<a class="el" href="structib__patch__parameters.html#a292b92bd9c81bb90fd6a7a54fc6253ac">ib_patch_parameters</a>, <a class="el" href="structic__patch__parameters.html#afb0dddceef3dbd4ac089bd8fdc3929cb">ic_patch_parameters</a></li>
317320
<li>xmax&#160;:&#160;<a class="el" href="structintegral__parameters.html#a0815d18b18d76950bbef54d994313df1">integral_parameters</a></li>
318321
<li>xmin&#160;:&#160;<a class="el" href="structintegral__parameters.html#ac449f2069c101eaf08cd9c7a84818135">integral_parameters</a></li>
322+
<li>xyz_to_r_ratios&#160;:&#160;<a class="el" href="structsource__spatial__type.html#a2094446268a51778f9846f053ef7e758">source_spatial_type</a></li>
319323
</ul>
320324

321325

post_process/functions_vars.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@ <h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
137137
<li>alpha&#160;:&#160;<a class="el" href="structic__patch__parameters.html#a0838c73a398dbe9c779bcc57d274d768">ic_patch_parameters</a></li>
138138
<li>alpha_rho&#160;:&#160;<a class="el" href="structic__patch__parameters.html#a38e1f7414e57b23f1c12882b8d658a09">ic_patch_parameters</a></li>
139139
<li>alter_patch&#160;:&#160;<a class="el" href="structic__patch__parameters.html#a10f9edd7266af0f6df917f44f739133e">ic_patch_parameters</a></li>
140+
<li>angle&#160;:&#160;<a class="el" href="structsource__spatial__type.html#a4719a19afe06dbf206e31eed1733929c">source_spatial_type</a></li>
140141
<li>aperture&#160;:&#160;<a class="el" href="structacoustic__parameters.html#af2c66666b1de7af176cd2b3d45107d10">acoustic_parameters</a></li>
141142
</ul>
142143

@@ -150,6 +151,7 @@ <h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
150151
<h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
151152
<li>c&#160;:&#160;<a class="el" href="structib__patch__parameters.html#a35d7e9123ec3b3bb3fda981da75944dc">ib_patch_parameters</a></li>
152153
<li>cf_val&#160;:&#160;<a class="el" href="structic__patch__parameters.html#ae1b668d59b9015be4fda1039eb535c11">ic_patch_parameters</a></li>
154+
<li>coord&#160;:&#160;<a class="el" href="structsource__spatial__type.html#a911e89938c3cbc54d115895a10ae9195">source_spatial_type</a></li>
153155
<li>cv&#160;:&#160;<a class="el" href="structic__patch__parameters.html#a4ea2714f2984f0fbe34f79e41ff7d311">ic_patch_parameters</a>, <a class="el" href="structphysical__parameters.html#a82e92f193d2ba4bbe654b8fcabdaa5b2">physical_parameters</a></li>
154156
</ul>
155157

@@ -291,6 +293,7 @@ <h3><a id="index_t" name="index_t"></a>- t -</h3><ul>
291293
<h3><a id="index_v" name="index_v"></a>- v -</h3><ul>
292294
<li>v&#160;:&#160;<a class="el" href="structt__triangle.html#ab52f0d7e206e92ace1517c07751a9116">t_triangle</a></li>
293295
<li>v0&#160;:&#160;<a class="el" href="structic__patch__parameters.html#a0837815fead87148dbf9e1834b6888be">ic_patch_parameters</a></li>
296+
<li>val&#160;:&#160;<a class="el" href="structsource__spatial__type.html#a6547060dff8eb0d6860486118df71264">source_spatial_type</a></li>
294297
<li>var&#160;:&#160;<a class="el" href="structmpi__io__airfoil__ib__var.html#affafefc777142fe06d1351c654c854db">mpi_io_airfoil_ib_var</a>, <a class="el" href="structmpi__io__ib__var.html#a68a91a0048aeace0afff29388fca2ddc">mpi_io_ib_var</a>, <a class="el" href="structmpi__io__var.html#a0bbaa5dabe397616a7df8164d4255c53">mpi_io_var</a></li>
295298
<li>vb1&#160;:&#160;<a class="el" href="structint__bounds__info.html#a55fa9ed7d8e81c703ae4d44c657c746a">int_bounds_info</a></li>
296299
<li>vb2&#160;:&#160;<a class="el" href="structint__bounds__info.html#a79976af3f2dff298b18518db8c41493c">int_bounds_info</a></li>
@@ -315,6 +318,7 @@ <h3><a id="index_x" name="index_x"></a>- x -</h3><ul>
315318
<li>x_centroid&#160;:&#160;<a class="el" href="structib__patch__parameters.html#a292b92bd9c81bb90fd6a7a54fc6253ac">ib_patch_parameters</a>, <a class="el" href="structic__patch__parameters.html#afb0dddceef3dbd4ac089bd8fdc3929cb">ic_patch_parameters</a></li>
316319
<li>xmax&#160;:&#160;<a class="el" href="structintegral__parameters.html#a0815d18b18d76950bbef54d994313df1">integral_parameters</a></li>
317320
<li>xmin&#160;:&#160;<a class="el" href="structintegral__parameters.html#ac449f2069c101eaf08cd9c7a84818135">integral_parameters</a></li>
321+
<li>xyz_to_r_ratios&#160;:&#160;<a class="el" href="structsource__spatial__type.html#a2094446268a51778f9846f053ef7e758">source_spatial_type</a></li>
318322
</ul>
319323

320324

0 commit comments

Comments
 (0)