doc for Geometry

2025-06-22 16:28:30 +00:00 · 2023-04-13 11:46:41 -07:00
parent 895e48d89f
commit 123023579a
3624 changed files with 83821 additions and 29967 deletions
--- a/doc/code-documentation/html/multiGridNBS_8hpp_source.html
+++ b/doc/code-documentation/html/multiGridNBS_8hpp_source.html
@ -273,7 +273,7 @@ $(document).ready(function(){initNavTree('multiGridNBS_8hpp_source.html',''); in
 <div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;    <span class="comment">//   updateFrequency_ value</span></div>
 <div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;    <span class="comment">//   on all the points in the range of [0,numPoints_)</span></div>
 <div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    <span class="keyword">template</span>&lt;<span class="keyword">typename</span> PairsContainer&gt;</div>
-<div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="classpFlow_1_1multiGridNBS.html#adb99f8dfb353cba7aca9b1bb8566163d">  171</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1multiGridNBS.html#adb99f8dfb353cba7aca9b1bb8566163d">broadSearch</a>(PairsContainer&amp; pairs, <a class="code" href="namespacepFlow.html#ad8085fcd475be6bdf841bcdd9b9225ee">range</a> activeRange, <span class="keywordtype">bool</span> force=<span class="keyword">false</span>)</div>
+<div class="line"><a name="l00171"></a><span class="lineno"><a class="line" href="classpFlow_1_1multiGridNBS.html#adb99f8dfb353cba7aca9b1bb8566163d">  171</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1multiGridNBS.html#adb99f8dfb353cba7aca9b1bb8566163d">broadSearch</a>(PairsContainer&amp; pairs, <a class="code" href="namespacepFlow.html#a304d8581876270871949bf5d4755036a">range</a> activeRange, <span class="keywordtype">bool</span> force=<span class="keyword">false</span>)</div>
 <div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;    {</div>
 <div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;        </div>
 <div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;        <span class="keywordflow">if</span>(force) <a class="code" href="classpFlow_1_1multiGridNBS.html#af11548cfec6dd4efe0c8702395cf8ae0">currentIter_</a> = 0;</div>
@ -296,7 +296,7 @@ $(document).ready(function(){initNavTree('multiGridNBS_8hpp_source.html',''); in
 <div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;    <span class="comment">//   with force = true, perform broad search regardless of </span></div>
 <div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;    <span class="comment">//   updateFrequency_ value</span></div>
 <div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;    <span class="keyword">template</span>&lt;<span class="keyword">typename</span> PairsContainer, <span class="keyword">typename</span> IncludeFunction&gt;</div>
-<div class="line"><a name="l00194"></a><span class="lineno"><a class="line" href="classpFlow_1_1multiGridNBS.html#a3c55135a756e6fa68f1ada33d1d18e07">  194</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1multiGridNBS.html#a3c55135a756e6fa68f1ada33d1d18e07">broadSearch</a>(PairsContainer&amp; pairs, <a class="code" href="namespacepFlow.html#ad8085fcd475be6bdf841bcdd9b9225ee">range</a> activeRange, IncludeFunction incld, <span class="keywordtype">bool</span> force = <span class="keyword">false</span>)</div>
+<div class="line"><a name="l00194"></a><span class="lineno"><a class="line" href="classpFlow_1_1multiGridNBS.html#a3c55135a756e6fa68f1ada33d1d18e07">  194</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1multiGridNBS.html#a3c55135a756e6fa68f1ada33d1d18e07">broadSearch</a>(PairsContainer&amp; pairs, <a class="code" href="namespacepFlow.html#a304d8581876270871949bf5d4755036a">range</a> activeRange, IncludeFunction incld, <span class="keywordtype">bool</span> force = <span class="keyword">false</span>)</div>
 <div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;    {</div>
 <div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;        <span class="keywordflow">if</span>(force) <a class="code" href="classpFlow_1_1multiGridNBS.html#af11548cfec6dd4efe0c8702395cf8ae0">currentIter_</a> = 0;</div>
 <div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;        <a class="code" href="classpFlow_1_1multiGridNBS.html#a0fe252c95c374cf51d37d954d6ecc2ed">performedSearch_</a> = <span class="keyword">false</span>;</div>
@ -322,6 +322,7 @@ $(document).ready(function(){initNavTree('multiGridNBS_8hpp_source.html',''); in
 <div class="ttc" id="aclasspFlow_1_1NBSLevels_html_a11ef9918f37570ab8cb4d6bbda69c923"><div class="ttname"><a href="classpFlow_1_1NBSLevels.html#a11ef9918f37570ab8cb4d6bbda69c923">pFlow::NBSLevels::IndexType</a></div><div class="ttdeci">typename NBSLevelType::IndexType IndexType</div><div class="ttdef"><b>Definition:</b> <a href="NBSLevels_8hpp_source.html#l00023">NBSLevels.hpp:23</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1multiGridNBS_html_a6803d13d2906eb3dc0023e207aefb02d"><div class="ttname"><a href="classpFlow_1_1multiGridNBS.html#a6803d13d2906eb3dc0023e207aefb02d">pFlow::multiGridNBS::Cells</a></div><div class="ttdeci">typename NBSLevelsType::Cells Cells</div><div class="ttdef"><b>Definition:</b> <a href="multiGridNBS_8hpp_source.html#l00044">multiGridNBS.hpp:44</a></div></div>
 <div class="ttc" id="anamespacepFlow_html_a6192191c0e9c178a44ee1ac350fde476"><div class="ttname"><a href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">pFlow::real</a></div><div class="ttdeci">float real</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00046">builtinTypes.hpp:46</a></div></div>
+<div class="ttc" id="anamespacepFlow_html_a304d8581876270871949bf5d4755036a"><div class="ttname"><a href="namespacepFlow.html#a304d8581876270871949bf5d4755036a">pFlow::range</a></div><div class="ttdeci">kRange&lt; int &gt; range</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00059">KokkosTypes.hpp:59</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1NBSLevels_html"><div class="ttname"><a href="classpFlow_1_1NBSLevels.html">pFlow::NBSLevels</a></div><div class="ttdef"><b>Definition:</b> <a href="NBSLevels_8hpp_source.html#l00012">NBSLevels.hpp:12</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1multiGridNBS_html_a74280fc4f4e399c204b2186f7648f6a3"><div class="ttname"><a href="classpFlow_1_1multiGridNBS.html#a74280fc4f4e399c204b2186f7648f6a3">pFlow::multiGridNBS::objectSizeChanged</a></div><div class="ttdeci">bool objectSizeChanged(int32 newSize)</div><div class="ttdef"><b>Definition:</b> <a href="multiGridNBS_8hpp_source.html#l00160">multiGridNBS.hpp:160</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1multiGridNBS_html_ae716f16907f5adb0ca9378ccec647069"><div class="ttname"><a href="classpFlow_1_1multiGridNBS.html#ae716f16907f5adb0ca9378ccec647069">pFlow::multiGridNBS::TypeInfoNV</a></div><div class="ttdeci">TypeInfoNV(&quot;multiGridNBS&quot;)</div></div>
@ -355,7 +356,7 @@ $(document).ready(function(){initNavTree('multiGridNBS_8hpp_source.html',''); in
 <div class="ttc" id="aclasspFlow_1_1multiGridNBS_html_ae079a671a335303acecacf402741cd6b"><div class="ttname"><a href="classpFlow_1_1multiGridNBS.html#ae079a671a335303acecacf402741cd6b">pFlow::multiGridNBS::numLevels</a></div><div class="ttdeci">int32 numLevels() const</div><div class="ttdef"><b>Definition:</b> <a href="multiGridNBS_8hpp_source.html#l00133">multiGridNBS.hpp:133</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1box_html"><div class="ttname"><a href="classpFlow_1_1box.html">pFlow::box</a></div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00032">box.hpp:32</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1multiGridNBS_html_ae8aa0db7f2d2c19eefe46e3108bdebea"><div class="ttname"><a href="classpFlow_1_1multiGridNBS.html#ae8aa0db7f2d2c19eefe46e3108bdebea">pFlow::multiGridNBS::updateFrequency_</a></div><div class="ttdeci">int32 updateFrequency_</div><div class="ttdef"><b>Definition:</b> <a href="multiGridNBS_8hpp_source.html#l00057">multiGridNBS.hpp:57</a></div></div>
-<div class="ttc" id="anamespacepFlow_html_aca2b381231776d26ea7431837f78aa24"><div class="ttname"><a href="namespacepFlow.html#aca2b381231776d26ea7431837f78aa24">pFlow::ViewType1D</a></div><div class="ttdeci">Kokkos::View&lt; T *, properties... &gt; ViewType1D</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00062">KokkosTypes.hpp:62</a></div></div>
+<div class="ttc" id="anamespacepFlow_html_aca2b381231776d26ea7431837f78aa24"><div class="ttname"><a href="namespacepFlow.html#aca2b381231776d26ea7431837f78aa24">pFlow::ViewType1D</a></div><div class="ttdeci">Kokkos::View&lt; T *, properties... &gt; ViewType1D</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00067">KokkosTypes.hpp:67</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1multiGridNBS_html_ae51f701cba117ab6ebad15bbc2ba1045"><div class="ttname"><a href="classpFlow_1_1multiGridNBS.html#ae51f701cba117ab6ebad15bbc2ba1045">pFlow::multiGridNBS::getCells</a></div><div class="ttdeci">auto getCells(int32 lvl) const</div><div class="ttdef"><b>Definition:</b> <a href="multiGridNBS_8hpp_source.html#l00150">multiGridNBS.hpp:150</a></div></div>
 <div class="ttc" id="apFlowMacros_8hpp_html_a8e2f73fa5c113f21c9c9edb67a974f5e"><div class="ttname"><a href="pFlowMacros_8hpp.html#a8e2f73fa5c113f21c9c9edb67a974f5e">INLINE_FUNCTION_HD</a></div><div class="ttdeci">#define INLINE_FUNCTION_HD</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00051">pFlowMacros.hpp:51</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1multiGridNBS_html_aa62690641dcf92c348660e3d09436538"><div class="ttname"><a href="classpFlow_1_1multiGridNBS.html#aa62690641dcf92c348660e3d09436538">pFlow::multiGridNBS::operator=</a></div><div class="ttdeci">INLINE_FUNCTION_HD multiGridNBS &amp; operator=(const multiGridNBS &amp;)=default</div></div>
@ -364,7 +365,6 @@ $(document).ready(function(){initNavTree('multiGridNBS_8hpp_source.html',''); in
 <div class="ttc" id="aclasspFlow_1_1NBSLevels_html_a598b647fbfc371a6e1c6594fa6a1b2d0"><div class="ttname"><a href="classpFlow_1_1NBSLevels.html#a598b647fbfc371a6e1c6594fa6a1b2d0">pFlow::NBSLevels::IdType</a></div><div class="ttdeci">typename NBSLevelType::IdType IdType</div><div class="ttdef"><b>Definition:</b> <a href="NBSLevels_8hpp_source.html#l00021">NBSLevels.hpp:21</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1NBSLevels_html_a931a91813c0b988864f20e9a6686caea"><div class="ttname"><a href="classpFlow_1_1NBSLevels.html#a931a91813c0b988864f20e9a6686caea">pFlow::NBSLevels::getCells</a></div><div class="ttdeci">Cells getCells(int32 lvl) const</div><div class="ttdef"><b>Definition:</b> <a href="NBSLevels_8hpp_source.html#l00210">NBSLevels.hpp:210</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1multiGridNBS_html_a2f3fca6830cd43510c731216bcf9dd75"><div class="ttname"><a href="classpFlow_1_1multiGridNBS.html#a2f3fca6830cd43510c731216bcf9dd75">pFlow::multiGridNBS::performedSearch</a></div><div class="ttdeci">bool performedSearch() const</div><div class="ttdef"><b>Definition:</b> <a href="multiGridNBS_8hpp_source.html#l00128">multiGridNBS.hpp:128</a></div></div>
-<div class="ttc" id="anamespacepFlow_html_ad8085fcd475be6bdf841bcdd9b9225ee"><div class="ttname"><a href="namespacepFlow.html#ad8085fcd475be6bdf841bcdd9b9225ee">pFlow::range</a></div><div class="ttdeci">kPair&lt; int, int &gt; range</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00054">KokkosTypes.hpp:54</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1NBSLevels_html_ac149a77acd396c0ce9f211b4968331eb"><div class="ttname"><a href="classpFlow_1_1NBSLevels.html#ac149a77acd396c0ce9f211b4968331eb">pFlow::NBSLevels::Cells</a></div><div class="ttdeci">typename NBSLevelType::Cells Cells</div><div class="ttdef"><b>Definition:</b> <a href="NBSLevels_8hpp_source.html#l00025">NBSLevels.hpp:25</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00038">dictionary.hpp:38</a></div></div>
 <div class="ttc" id="aclasspFlow_1_1multiGridNBS_html_a48871efcbcaed0e589764bbbd933d3ec"><div class="ttname"><a href="classpFlow_1_1multiGridNBS.html#a48871efcbcaed0e589764bbbd933d3ec">pFlow::multiGridNBS::enterBoadSearch</a></div><div class="ttdeci">bool enterBoadSearch() const</div><div class="ttdef"><b>Definition:</b> <a href="multiGridNBS_8hpp_source.html#l00123">multiGridNBS.hpp:123</a></div></div>