documentation for v1.0

This commit is contained in:
HRN
2025-01-10 13:02:07 +03:30
parent 53c7b23728
commit 0acd52f1b1
16893 changed files with 448346 additions and 285977 deletions

View File

@ -189,9 +189,9 @@ $(document).ready(function(){initNavTree('contactSearchFunctions_8hpp_source.htm
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="namespacepFlow.html#af89e6417fc20ba48fec7c2ea002f2983"> 82</a></span>&#160;<a class="code" href="classpFlow_1_1triple.html">triple&lt;cellIndexType&gt;</a> <a class="code" href="namespacepFlow.html#af89e6417fc20ba48fec7c2ea002f2983">boxExtent</a>( <span class="keyword">const</span> <a class="code" href="classpFlow_1_1iBox.html">iBox&lt;cellIndexType&gt;</a>&amp; <a class="code" href="classpFlow_1_1box.html">box</a>)</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;{</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1triple.html">triple&lt;cellIndexType&gt;</a>(</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a22e25e0baa24f79d1fa113c2a84f00f9">maxPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a2f365146ce767d3de7ae125abd193b33">x</a>() - <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a67424c452a87ed7ff748b65374f89e54">minPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a2f365146ce767d3de7ae125abd193b33">x</a>() + 1,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a22e25e0baa24f79d1fa113c2a84f00f9">maxPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a28d901cc27d3756a830e4de5a484b967">y</a>() - <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a67424c452a87ed7ff748b65374f89e54">minPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a28d901cc27d3756a830e4de5a484b967">y</a>() + 1,</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a22e25e0baa24f79d1fa113c2a84f00f9">maxPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a5c836d3919741edf1ba805c98dbd21b7">z</a>() - <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a67424c452a87ed7ff748b65374f89e54">minPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a5c836d3919741edf1ba805c98dbd21b7">z</a>() + 1);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a0200f1e557cc2585190d623c0a370108">maxPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a2f365146ce767d3de7ae125abd193b33">x</a>() - <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a7a3e5e5740e519e910633f5d72bb043b">minPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a2f365146ce767d3de7ae125abd193b33">x</a>() + 1,</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a0200f1e557cc2585190d623c0a370108">maxPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a28d901cc27d3756a830e4de5a484b967">y</a>() - <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a7a3e5e5740e519e910633f5d72bb043b">minPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a28d901cc27d3756a830e4de5a484b967">y</a>() + 1,</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a0200f1e557cc2585190d623c0a370108">maxPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a5c836d3919741edf1ba805c98dbd21b7">z</a>() - <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a7a3e5e5740e519e910633f5d72bb043b">minPoint</a>().<a class="code" href="classpFlow_1_1triple.html#a5c836d3919741edf1ba805c98dbd21b7">z</a>() + 1);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;}</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> indexType, <span class="keyword">typename</span> cellIndexType&gt;</div>
@ -200,46 +200,32 @@ $(document).ready(function(){initNavTree('contactSearchFunctions_8hpp_source.htm
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;{</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; <span class="keyword">auto</span> extent = <a class="code" href="namespacepFlow.html#af89e6417fc20ba48fec7c2ea002f2983">boxExtent</a>(<a class="code" href="classpFlow_1_1box.html">box</a>);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <a class="code" href="namespacepFlow.html#aede61a7f9c2792269f212fe8d5582173">indexToCell</a>(idx, extent, cell);</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; cell+= <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a67424c452a87ed7ff748b65374f89e54">minPoint</a>();</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; cell+= <a class="code" href="classpFlow_1_1box.html">box</a>.<a class="code" href="classpFlow_1_1box.html#a7a3e5e5740e519e910633f5d72bb043b">minPoint</a>();</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;}</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;}</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<a class="code" href="pFlowMacros_8hpp.html#a8e2f73fa5c113f21c9c9edb67a974f5e">INLINE_FUNCTION_HD</a></div>
<div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="namespacepFlow.html#abd79acdf069b1eb57cd79c26a7716bd3"> 105</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="namespacepFlow.html#abd79acdf069b1eb57cd79c26a7716bd3">sphereSphereCheck</a>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1triple.html">realx3</a>&amp; p1, <span class="keyword">const</span> <a class="code" href="classpFlow_1_1triple.html">realx3</a> p2, <a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> d1, <a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> d2)</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;{</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordflow">return</span> <a class="code" href="tripleFwd_8hpp.html#ae1449f1d56abab2ec4d0f00b685fc478">length</a>(p2-p1) &lt; 0.5*(d2+d1);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;}</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;}</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="preprocessor">#endif //__broadSearchFunctions_hpp__</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="preprocessor">#endif //__broadSearchFunctions_hpp__</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<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="atypes_8hpp_html"><div class="ttname"><a href="types_8hpp.html">types.hpp</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aede61a7f9c2792269f212fe8d5582173"><div class="ttname"><a href="namespacepFlow.html#aede61a7f9c2792269f212fe8d5582173">pFlow::indexToCell</a></div><div class="ttdeci">INLINE_FUNCTION_HD void indexToCell(const indexType idx, const triple&lt; cellIndexType &gt; &amp;extent, triple&lt; cellIndexType &gt; &amp;cell)</div><div class="ttdef"><b>Definition:</b> <a href="contactSearchFunctions_8hpp_source.html#l00071">contactSearchFunctions.hpp:71</a></div></div>
<div class="ttc" id="aclasspFlow_1_1box_html_a22e25e0baa24f79d1fa113c2a84f00f9"><div class="ttname"><a href="classpFlow_1_1box.html#a22e25e0baa24f79d1fa113c2a84f00f9">pFlow::box::maxPoint</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3 maxPoint() const</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00094">box.hpp:94</a></div></div>
<div class="ttc" id="aclasspFlow_1_1box_html_a0200f1e557cc2585190d623c0a370108"><div class="ttname"><a href="classpFlow_1_1box.html#a0200f1e557cc2585190d623c0a370108">pFlow::box::maxPoint</a></div><div class="ttdeci">const INLINE_FUNCTION_HD realx3 &amp; maxPoint() const</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00097">box.hpp:97</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a48c34bfcf0b43fb8bd3a0ffc596b751d"><div class="ttname"><a href="namespacepFlow.html#a48c34bfcf0b43fb8bd3a0ffc596b751d">pFlow::mortonCode64Toxyz</a></div><div class="ttdeci">INLINE_FUNCTION_HD void mortonCode64Toxyz(uint64_t morton, uint64_t &amp;x, uint64_t &amp;y, uint64_t &amp;z)</div><div class="ttdef"><b>Definition:</b> <a href="contactSearchFunctions_8hpp_source.html#l00062">contactSearchFunctions.hpp:62</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triple_html_a28d901cc27d3756a830e4de5a484b967"><div class="ttname"><a href="classpFlow_1_1triple.html#a28d901cc27d3756a830e4de5a484b967">pFlow::triple::y</a></div><div class="ttdeci">INLINE_FUNCTION_HD T &amp; y()</div><div class="ttdef"><b>Definition:</b> <a href="triple_8hpp_source.html#l00141">triple.hpp:141</a></div></div>
<div class="ttc" id="anamespacepFlow_html"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00028">demComponent.hpp:28</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triple_html_a28d901cc27d3756a830e4de5a484b967"><div class="ttname"><a href="classpFlow_1_1triple.html#a28d901cc27d3756a830e4de5a484b967">pFlow::triple::y</a></div><div class="ttdeci">INLINE_FUNCTION_HD T &amp; y()</div><div class="ttdoc">access component</div><div class="ttdef"><b>Definition:</b> <a href="triple_8hpp_source.html#l00144">triple.hpp:144</a></div></div>
<div class="ttc" id="anamespacepFlow_html"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demGeometry_8hpp_source.html#l00027">demGeometry.hpp:27</a></div></div>
<div class="ttc" id="aiBox_8hpp_html"><div class="ttname"><a href="iBox_8hpp.html">iBox.hpp</a></div></div>
<div class="ttc" id="atripleFwd_8hpp_html_ae1449f1d56abab2ec4d0f00b685fc478"><div class="ttname"><a href="tripleFwd_8hpp.html#ae1449f1d56abab2ec4d0f00b685fc478">length</a></div><div class="ttdeci">INLINE_FUNCTION_HD T length(const triple&lt; T &gt; &amp;v1)</div></div>
<div class="ttc" id="anamespacepFlow_html_af89e6417fc20ba48fec7c2ea002f2983"><div class="ttname"><a href="namespacepFlow.html#af89e6417fc20ba48fec7c2ea002f2983">pFlow::boxExtent</a></div><div class="ttdeci">INLINE_FUNCTION_HD triple&lt; cellIndexType &gt; boxExtent(const iBox&lt; cellIndexType &gt; &amp;box)</div><div class="ttdef"><b>Definition:</b> <a href="contactSearchFunctions_8hpp_source.html#l00082">contactSearchFunctions.hpp:82</a></div></div>
<div class="ttc" id="anamespacepFlow_html_af9e399d88da408c52c6c167b651766e5"><div class="ttname"><a href="namespacepFlow.html#af9e399d88da408c52c6c167b651766e5">pFlow::xyzToMortonCode64</a></div><div class="ttdeci">INLINE_FUNCTION_HD uint64_t xyzToMortonCode64(uint64_t x, uint64_t y, uint64_t z)</div><div class="ttdef"><b>Definition:</b> <a href="contactSearchFunctions_8hpp_source.html#l00042">contactSearchFunctions.hpp:42</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triple_html_a5c836d3919741edf1ba805c98dbd21b7"><div class="ttname"><a href="classpFlow_1_1triple.html#a5c836d3919741edf1ba805c98dbd21b7">pFlow::triple::z</a></div><div class="ttdeci">INLINE_FUNCTION_HD T &amp; z()</div><div class="ttdef"><b>Definition:</b> <a href="triple_8hpp_source.html#l00144">triple.hpp:144</a></div></div>
<div class="ttc" id="anamespacepFlow_html_abd79acdf069b1eb57cd79c26a7716bd3"><div class="ttname"><a href="namespacepFlow.html#abd79acdf069b1eb57cd79c26a7716bd3">pFlow::sphereSphereCheck</a></div><div class="ttdeci">INLINE_FUNCTION_HD bool sphereSphereCheck(const realx3 &amp;p1, const realx3 p2, real d1, real d2)</div><div class="ttdef"><b>Definition:</b> <a href="contactSearchFunctions_8hpp_source.html#l00105">contactSearchFunctions.hpp:105</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triple_html_a5c836d3919741edf1ba805c98dbd21b7"><div class="ttname"><a href="classpFlow_1_1triple.html#a5c836d3919741edf1ba805c98dbd21b7">pFlow::triple::z</a></div><div class="ttdeci">INLINE_FUNCTION_HD T &amp; z()</div><div class="ttdoc">access component</div><div class="ttdef"><b>Definition:</b> <a href="triple_8hpp_source.html#l00156">triple.hpp:156</a></div></div>
<div class="ttc" id="aclasspFlow_1_1box_html_a7a3e5e5740e519e910633f5d72bb043b"><div class="ttname"><a href="classpFlow_1_1box.html#a7a3e5e5740e519e910633f5d72bb043b">pFlow::box::minPoint</a></div><div class="ttdeci">const INLINE_FUNCTION_HD realx3 &amp; minPoint() const</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00091">box.hpp:91</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a51e811dd5563b1e1b759b091ef96c339"><div class="ttname"><a href="namespacepFlow.html#a51e811dd5563b1e1b759b091ef96c339">pFlow::getThirdBits</a></div><div class="ttdeci">INLINE_FUNCTION_HD uint64_t getThirdBits(uint64_t x)</div><div class="ttdef"><b>Definition:</b> <a href="contactSearchFunctions_8hpp_source.html#l00049">contactSearchFunctions.hpp:49</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="anamespacepFlow_html_a09e092ab61b90f5515d60a7eb0d7e524"><div class="ttname"><a href="namespacepFlow.html#a09e092ab61b90f5515d60a7eb0d7e524">pFlow::splitBy3</a></div><div class="ttdeci">INLINE_FUNCTION_HD uint64_t splitBy3(const uint64_t val)</div><div class="ttdef"><b>Definition:</b> <a href="contactSearchFunctions_8hpp_source.html#l00031">contactSearchFunctions.hpp:31</a></div></div>
<div class="ttc" id="aclasspFlow_1_1box_html_a67424c452a87ed7ff748b65374f89e54"><div class="ttname"><a href="classpFlow_1_1box.html#a67424c452a87ed7ff748b65374f89e54">pFlow::box::minPoint</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3 minPoint() const</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00088">box.hpp:88</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iBox_html"><div class="ttname"><a href="classpFlow_1_1iBox.html">pFlow::iBox</a></div><div class="ttdef"><b>Definition:</b> <a href="iBox_8hpp_source.html#l00033">iBox.hpp:33</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triple_html_a2f365146ce767d3de7ae125abd193b33"><div class="ttname"><a href="classpFlow_1_1triple.html#a2f365146ce767d3de7ae125abd193b33">pFlow::triple::x</a></div><div class="ttdeci">INLINE_FUNCTION_HD T &amp; x()</div><div class="ttdef"><b>Definition:</b> <a href="triple_8hpp_source.html#l00138">triple.hpp:138</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_1triple_html"><div class="ttname"><a href="classpFlow_1_1triple.html">pFlow::triple</a></div><div class="ttdef"><b>Definition:</b> <a href="triple_8hpp_source.html#l00037">triple.hpp:37</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triple_html_a2f365146ce767d3de7ae125abd193b33"><div class="ttname"><a href="classpFlow_1_1triple.html#a2f365146ce767d3de7ae125abd193b33">pFlow::triple::x</a></div><div class="ttdeci">INLINE_FUNCTION_HD T &amp; x()</div><div class="ttdoc">access component</div><div class="ttdef"><b>Definition:</b> <a href="triple_8hpp_source.html#l00132">triple.hpp:132</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#l00055">pFlowMacros.hpp:55</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triple_html"><div class="ttname"><a href="classpFlow_1_1triple.html">pFlow::triple</a></div><div class="ttdoc">A set of 3 variables that can be used for vector variables.</div><div class="ttdef"><b>Definition:</b> <a href="triple_8hpp_source.html#l00036">triple.hpp:36</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="contactSearchFunctions_8hpp.html">contactSearchFunctions.hpp</a></li>