Skip to content

Commit 87b91c4

Browse files
author
MFC Action
committed
Docs @ df321c8
1 parent d437fdb commit 87b91c4

File tree

157 files changed

+10163
-13153
lines changed

Some content is hidden

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

157 files changed

+10163
-13153
lines changed

documentation/md_case.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -336,10 +336,10 @@ <h3><a class="anchor" id="autotoc_md8"></a>
336336
<div class="line"><span class="keyword">end </span>if</div>
337337
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md9"></a>
338338
Hard Coded Patches</h3>
339-
<p>Some patch configurations are not adequately handled with the above analytic variable definitions. In this case, a hard coded patch can be used. Hard coded patches can be added by adding additional hard coded patch identifiers to <code>src/pre_process/include/1[2,3]dHardcodedIC.fpp</code>. For example, to add a 2D Hardcoded patch with an id of 200, one would add the following to <code>src/pre_process/include/2dHardcodedIC.fpp</code></p>
339+
<p>Some patch configurations are not adequately handled with the above analytic variable definitions. In this case, a hard coded patch can be used. Hard coded patches can be added by adding additional hard coded patch identifiers to <code>src/pre_process/include/1[2,3]dHardcodedIC.fpp</code>. When using a hard coded patch, the <code>patch_icpp(patch_id)%hcid</code> must be set to the hard-coded patch id. For example, to add a 2D Hardcoded patch with an id of 200, one would add the following to <code>src/pre_process/include/2dHardcodedIC.fpp</code></p>
340340
<div class="fragment"><div class="line"><span class="comment">case(200)</span></div>
341341
<div class="line"> ! primitive variables assignment</div>
342-
</div><!-- fragment --><p>and use <code>patch_icpp(i)%geometry = 7</code> and <code>patch_icpp(i)%hcid = 200</code> in the input file. Additional variables can be declared in <code>Hardcoded1[2,3]DVariables</code> and used in <code>hardcoded1[2,3]D</code>. As a convention, any hard coded patches that are part of the MFC master branch should be identified as 1[2,3]xx where the first digit indicates the number of dimensions.</p>
342+
</div><!-- fragment --><p>and use <code>patch_icpp(i)%hcid = 200</code> in the input file. Additional variables can be declared in <code>Hardcoded1[2,3]DVariables</code> and used in <code>hardcoded1[2,3]D</code>. As a convention, any hard coded patches that are part of the MFC master branch should be identified as 1[2,3]xx where the first digit indicates the number of dimensions.</p>
343343
<p>The code provides three pre-built patches for dimensional extrusion of initial conditions:</p>
344344
<ul>
345345
<li><code>case(170)</code>: Load 1D profile from data files</li>
@@ -411,7 +411,7 @@ <h2><a class="anchor" id="autotoc_md12"></a>
411411
<h3><a class="anchor" id="autotoc_md13"></a>
412412
Parameter Descriptions</h3>
413413
<ul>
414-
<li><code>geometry</code> defines the type of geometry of a patch with an integer number. Definitions for currently implemented patch types are list in table Immersed Boundary Patch Type</li>
414+
<li><code>geometry</code> defines the type of geometry of an immersed boundary patch with an integer number. Definitions for currently implemented immersed boundary patch types are listed in table Immersed Boundary Patch Type.</li>
415415
<li><code>x[y,z]_centroid</code> is the centroid location of the patch in the x[y,z]-direction</li>
416416
<li><code>length_x[y,z]</code> is the length of the patch in the x[y,z]-direction.</li>
417417
<li><code>radius</code> is the radius to be used for circular patches.</li>
@@ -954,7 +954,7 @@ <h2><a class="anchor" id="autotoc_md23"></a>
954954
<tr class="markdownTableRowOdd">
955955
<td class="markdownTableBodyRight"><code>mixlayer_vel_coef</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Coefficient for the hyperbolic tangent profile of a mixing layer </td></tr>
956956
<tr class="markdownTableRowEven">
957-
<td class="markdownTableBodyRight"><code>mixlayer_perturb</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Perturb the initial velocity field by instability waves </td></tr>
957+
<td class="markdownTableBodyRight"><code>mixlayer_perturb</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Perturb the initial velocity field using a spectrum-based synthetic turbulence generation method </td></tr>
958958
</table>
959959
<p>The table lists velocity field parameters. The parameters are optionally used to define initial velocity profiles and perturbations.</p>
960960
<ul>
@@ -1163,9 +1163,9 @@ <h2><a class="anchor" id="autotoc_md33"></a>
11631163
<tr class="markdownTableRowOdd">
11641164
<td class="markdownTableBodyRight">5 </td><td class="markdownTableBodyCenter">Ellipse </td><td class="markdownTableBodyCenter">2 </td><td class="markdownTableBodyCenter">Y </td><td class="markdownTableBodyLeft">Requires <code>[x,y]_centroid</code> and <code>radii(i)</code>. </td></tr>
11651165
<tr class="markdownTableRowEven">
1166-
<td class="markdownTableBodyRight">6 </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">2 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">No longer exists. Empty. </td></tr>
1166+
<td class="markdownTableBodyRight">6 </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyLeft">No longer exists. Empty. </td></tr>
11671167
<tr class="markdownTableRowOdd">
1168-
<td class="markdownTableBodyRight">7 </td><td class="markdownTableBodyCenter">2D Hardcoded </td><td class="markdownTableBodyCenter">2 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Assigns the primitive variables as analytical functions. </td></tr>
1168+
<td class="markdownTableBodyRight">7 </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyLeft">No longer exists. Empty. </td></tr>
11691169
<tr class="markdownTableRowEven">
11701170
<td class="markdownTableBodyRight">8 </td><td class="markdownTableBodyCenter">Sphere </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">Y </td><td class="markdownTableBodyLeft">Requires <code>[x,y,z]_centroid</code> and <code>radius</code> </td></tr>
11711171
<tr class="markdownTableRowOdd">
@@ -1177,11 +1177,11 @@ <h2><a class="anchor" id="autotoc_md33"></a>
11771177
<tr class="markdownTableRowEven">
11781178
<td class="markdownTableBodyRight">12 </td><td class="markdownTableBodyCenter">Ellipsoid </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">Y </td><td class="markdownTableBodyLeft">Requires <code>[x,y,z]_centroid</code> and <code>radii(i)</code>. </td></tr>
11791179
<tr class="markdownTableRowOdd">
1180-
<td class="markdownTableBodyRight">13 </td><td class="markdownTableBodyCenter">3D Hardcoded </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Assigns the primitive variables as analytical functions </td></tr>
1180+
<td class="markdownTableBodyRight">13 </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyLeft">No longer exists. Empty. </td></tr>
11811181
<tr class="markdownTableRowEven">
11821182
<td class="markdownTableBodyRight">14 </td><td class="markdownTableBodyCenter">Spherical Harmonic </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Requires <code>[x,y,z]_centroid</code>, <code>radius</code>, <code>epsilon</code>, <code>beta</code> </td></tr>
11831183
<tr class="markdownTableRowOdd">
1184-
<td class="markdownTableBodyRight">15 </td><td class="markdownTableBodyCenter">1D Hardcoded </td><td class="markdownTableBodyCenter">1 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Assigns the primitive variables as analytical functions </td></tr>
1184+
<td class="markdownTableBodyRight">15 </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyLeft">No longer exists. Empty. </td></tr>
11851185
<tr class="markdownTableRowEven">
11861186
<td class="markdownTableBodyRight">16 </td><td class="markdownTableBodyCenter">1D bubble pulse </td><td class="markdownTableBodyCenter">1 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Requires <code>x_centroid</code>, <code>length_x</code> </td></tr>
11871187
<tr class="markdownTableRowOdd">

pre_process/doxygen_crawl.html

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,6 @@
189189
<a href="namespacem__check__ib__patches.html#a9563f0aed8f72097bb44f8f832e1ee84"/>
190190
<a href="namespacem__check__ib__patches.html#a9ff8acf607daae3aa26dd6fae770e363"/>
191191
<a href="namespacem__check__patches.html"/>
192-
<a href="namespacem__check__patches.html#a060f4b4df9448c80b864e6e1fa3ce57d"/>
193192
<a href="namespacem__check__patches.html#a0aa37004f2424cfd8bebdfb3ebca0b48"/>
194193
<a href="namespacem__check__patches.html#a0f15a698a1080a9c91badacd6764f25a"/>
195194
<a href="namespacem__check__patches.html#a1595128fdb31c7579893e18f2b9b5165"/>
@@ -203,11 +202,9 @@
203202
<a href="namespacem__check__patches.html#a6c7e6b87b2773c331eb48fd861bafa1f"/>
204203
<a href="namespacem__check__patches.html#a76a3840c18a9465a2e8a5dd3f5690c77"/>
205204
<a href="namespacem__check__patches.html#a85726210700570c3c7cf87e00959088b"/>
206-
<a href="namespacem__check__patches.html#a8ce3808d5c77d527b8ca0801e79c8082"/>
207205
<a href="namespacem__check__patches.html#a90f2db067eacd85c606624d89d96bf5f"/>
208206
<a href="namespacem__check__patches.html#ab13ea7dd7fe8ef624bb7c4da7039bec5"/>
209207
<a href="namespacem__check__patches.html#abcc37fb6bf5cba50d9df215c7425ce22"/>
210-
<a href="namespacem__check__patches.html#ad056eea96020cdf6ae1e89ce79141858"/>
211208
<a href="namespacem__check__patches.html#ad4217a88d6f45581873b5f7ea2b1811a"/>
212209
<a href="namespacem__check__patches.html#ae4967f50e5a02f57ab778658c180e1e8"/>
213210
<a href="namespacem__check__patches.html#af06107882eccefe9696d6a9bf467e380"/>
@@ -686,10 +683,8 @@
686683
<a href="namespacem__patches.html#a2a38d74f869d5ea77f0b84ce8f10dec2"/>
687684
<a href="namespacem__patches.html#a329ed801c2657c103ce8c99244752984"/>
688685
<a href="namespacem__patches.html#a3c4b58d7f76eb307053b4947c057cd93"/>
689-
<a href="namespacem__patches.html#a3e0659a95f4ee87abce3096d93b1973e"/>
690686
<a href="namespacem__patches.html#a4098e2117f4c732ca1c9b194d7b45fe4"/>
691687
<a href="namespacem__patches.html#a47d2dc2fe984e24eea09f0596c41f81b"/>
692-
<a href="namespacem__patches.html#a4944c1c8380967128308bb2fd955d0d1"/>
693688
<a href="namespacem__patches.html#a4bd3a05bd36c415ce974c0c79ff44096"/>
694689
<a href="namespacem__patches.html#a4e05dee15519b5480a25f692fa87de5d"/>
695690
<a href="namespacem__patches.html#a4eacb04ed4df53abf94cbde4c24e7791"/>
@@ -718,7 +713,6 @@
718713
<a href="namespacem__patches.html#ae46fa42357e6f97705b9249a4777d830"/>
719714
<a href="namespacem__patches.html#ae7e86e8627f6b62b7cadb1fcdd2cec41"/>
720715
<a href="namespacem__patches.html#aeb23f19023724f6a89fc37ed2070ef67"/>
721-
<a href="namespacem__patches.html#aee9097761614cebfe97cd5b95cb80bab"/>
722716
<a href="namespacem__patches.html#af84f7523c12ccd5fa87ab887982d84cf"/>
723717
<a href="namespacem__patches.html#afc4dabd407fce0a0a63d29d2a854002e"/>
724718
<a href="namespacem__patches.html#afe48d8f175edca4aa39c65dc0d8c8222"/>

pre_process/m__check__patches_8fpp_8f90.html

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -168,15 +168,6 @@
168168
<tr class="memitem:a76a3840c18a9465a2e8a5dd3f5690c77" id="r_a76a3840c18a9465a2e8a5dd3f5690c77"><td class="memItemLeft" align="right" valign="top">impure subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__check__patches.html#a76a3840c18a9465a2e8a5dd3f5690c77">m_check_patches::s_check_2d_taylorgreen_vortex_patch_geometry</a> (patch_id)</td></tr>
169169
<tr class="memdesc:a76a3840c18a9465a2e8a5dd3f5690c77"><td class="mdescLeft">&#160;</td><td class="mdescRight">This subroutine checks the model patch input. <br /></td></tr>
170170
<tr class="separator:a76a3840c18a9465a2e8a5dd3f5690c77"><td class="memSeparator" colspan="2">&#160;</td></tr>
171-
<tr class="memitem:ad056eea96020cdf6ae1e89ce79141858" id="r_ad056eea96020cdf6ae1e89ce79141858"><td class="memItemLeft" align="right" valign="top">impure subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__check__patches.html#ad056eea96020cdf6ae1e89ce79141858">m_check_patches::s_check_1d_analytical_patch_geometry</a> (patch_id)</td></tr>
172-
<tr class="memdesc:ad056eea96020cdf6ae1e89ce79141858"><td class="mdescLeft">&#160;</td><td class="mdescRight">This subroutine checks the model patch input. <br /></td></tr>
173-
<tr class="separator:ad056eea96020cdf6ae1e89ce79141858"><td class="memSeparator" colspan="2">&#160;</td></tr>
174-
<tr class="memitem:a060f4b4df9448c80b864e6e1fa3ce57d" id="r_a060f4b4df9448c80b864e6e1fa3ce57d"><td class="memItemLeft" align="right" valign="top">impure subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__check__patches.html#a060f4b4df9448c80b864e6e1fa3ce57d">m_check_patches::s_check_2d_analytical_patch_geometry</a> (patch_id)</td></tr>
175-
<tr class="memdesc:a060f4b4df9448c80b864e6e1fa3ce57d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This subroutine checks the model patch input. <br /></td></tr>
176-
<tr class="separator:a060f4b4df9448c80b864e6e1fa3ce57d"><td class="memSeparator" colspan="2">&#160;</td></tr>
177-
<tr class="memitem:a8ce3808d5c77d527b8ca0801e79c8082" id="r_a8ce3808d5c77d527b8ca0801e79c8082"><td class="memItemLeft" align="right" valign="top">impure subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__check__patches.html#a8ce3808d5c77d527b8ca0801e79c8082">m_check_patches::s_check_3d_analytical_patch_geometry</a> (patch_id)</td></tr>
178-
<tr class="memdesc:a8ce3808d5c77d527b8ca0801e79c8082"><td class="mdescLeft">&#160;</td><td class="mdescRight">This subroutine checks the model patch input. <br /></td></tr>
179-
<tr class="separator:a8ce3808d5c77d527b8ca0801e79c8082"><td class="memSeparator" colspan="2">&#160;</td></tr>
180171
<tr class="memitem:a90f2db067eacd85c606624d89d96bf5f" id="r_a90f2db067eacd85c606624d89d96bf5f"><td class="memItemLeft" align="right" valign="top">impure subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__check__patches.html#a90f2db067eacd85c606624d89d96bf5f">m_check_patches::s_check_sphere_patch_geometry</a> (patch_id)</td></tr>
181172
<tr class="memdesc:a90f2db067eacd85c606624d89d96bf5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This subroutine checks the model patch input. <br /></td></tr>
182173
<tr class="separator:a90f2db067eacd85c606624d89d96bf5f"><td class="memSeparator" colspan="2">&#160;</td></tr>

pre_process/m__check__patches_8fpp_8f90.js

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

pre_process/m__patches_8fpp_8f90.html

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -181,17 +181,8 @@
181181
<tr class="memitem:a70c13ac3ff6b04d5281c0af02a3c7e31" id="r_a70c13ac3ff6b04d5281c0af02a3c7e31"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__patches.html#a70c13ac3ff6b04d5281c0af02a3c7e31">m_patches::s_2d_taylorgreen_vortex</a> (patch_id, patch_id_fp, q_prim_vf)</td></tr>
182182
<tr class="memdesc:a70c13ac3ff6b04d5281c0af02a3c7e31"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Taylor Green vortex is 2D decaying vortex that may be used, for example, to verify the effects of viscous attenuation. Geometry of the patch is well-defined when its centroid are provided. <br /></td></tr>
183183
<tr class="separator:a70c13ac3ff6b04d5281c0af02a3c7e31"><td class="memSeparator" colspan="2">&#160;</td></tr>
184-
<tr class="memitem:a4944c1c8380967128308bb2fd955d0d1" id="r_a4944c1c8380967128308bb2fd955d0d1"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__patches.html#a4944c1c8380967128308bb2fd955d0d1">m_patches::s_1d_analytical</a> (patch_id, patch_id_fp, q_prim_vf)</td></tr>
185-
<tr class="memdesc:a4944c1c8380967128308bb2fd955d0d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This patch assigns the primitive variables as analytical functions such that the code can be verified. <br /></td></tr>
186-
<tr class="separator:a4944c1c8380967128308bb2fd955d0d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
187184
<tr class="memitem:aa872db74e8cb219dfb5f60fbc3386cf0" id="r_aa872db74e8cb219dfb5f60fbc3386cf0"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__patches.html#aa872db74e8cb219dfb5f60fbc3386cf0">m_patches::s_1d_bubble_pulse</a> (patch_id, patch_id_fp, q_prim_vf)</td></tr>
188185
<tr class="separator:aa872db74e8cb219dfb5f60fbc3386cf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
189-
<tr class="memitem:a3e0659a95f4ee87abce3096d93b1973e" id="r_a3e0659a95f4ee87abce3096d93b1973e"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__patches.html#a3e0659a95f4ee87abce3096d93b1973e">m_patches::s_2d_analytical</a> (patch_id, patch_id_fp, q_prim_vf)</td></tr>
190-
<tr class="memdesc:a3e0659a95f4ee87abce3096d93b1973e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This patch assigns the primitive variables as analytical functions such that the code can be verified. <br /></td></tr>
191-
<tr class="separator:a3e0659a95f4ee87abce3096d93b1973e"><td class="memSeparator" colspan="2">&#160;</td></tr>
192-
<tr class="memitem:aee9097761614cebfe97cd5b95cb80bab" id="r_aee9097761614cebfe97cd5b95cb80bab"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__patches.html#aee9097761614cebfe97cd5b95cb80bab">m_patches::s_3d_analytical</a> (patch_id, patch_id_fp, q_prim_vf)</td></tr>
193-
<tr class="memdesc:aee9097761614cebfe97cd5b95cb80bab"><td class="mdescLeft">&#160;</td><td class="mdescRight">This patch assigns the primitive variables as analytical functions such that the code can be verified. <br /></td></tr>
194-
<tr class="separator:aee9097761614cebfe97cd5b95cb80bab"><td class="memSeparator" colspan="2">&#160;</td></tr>
195186
<tr class="memitem:ae7e86e8627f6b62b7cadb1fcdd2cec41" id="r_ae7e86e8627f6b62b7cadb1fcdd2cec41"><td class="memItemLeft" align="right" valign="top">subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__patches.html#ae7e86e8627f6b62b7cadb1fcdd2cec41">m_patches::s_spherical_harmonic</a> (patch_id, patch_id_fp, q_prim_vf)</td></tr>
196187
<tr class="memdesc:ae7e86e8627f6b62b7cadb1fcdd2cec41"><td class="mdescLeft">&#160;</td><td class="mdescRight">This patch generates the shape of the spherical harmonics as a perturbation to a perfect sphere. <br /></td></tr>
197188
<tr class="separator:ae7e86e8627f6b62b7cadb1fcdd2cec41"><td class="memSeparator" colspan="2">&#160;</td></tr>

0 commit comments

Comments
 (0)