Docs @ 44bce70

Author: MFC Action

documentation/md_case.html

@@ -322,16 +322,14 @@ <h3><a class="anchor" id="autotoc_md8"></a>
 </table>
 <p>where $(i,j,k)$ are the grid-indices of the current cell in each coordinate direction.</p>
 <p>In the example above, the following code is generated:</p>
-<div class="fragment"><div class="line"> 90</div>
-<div class="line"><span class="keywordflow">if</span> (patch_id == 2) <span class="keywordflow">then</span></div>
+<div class="fragment"><div class="line"><span class="keywordflow">if</span> (patch_id == 2) <span class="keywordflow">then</span></div>
 <div class="line">    q_prim_vf(contxb)%sf(i, 0, 0) = 1 + 0.1*sin(20*x_cc(i)*3.141592653589793)</div>
 <div class="line"><span class="keyword">end </span>if</div>
 </div><!-- fragment --><h3><a class="anchor" id="autotoc_md9"></a>
 Hard Coded Patches</h3>
 <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>
-<div class="fragment"><div class="line">90</div>
-<div class="line">   <span class="keywordflow">case</span>(200)</div>
-<div class="line">       ! primitive variables assignment</div>
+<div class="fragment"><div class="line"><span class="comment">case(200)</span></div>
+<div class="line">    ! primitive variables assignment</div>
 </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>
 <h3><a class="anchor" id="autotoc_md10"></a>
 Parameter Descriptions</h3>

simulation/doxygen_crawl.html

@@ -463,6 +463,7 @@
 <a href="namespacem__start__up.html#a2e9ad6009d63488a8f8c7a3a548ba433"/>
 <a href="namespacem__start__up.html#a38182f7fcc92c1c687840339a20e85cd"/>
 <a href="namespacem__start__up.html#a45c8fef6680263063a1c7d2fa1748013"/>
+<a href="namespacem__start__up.html#a579af83a99b8f863515f7f4e454e59fb"/>
 <a href="namespacem__start__up.html#a76bcd559339a2dac17d36b71eb912556"/>
 <a href="namespacem__start__up.html#a855eb78d2fa11b5bfc5f570069e6f2f8"/>
 <a href="namespacem__start__up.html#a90f45019dd8a980f2ea3fe2c5b83df6c"/>

simulation/m__start__up_8fpp_8f90.html

@@ -197,6 +197,8 @@
 <tr class="separator:ae380781597535aa125ff18847b85a206"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a76bcd559339a2dac17d36b71eb912556" id="r_a76bcd559339a2dac17d36b71eb912556"><td class="memItemLeft" align="right" valign="top">procedure(<a class="el" href="interfacem__start__up_1_1s__read__abstract__data__files.html">s_read_abstract_data_files</a>), pointer, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__start__up.html#a76bcd559339a2dac17d36b71eb912556">m_start_up::s_read_data_files</a> =&gt; null()</td></tr>
 <tr class="separator:a76bcd559339a2dac17d36b71eb912556"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a579af83a99b8f863515f7f4e454e59fb" id="r_a579af83a99b8f863515f7f4e454e59fb"><td class="memItemLeft" align="right" valign="top">real(kind(0d0))&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__start__up.html#a579af83a99b8f863515f7f4e454e59fb">m_start_up::dt_init</a></td></tr>
+<tr class="separator:a579af83a99b8f863515f7f4e454e59fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 </div><!-- contents -->
 </div><!-- doc-content -->

simulation/m__start__up_8fpp_8f90.js

@@ -14,6 +14,7 @@ var m__start__up_8fpp_8f90 =
     [ "m_start_up::s_read_serial_data_files", "namespacem__start__up.html#abd3c3fd9fbb80ef2ddaf82945c1c1af9", null ],
     [ "m_start_up::s_save_data", "namespacem__start__up.html#a0865c4378f1fdf7a9053530fb25fadaa", null ],
     [ "m_start_up::s_save_performance_metrics", "namespacem__start__up.html#a9d9487d5a4bc44cf9541702999694fd7", null ],
+    [ "m_start_up::dt_init", "namespacem__start__up.html#a579af83a99b8f863515f7f4e454e59fb", null ],
     [ "m_start_up::grad_x_vf", "namespacem__start__up.html#acd3b736578c59b1bd9dfc4b81f4a7279", null ],
     [ "m_start_up::grad_y_vf", "namespacem__start__up.html#a2e9ad6009d63488a8f8c7a3a548ba433", null ],
     [ "m_start_up::grad_z_vf", "namespacem__start__up.html#ada153b7f1b2f725b026b89cd187d3206", null ],

simulation/namespacem__start__up.html

@@ -193,6 +193,8 @@
 <tr class="separator:ae380781597535aa125ff18847b85a206"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a76bcd559339a2dac17d36b71eb912556" id="r_a76bcd559339a2dac17d36b71eb912556"><td class="memItemLeft" align="right" valign="top">procedure(<a class="el" href="interfacem__start__up_1_1s__read__abstract__data__files.html">s_read_abstract_data_files</a>), pointer, public&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a76bcd559339a2dac17d36b71eb912556">s_read_data_files</a> =&gt; null()</td></tr>
 <tr class="separator:a76bcd559339a2dac17d36b71eb912556"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a579af83a99b8f863515f7f4e454e59fb" id="r_a579af83a99b8f863515f7f4e454e59fb"><td class="memItemLeft" align="right" valign="top">real(kind(0d0))&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a579af83a99b8f863515f7f4e454e59fb">dt_init</a></td></tr>
+<tr class="separator:a579af83a99b8f863515f7f4e454e59fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>The purpose of the module is primarily to read in the files that contain the inputs, the initial condition data and the grid data that are provided by the user. The module is additionally tasked with verifying the consistency of the user inputs and completing the grid variablesThe purpose of the module is primarily to read in the files that contain the inputs, the initial condition data and the grid data that are provided by the user. The module is additionally tasked with verifying the consistency of the user inputs and completing the grid variables. This module also also allocating, initializing I/O, and deallocating the relevant variables on both cpus and gpus as well as setting up the time stepping, domain decomposition and I/O procedures. </p>
@@ -649,6 +651,20 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9d9487d5a4bc44cf95417029
 </div>
 </div>
 <h2 class="groupheader">Variable Documentation</h2>
+<a id="a579af83a99b8f863515f7f4e454e59fb" name="a579af83a99b8f863515f7f4e454e59fb"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a579af83a99b8f863515f7f4e454e59fb">&#9670;&#160;</a></span>dt_init</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">real(kind(0d0)) m_start_up::dt_init</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
 <a id="acd3b736578c59b1bd9dfc4b81f4a7279" name="acd3b736578c59b1bd9dfc4b81f4a7279"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#acd3b736578c59b1bd9dfc4b81f4a7279">&#9670;&#160;</a></span>grad_x_vf</h2>
 

simulation/namespacem__start__up.js

@@ -14,6 +14,7 @@ var namespacem__start__up =
     [ "s_read_serial_data_files", "namespacem__start__up.html#abd3c3fd9fbb80ef2ddaf82945c1c1af9", null ],
     [ "s_save_data", "namespacem__start__up.html#a0865c4378f1fdf7a9053530fb25fadaa", null ],
     [ "s_save_performance_metrics", "namespacem__start__up.html#a9d9487d5a4bc44cf9541702999694fd7", null ],
+    [ "dt_init", "namespacem__start__up.html#a579af83a99b8f863515f7f4e454e59fb", null ],
     [ "grad_x_vf", "namespacem__start__up.html#acd3b736578c59b1bd9dfc4b81f4a7279", null ],
     [ "grad_y_vf", "namespacem__start__up.html#a2e9ad6009d63488a8f8c7a3a548ba433", null ],
     [ "grad_z_vf", "namespacem__start__up.html#ada153b7f1b2f725b026b89cd187d3206", null ],

simulation/namespacemembers.html

@@ -159,6 +159,7 @@ <h3><a id="index_d" name="index_d"></a>- d -</h3><ul>
 <li>dflt_int&#160;:&#160;<a class="el" href="namespacem__constants.html#a36d9e57f65f9235b1e7b4abb690345a6">m_constants</a></li>
 <li>dflt_real&#160;:&#160;<a class="el" href="namespacem__constants.html#aea00cbe9efc8c7935ded731213cbda58">m_constants</a></li>
 <li>dflt_vcfl_dt&#160;:&#160;<a class="el" href="namespacem__constants.html#a3a243a8d9d072460385568d352ab338c">m_constants</a></li>
+<li>dt_init&#160;:&#160;<a class="el" href="namespacem__start__up.html#a579af83a99b8f863515f7f4e454e59fb">m_start_up</a></li>
 </ul>
 
 

simulation/namespacemembers_vars.html

@@ -151,6 +151,7 @@ <h3><a id="index_d" name="index_d"></a>- d -</h3><ul>
 <li>dflt_int&#160;:&#160;<a class="el" href="namespacem__constants.html#a36d9e57f65f9235b1e7b4abb690345a6">m_constants</a></li>
 <li>dflt_real&#160;:&#160;<a class="el" href="namespacem__constants.html#aea00cbe9efc8c7935ded731213cbda58">m_constants</a></li>
 <li>dflt_vcfl_dt&#160;:&#160;<a class="el" href="namespacem__constants.html#a3a243a8d9d072460385568d352ab338c">m_constants</a></li>
+<li>dt_init&#160;:&#160;<a class="el" href="namespacem__start__up.html#a579af83a99b8f863515f7f4e454e59fb">m_start_up</a></li>
 </ul>
 
 

simulation/navtreedata.js

@@ -58,7 +58,7 @@ var NAVTREEINDEX =
 [
 "annotated.html",
 "m__phase__change_8fpp_8f90.html#ad652f4225e50ad62205200e60dc7425f",
-"structacoustic__parameters.html#af3f69d9e1b857d80673bbc8e9515bc5d"
+"structacoustic__parameters.html#af2c66666b1de7af176cd2b3d45107d10"
 ];
 
 var SYNCONMSG = 'click to disable panel synchronization';

simulation/navtreeindex1.js

@@ -206,20 +206,21 @@ var NAVTREEINDEX1 =
 "namespacem__start__up.html#a03f18bf4f529c5d7a47b6e8136b0a585":[1,0,11,2],
 "namespacem__start__up.html#a0865c4378f1fdf7a9053530fb25fadaa":[1,0,11,12],
 "namespacem__start__up.html#a14f564f341f1feca9308fe2579e5ced6":[1,0,11,5],
-"namespacem__start__up.html#a2e9ad6009d63488a8f8c7a3a548ba433":[1,0,11,15],
+"namespacem__start__up.html#a2e9ad6009d63488a8f8c7a3a548ba433":[1,0,11,16],
 "namespacem__start__up.html#a38182f7fcc92c1c687840339a20e85cd":[1,0,11,4],
 "namespacem__start__up.html#a45c8fef6680263063a1c7d2fa1748013":[1,0,11,10],
-"namespacem__start__up.html#a76bcd559339a2dac17d36b71eb912556":[1,0,11,18],
+"namespacem__start__up.html#a579af83a99b8f863515f7f4e454e59fb":[1,0,11,14],
+"namespacem__start__up.html#a76bcd559339a2dac17d36b71eb912556":[1,0,11,19],
 "namespacem__start__up.html#a855eb78d2fa11b5bfc5f570069e6f2f8":[1,0,11,3],
 "namespacem__start__up.html#a90f45019dd8a980f2ea3fe2c5b83df6c":[1,0,11,6],
 "namespacem__start__up.html#a9d9487d5a4bc44cf9541702999694fd7":[1,0,11,13],
 "namespacem__start__up.html#aaaeff91a52af5b8f17ed9efed8ac17bd":[1,0,11,7],
 "namespacem__start__up.html#aba056c17994ffb88cd1effa3adb95789":[1,0,11,1],
 "namespacem__start__up.html#abd3c3fd9fbb80ef2ddaf82945c1c1af9":[1,0,11,11],
-"namespacem__start__up.html#acd3b736578c59b1bd9dfc4b81f4a7279":[1,0,11,14],
+"namespacem__start__up.html#acd3b736578c59b1bd9dfc4b81f4a7279":[1,0,11,15],
 "namespacem__start__up.html#ad994100f67a9ff96149aafec24099f10":[1,0,11,9],
-"namespacem__start__up.html#ada153b7f1b2f725b026b89cd187d3206":[1,0,11,16],
-"namespacem__start__up.html#ae380781597535aa125ff18847b85a206":[1,0,11,17],
+"namespacem__start__up.html#ada153b7f1b2f725b026b89cd187d3206":[1,0,11,17],
+"namespacem__start__up.html#ae380781597535aa125ff18847b85a206":[1,0,11,18],
 "namespacem__start__up.html#afabd4008f7a3bfbac32813507edf3c44":[1,0,11,8],
 "namespacem__thermochem.html":[1,0,12],
 "namespacem__thermochem.html#a7e6cd61129da8547dda1f86db5d35d47":[1,0,12,0],
@@ -248,6 +249,5 @@ var NAVTREEINDEX1 =
 "structacoustic__parameters.html#abd8535a1cf213fc02879a77b8d00a75c":[2,0,2,12],
 "structacoustic__parameters.html#abf704c6f69d01692703a38f9e1d60746":[2,0,2,20],
 "structacoustic__parameters.html#ae4dbcd70b9c3e83dddd95eee75534f1b":[2,0,2,15],
-"structacoustic__parameters.html#aecde4c229e2b34ec696327c5bbc7c7a8":[2,0,2,14],
-"structacoustic__parameters.html#af2c66666b1de7af176cd2b3d45107d10":[2,0,2,0]
+"structacoustic__parameters.html#aecde4c229e2b34ec696327c5bbc7c7a8":[2,0,2,14]
 };