doc for Geometry

This commit is contained in:
Hamidreza Norouzi
2023-04-13 11:46:41 -07:00
parent 895e48d89f
commit 123023579a
3624 changed files with 83821 additions and 29967 deletions

View File

@ -270,7 +270,7 @@ $(document).ready(function(){initNavTree('NBS_8hpp_source.html',''); initResizab
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; <span class="comment">// updateFrequency_ value</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="comment">// on all the points in the range of [0,numPoints_)</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> PairsContainer&gt;</div>
<div class="line"><a name="l00168"></a><span class="lineno"><a class="line" href="classpFlow_1_1NBS.html#adb99f8dfb353cba7aca9b1bb8566163d"> 168</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1NBS.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="l00168"></a><span class="lineno"><a class="line" href="classpFlow_1_1NBS.html#adb99f8dfb353cba7aca9b1bb8566163d"> 168</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1NBS.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="l00169"></a><span class="lineno"> 169</span>&#160; {</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; </div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; <span class="keywordflow">if</span>(force) <a class="code" href="classpFlow_1_1NBS.html#af11548cfec6dd4efe0c8702395cf8ae0">currentIter_</a> = 0;</div>
@ -292,7 +292,7 @@ $(document).ready(function(){initNavTree('NBS_8hpp_source.html',''); initResizab
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; <span class="comment">// with force = true, perform broad search regardless of </span></div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; <span class="comment">// updateFrequency_ value</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</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="l00190"></a><span class="lineno"><a class="line" href="classpFlow_1_1NBS.html#a3c55135a756e6fa68f1ada33d1d18e07"> 190</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1NBS.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="l00190"></a><span class="lineno"><a class="line" href="classpFlow_1_1NBS.html#a3c55135a756e6fa68f1ada33d1d18e07"> 190</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1NBS.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="l00191"></a><span class="lineno"> 191</span>&#160; {</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; <span class="keywordflow">if</span>(force) <a class="code" href="classpFlow_1_1NBS.html#af11548cfec6dd4efe0c8702395cf8ae0">currentIter_</a> = 0;</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <a class="code" href="classpFlow_1_1NBS.html#a0fe252c95c374cf51d37d954d6ecc2ed">performedSearch_</a> = <span class="keyword">false</span>;</div>
@ -317,6 +317,7 @@ $(document).ready(function(){initNavTree('NBS_8hpp_source.html',''); initResizab
<div class="ttc" id="aclasspFlow_1_1NBS_html_a3de51aa24b94e991c9c21fb5f3d5c487"><div class="ttname"><a href="classpFlow_1_1NBS.html#a3de51aa24b94e991c9c21fb5f3d5c487">pFlow::NBS::sizeRatio_</a></div><div class="ttdeci">real sizeRatio_</div><div class="ttdef"><b>Definition:</b> <a href="NBS_8hpp_source.html#l00055">NBS.hpp:55</a></div></div>
<div class="ttc" id="aclasspFlow_1_1NBS_html_a74280fc4f4e399c204b2186f7648f6a3"><div class="ttname"><a href="classpFlow_1_1NBS.html#a74280fc4f4e399c204b2186f7648f6a3">pFlow::NBS::objectSizeChanged</a></div><div class="ttdeci">bool objectSizeChanged(int32 newSize)</div><div class="ttdef"><b>Definition:</b> <a href="NBS_8hpp_source.html#l00157">NBS.hpp:157</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_1NBSLevel0_html"><div class="ttname"><a href="classpFlow_1_1NBSLevel0.html">pFlow::NBSLevel0</a></div><div class="ttdef"><b>Definition:</b> <a href="NBSLevel0_8hpp_source.html#l00032">NBSLevel0.hpp:32</a></div></div>
<div class="ttc" id="aclasspFlow_1_1NBS_html_a25871096c037c1682ce0c5d5df2aea94"><div class="ttname"><a href="classpFlow_1_1NBS.html#a25871096c037c1682ce0c5d5df2aea94">pFlow::NBS::getCellsLevels</a></div><div class="ttdeci">Vector&lt; Cells &gt; getCellsLevels() const</div><div class="ttdef"><b>Definition:</b> <a href="NBS_8hpp_source.html#l00147">NBS.hpp:147</a></div></div>
<div class="ttc" id="aclasspFlow_1_1NBS_html_a96a6009263fd79c400b344b2f9854c22"><div class="ttname"><a href="classpFlow_1_1NBS.html#a96a6009263fd79c400b344b2f9854c22">pFlow::NBS::getCells</a></div><div class="ttdeci">auto getCells() const</div><div class="ttdef"><b>Definition:</b> <a href="NBS_8hpp_source.html#l00152">NBS.hpp:152</a></div></div>
@ -348,7 +349,7 @@ $(document).ready(function(){initNavTree('NBS_8hpp_source.html',''); initResizab
<div class="ttc" id="anamespacepFlow_html_ae14bf16748b3144baa1112f08c2a83b1"><div class="ttname"><a href="namespacepFlow.html#ae14bf16748b3144baa1112f08c2a83b1">pFlow::max</a></div><div class="ttdeci">T max(const Vector&lt; T, Allocator &gt; &amp;v)</div><div class="ttdef"><b>Definition:</b> <a href="VectorMath_8hpp_source.html#l00164">VectorMath.hpp:164</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_1NBSLevel0_html_a9c7defb1033880a484a305e994da3f69"><div class="ttname"><a href="classpFlow_1_1NBSLevel0.html#a9c7defb1033880a484a305e994da3f69">pFlow::NBSLevel0::IndexType</a></div><div class="ttdeci">typename MapperType::IndexType IndexType</div><div class="ttdef"><b>Definition:</b> <a href="NBSLevel0_8hpp_source.html#l00044">NBSLevel0.hpp:44</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_1NBSLevel0_html_a80897313e23ac68fdcaf6492a5602417"><div class="ttname"><a href="classpFlow_1_1NBSLevel0.html#a80897313e23ac68fdcaf6492a5602417">pFlow::NBSLevel0::findPairs</a></div><div class="ttdeci">INLINE_FUNCTION_H bool findPairs(PairsContainer &amp;pairs)</div><div class="ttdef"><b>Definition:</b> <a href="NBSLevel0_8hpp_source.html#l00180">NBSLevel0.hpp:180</a></div></div>
<div class="ttc" id="aclasspFlow_1_1NBS_html_a3c55135a756e6fa68f1ada33d1d18e07"><div class="ttname"><a href="classpFlow_1_1NBS.html#a3c55135a756e6fa68f1ada33d1d18e07">pFlow::NBS::broadSearch</a></div><div class="ttdeci">bool broadSearch(PairsContainer &amp;pairs, range activeRange, IncludeFunction incld, bool force=false)</div><div class="ttdef"><b>Definition:</b> <a href="NBS_8hpp_source.html#l00190">NBS.hpp:190</a></div></div>
<div class="ttc" id="aclasspFlow_1_1NBSLevel0_html_a066684b40e43a1064cbc16dd1f75f9f7"><div class="ttname"><a href="classpFlow_1_1NBSLevel0.html#a066684b40e43a1064cbc16dd1f75f9f7">pFlow::NBSLevel0::Cells</a></div><div class="ttdeci">typename MapperType::Cells Cells</div><div class="ttdef"><b>Definition:</b> <a href="NBSLevel0_8hpp_source.html#l00046">NBSLevel0.hpp:46</a></div></div>
@ -359,12 +360,11 @@ $(document).ready(function(){initNavTree('NBS_8hpp_source.html',''); initResizab
<div class="ttc" id="aclasspFlow_1_1NBS_html_af11548cfec6dd4efe0c8702395cf8ae0"><div class="ttname"><a href="classpFlow_1_1NBS.html#af11548cfec6dd4efe0c8702395cf8ae0">pFlow::NBS::currentIter_</a></div><div class="ttdeci">int32 currentIter_</div><div class="ttdef"><b>Definition:</b> <a href="NBS_8hpp_source.html#l00059">NBS.hpp:59</a></div></div>
<div class="ttc" id="aclasspFlow_1_1NBS_html_a82ff029cde274e03e3d96f746e64eb56"><div class="ttname"><a href="classpFlow_1_1NBS.html#a82ff029cde274e03e3d96f746e64eb56">pFlow::NBS::IdType</a></div><div class="ttdeci">typename NBSLevel0Type::IdType IdType</div><div class="ttdef"><b>Definition:</b> <a href="NBS_8hpp_source.html#l00040">NBS.hpp:40</a></div></div>
<div class="ttc" id="aclasspFlow_1_1NBSLevel0_html_ac4d3b8acf353b5c25e08589ccb899182"><div class="ttname"><a href="classpFlow_1_1NBSLevel0.html#ac4d3b8acf353b5c25e08589ccb899182">pFlow::NBSLevel0::IdType</a></div><div class="ttdeci">typename MapperType::IdType IdType</div><div class="ttdef"><b>Definition:</b> <a href="NBSLevel0_8hpp_source.html#l00042">NBSLevel0.hpp:42</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_1mapperNBS_html_a5ca5fc49c272458f76da73906c9e534b"><div class="ttname"><a href="classpFlow_1_1mapperNBS.html#a5ca5fc49c272458f76da73906c9e534b">pFlow::mapperNBS::getCellIterator</a></div><div class="ttdeci">cellIterator getCellIterator() const</div><div class="ttdef"><b>Definition:</b> <a href="mapperNBS_8hpp_source.html#l00219">mapperNBS.hpp:219</a></div></div>
<div class="ttc" id="aclasspFlow_1_1NBS_html_a3ba99f348f9f6048be57dec5ad768170"><div class="ttname"><a href="classpFlow_1_1NBS.html#a3ba99f348f9f6048be57dec5ad768170">pFlow::NBS::cellIterator</a></div><div class="ttdeci">typename NBSLevel0Type::cellIterator cellIterator</div><div class="ttdef"><b>Definition:</b> <a href="NBS_8hpp_source.html#l00038">NBS.hpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1NBS_html_a2f3fca6830cd43510c731216bcf9dd75"><div class="ttname"><a href="classpFlow_1_1NBS.html#a2f3fca6830cd43510c731216bcf9dd75">pFlow::NBS::performedSearch</a></div><div class="ttdeci">bool performedSearch() const</div><div class="ttdef"><b>Definition:</b> <a href="NBS_8hpp_source.html#l00127">NBS.hpp:127</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_1cells_html_aab4957227ae46b934b9f779363e6c83c"><div class="ttname"><a href="classpFlow_1_1cells.html#aab4957227ae46b934b9f779363e6c83c">pFlow::cells::getCells</a></div><div class="ttdeci">cells getCells() const</div><div class="ttdef"><b>Definition:</b> <a href="cells_8hpp_source.html#l00095">cells.hpp:95</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_aab4957227ae46b934b9f779363e6c83c"><div class="ttname"><a href="classpFlow_1_1cells.html#aab4957227ae46b934b9f779363e6c83c">pFlow::cells::getCells</a></div><div class="ttdeci">cells getCells() const</div><div class="ttdef"><b>Definition:</b> <a href="Interaction_2contactSearch_2cells_8hpp_source.html#l00095">cells.hpp:95</a></div></div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_521648a0ab4242664e9ecc37593f7519.html">Interaction</a></li><li class="navelem"><a class="el" href="dir_f27c6bb1e70979f7ed7175f297e69b7e.html">contactSearch</a></li><li class="navelem"><a class="el" href="dir_e1c20bf23ef9d936d80b34376c4ac838.html">methods</a></li><li class="navelem"><a class="el" href="NBS_8hpp.html">NBS.hpp</a></li>