Docs @ 64d9677

Author: MFC Action

documentation/md_testing.html

@@ -143,7 +143,7 @@ <h2><a class="anchor" id="autotoc_md84"></a>
 <p>To (re)generate <em>golden files</em>, append the <code>--generate</code> option: </p><div class="fragment"><div class="line">./mfc.sh test --generate -j 8</div>
 </div><!-- fragment --><p>It is recommended that a range be specified when generating golden files for new test cases, as described in the previous section, in an effort not to regenerate the golden files of existing test cases.</p>
 <p><b>Note:</b> If you output new variables and want to update the golden files to include these without modifying the original data, use the <code>--add-new-variables</code> option instead.</p>
-<p>Adding a new test case can be done by modifying <a href="https://github.com/MFlowCode/MFC/tree/master/toolchain/mfc/test/cases.py">cases.py</a>. The function <code>generate_cases</code> is responsible for generating the list of test cases. Loops and conditionals are used to vary parameters, whose defaults can be found in the <code>BASE_CFG</code> case object within <a href="https://github.com/MFlowCode/MFC/tree/master/toolchain/mfc/test/case.py">case.py</a>. The function operates on two variables:</p>
+<p>Adding a new test case can be done by modifying <a href="https://github.com/MFlowCode/MFC/tree/master/toolchain/mfc/test/cases.py">cases.py</a>. The function <code>list_cases</code> is responsible for generating the list of test cases. Loops and conditionals are used to vary parameters, whose defaults can be found in the <code>BASE_CFG</code> case object within <a href="https://github.com/MFlowCode/MFC/tree/master/toolchain/mfc/test/case.py">case.py</a>. The function operates on two variables:</p>
 <ul>
 <li><code>stack</code>: A stack that holds the variations to the default case parameters. By pushing and popping the stack inside loops and conditionals, it is easier to nest test case descriptions, as it holds the variations that are common to all future test cases within the same indentation level (in most scenarios).</li>
 <li><code>cases</code>: A list that holds fully-formed <code>Case</code> objects, that will be returned at the end of the function.</li>
@@ -158,7 +158,7 @@ <h2><a class="anchor" id="autotoc_md84"></a>
 <li><code>params</code> is the fully resolved case dictionary, as would appear in a Python case input file.</li>
 <li><code>ppn</code> is the number of processes per node to use when running the case.</li>
 </ul>
-<p>To illustrate, consider the following excerpt from <code>generate_cases</code>:</p>
+<p>To illustrate, consider the following excerpt from <code>list_cases</code>:</p>
 <div class="fragment"><div class="line"><span class="keywordflow">for</span> weno_order <span class="keywordflow">in</span> [3, 5]:</div>
 <div class="line">  stack.push(f<span class="stringliteral">&quot;weno_order={weno_order}&quot;</span>, {<span class="stringliteral">&#39;weno_order&#39;</span>: weno_order})</div>
 <div class="line"> </div>
@@ -169,19 +169,19 @@ <h2><a class="anchor" id="autotoc_md84"></a>
 <div class="line">      })</div>
 <div class="line"> </div>
 <div class="line">      <span class="keywordflow">if</span> <span class="keywordflow">not</span> (mp_weno == <span class="stringliteral">&#39;T&#39;</span> <span class="keywordflow">and</span> weno_order != 5):</div>
-<div class="line">          cases.append(create_case(stack, <span class="stringliteral">&#39;&#39;</span>, {}))</div>
+<div class="line">          cases.append(define_case_d(stack, <span class="stringliteral">&#39;&#39;</span>, {}))</div>
 <div class="line"> </div>
 <div class="line">      stack.pop()</div>
 <div class="line"> </div>
 <div class="line">  stack.pop()</div>
-</div><!-- fragment --><p>When pushing to the stack, or creating a new case with the <code>create_case</code> function, you must specify:</p><ul>
+</div><!-- fragment --><p>When pushing to the stack, or creating a new case with the <code>define_case_d</code> function, you must specify:</p><ul>
 <li><code>stack</code>: The current stack.</li>
 <li><code>trace</code>: A human-readable string describing what you are currently varying.</li>
 <li><code>variations</code>: A Python dictionary with case parameter variations.</li>
 <li>(Optional) <code>ppn</code>: The number of processes per node to use (default is 1).</li>
 </ul>
 <p>If a trace is empty (that is, the empty string <code>""</code>), it will not appear in the final trace, but any case parameter variations associated with it will still be applied.</p>
-<p>Finally, the case is appended to the <code>cases</code> list, which will be returned by the <code>generate_cases</code> function.</p>
+<p>Finally, the case is appended to the <code>cases</code> list, which will be returned by the <code>list_cases</code> function.</p>
 <h2><a class="anchor" id="autotoc_md85"></a>
 Testing Post Process</h2>
 <p>To test updated post process code, append the <code>-a</code> or <code>--test-all</code> option: </p><div class="fragment"><div class="line">./mfc.sh test -a -j 8</div>

post_process/doxygen_crawl.html

@@ -485,8 +485,10 @@
 <a href="m__helper_8fpp_8f90.html#a88808ee0f14fe4e145a538646dc9ba73"/>
 <a href="m__helper_8fpp_8f90.html#a8a0505b2bd4f3d8cb2bf3ce16cfe01e3"/>
 <a href="m__helper_8fpp_8f90.html#a91cfb5e94039510845e0bb8cdc843ee8"/>
+<a href="m__helper_8fpp_8f90.html#aaa9cc8944c8dfe3f302e106b0eb3efee"/>
 <a href="m__helper_8fpp_8f90.html#aafb2d0e9e3e66d3f3714f0ad3349bc8f"/>
 <a href="m__helper_8fpp_8f90.html#ab89cbe125a3f1cdf3339d2d40f48e547"/>
+<a href="m__helper_8fpp_8f90.html#abd1074cc9307589b2d34db68c67afb7f"/>
 <a href="m__helper_8fpp_8f90.html#ac1893d0dc10d4afa0f4b3f5c36b8fb8b"/>
 <a href="m__helper_8fpp_8f90.html#ae401e6ec49c4c7340e19c04a0abe836a"/>
 <a href="m__helper_8fpp_8f90.html#ae6e719f709d847b8b1a1f8e8b483158f"/>

post_process/globals.html

@@ -146,6 +146,8 @@ <h3><a id="index_f" name="index_f"></a>- f -</h3><ul>
 <li>f_create_bbox()&#160;:&#160;<a class="el" href="m__helper_8fpp_8f90.html#a88808ee0f14fe4e145a538646dc9ba73">m_helper.fpp.f90</a></li>
 <li>f_create_transform_matrix()&#160;:&#160;<a class="el" href="m__helper_8fpp_8f90.html#aafb2d0e9e3e66d3f3714f0ad3349bc8f">m_helper.fpp.f90</a></li>
 <li>f_cross()&#160;:&#160;<a class="el" href="m__helper_8fpp_8f90.html#a3685fb84c52ce964157ac58fc0068249">m_helper.fpp.f90</a></li>
+<li>f_logical_to_int()&#160;:&#160;<a class="el" href="m__helper_8fpp_8f90.html#aaa9cc8944c8dfe3f302e106b0eb3efee">m_helper.fpp.f90</a></li>
+<li>f_xor()&#160;:&#160;<a class="el" href="m__helper_8fpp_8f90.html#abd1074cc9307589b2d34db68c67afb7f">m_helper.fpp.f90</a></li>
 </ul>
 
 

post_process/globals_func.html

@@ -146,6 +146,8 @@ <h3><a id="index_f" name="index_f"></a>- f -</h3><ul>
 <li>f_create_bbox()&#160;:&#160;<a class="el" href="m__helper_8fpp_8f90.html#a88808ee0f14fe4e145a538646dc9ba73">m_helper.fpp.f90</a></li>
 <li>f_create_transform_matrix()&#160;:&#160;<a class="el" href="m__helper_8fpp_8f90.html#aafb2d0e9e3e66d3f3714f0ad3349bc8f">m_helper.fpp.f90</a></li>
 <li>f_cross()&#160;:&#160;<a class="el" href="m__helper_8fpp_8f90.html#a3685fb84c52ce964157ac58fc0068249">m_helper.fpp.f90</a></li>
+<li>f_logical_to_int()&#160;:&#160;<a class="el" href="m__helper_8fpp_8f90.html#aaa9cc8944c8dfe3f302e106b0eb3efee">m_helper.fpp.f90</a></li>
+<li>f_xor()&#160;:&#160;<a class="el" href="m__helper_8fpp_8f90.html#abd1074cc9307589b2d34db68c67afb7f">m_helper.fpp.f90</a></li>
 </ul>
 
 

post_process/m__helper_8fpp_8f90.html

@@ -183,6 +183,10 @@
 <tr class="memitem:a88808ee0f14fe4e145a538646dc9ba73" id="r_a88808ee0f14fe4e145a538646dc9ba73"><td class="memItemLeft" align="right" valign="top">type(<a class="el" href="structt__bbox.html">t_bbox</a>) function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a88808ee0f14fe4e145a538646dc9ba73">f_create_bbox</a> (model)</td></tr>
 <tr class="memdesc:a88808ee0f14fe4e145a538646dc9ba73"><td class="mdescLeft">&#160;</td><td class="mdescRight">This procedure creates a bounding box for a model.  <br /></td></tr>
 <tr class="separator:a88808ee0f14fe4e145a538646dc9ba73"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:abd1074cc9307589b2d34db68c67afb7f" id="r_abd1074cc9307589b2d34db68c67afb7f"><td class="memItemLeft" align="right" valign="top">logical function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abd1074cc9307589b2d34db68c67afb7f">f_xor</a> (lhs, rhs)</td></tr>
+<tr class="separator:abd1074cc9307589b2d34db68c67afb7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aaa9cc8944c8dfe3f302e106b0eb3efee" id="r_aaa9cc8944c8dfe3f302e106b0eb3efee"><td class="memItemLeft" align="right" valign="top">integer function&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaa9cc8944c8dfe3f302e106b0eb3efee">f_logical_to_int</a> (predicate)</td></tr>
+<tr class="separator:aaa9cc8944c8dfe3f302e106b0eb3efee"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Function/Subroutine Documentation</h2>
 <a id="ac1893d0dc10d4afa0f4b3f5c36b8fb8b" name="ac1893d0dc10d4afa0f4b3f5c36b8fb8b"></a>
@@ -324,6 +328,70 @@ <h2 class="memtitle"><span class="permalink"><a href="#a3685fb84c52ce964157ac58f
 <div class="center"><iframe scrolling="no" frameborder="0" src="m__helper_8fpp_8f90_a3685fb84c52ce964157ac58fc0068249_icgraph.svg" width="294" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
 </div>
 
+</div>
+</div>
+<a id="aaa9cc8944c8dfe3f302e106b0eb3efee" name="aaa9cc8944c8dfe3f302e106b0eb3efee"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aaa9cc8944c8dfe3f302e106b0eb3efee">&#9670;&#160;</a></span>f_logical_to_int()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">integer function __m_helper_fpp_f90__::f_logical_to_int </td>
+          <td>(</td>
+          <td class="paramtype">logical, intent(in)</td>          <td class="paramname"><span class="paramname"><em>predicate</em></span></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">private</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><iframe scrolling="no" frameborder="0" src="m__helper_8fpp_8f90_aaa9cc8944c8dfe3f302e106b0eb3efee_icgraph.svg" width="347" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
+</div>
+
+</div>
+</div>
+<a id="abd1074cc9307589b2d34db68c67afb7f" name="abd1074cc9307589b2d34db68c67afb7f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#abd1074cc9307589b2d34db68c67afb7f">&#9670;&#160;</a></span>f_xor()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">logical function __m_helper_fpp_f90__::f_xor </td>
+          <td>(</td>
+          <td class="paramtype">logical, intent(in)</td>          <td class="paramname"><span class="paramname"><em>lhs</em></span>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">logical, intent(in)</td>          <td class="paramname"><span class="paramname"><em>rhs</em></span>&#160;)</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">private</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><iframe scrolling="no" frameborder="0" src="m__helper_8fpp_8f90_abd1074cc9307589b2d34db68c67afb7f_icgraph.svg" width="280" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
+</div>
+
 </div>
 </div>
 <a id="a772c75c8b24c414cfaed17e2f8acc772" name="a772c75c8b24c414cfaed17e2f8acc772"></a>

post_process/m__helper_8fpp_8f90.js

@@ -4,6 +4,8 @@ var m__helper_8fpp_8f90 =
     [ "f_create_bbox", "m__helper_8fpp_8f90.html#a88808ee0f14fe4e145a538646dc9ba73", null ],
     [ "f_create_transform_matrix", "m__helper_8fpp_8f90.html#aafb2d0e9e3e66d3f3714f0ad3349bc8f", null ],
     [ "f_cross", "m__helper_8fpp_8f90.html#a3685fb84c52ce964157ac58fc0068249", null ],
+    [ "f_logical_to_int", "m__helper_8fpp_8f90.html#aaa9cc8944c8dfe3f302e106b0eb3efee", null ],
+    [ "f_xor", "m__helper_8fpp_8f90.html#abd1074cc9307589b2d34db68c67afb7f", null ],
     [ "s_comp_n_from_cons", "m__helper_8fpp_8f90.html#a772c75c8b24c414cfaed17e2f8acc772", null ],
     [ "s_comp_n_from_prim", "m__helper_8fpp_8f90.html#a308591c92e68d2500ea353807d1b388b", null ],
     [ "s_compute_finite_difference_coefficients", "m__helper_8fpp_8f90.html#a397f792e51d5a7f74131b9c72b87e071", null ],

post_process/m__helper_8fpp_8f90_a772c75c8b24c414cfaed17e2f8acc772_icgraph.svg

@@ -0,0 +1,5 @@
+<map id="f_logical_to_int" name="f_logical_to_int">
+<area shape="rect" id="Node000001" title=" " alt="" coords="220,5,341,31"/>
+<area shape="rect" id="Node000002" href="$m__helper_8fpp_8f90.html#ac1893d0dc10d4afa0f4b3f5c36b8fb8b" title=" " alt="" coords="5,5,172,31"/>
+<area shape="poly" id="edge1_Node000001_Node000002" title=" " alt="" coords="206,21,172,21,172,15,206,15"/>
+</map>

post_process/m__helper_8fpp_8f90_a8a0505b2bd4f3d8cb2bf3ce16cfe01e3_icgraph.svg

@@ -0,0 +1 @@
+d6de4b667dd255ce6f21ed55b6d15b40