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

@ -128,7 +128,7 @@ $(document).ready(function(){initNavTree('positionParticles_8cpp_source.html',''
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="box_8hpp.html">box.hpp</a>&quot;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="cylinder_8hpp.html">cylinder.hpp</a>&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="sphere_8hpp.html">sphere.hpp</a>&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="cells_8hpp.html">cells.hpp</a>&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &quot;cells.hpp&quot;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="contactSearchFunctions_8hpp.html">contactSearchFunctions.hpp</a>&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="streams_8hpp.html">streams.hpp</a>&quot;</span></div>
@ -136,7 +136,7 @@ $(document).ready(function(){initNavTree('positionParticles_8cpp_source.html',''
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classpFlow_1_1positionParticles.html#acaa0dff282b290a55e1ce664eefb0bbd"> 31</a></span>&#160;<a class="code" href="classpFlow_1_1Vector.html">pFlow::realx3Vector</a> <a class="code" href="classpFlow_1_1positionParticles.html#acaa0dff282b290a55e1ce664eefb0bbd">pFlow::positionParticles::sortByMortonCode</a>(<a class="code" href="classpFlow_1_1Vector.html">realx3Vector</a>&amp; position)<span class="keyword">const</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">struct </span>indexMorton</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keyword">struct </span><a class="code" href="structpFlow_1_1indexMorton.html">indexMorton</a></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; {</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">size_t</span> morton;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">size_t</span> index;</div>
@ -156,7 +156,7 @@ $(document).ready(function(){initNavTree('positionParticles_8cpp_source.html',''
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">auto</span> cellInd = allCells.<a class="code" href="classpFlow_1_1cells.html#a6a5c6423585a7ad6ad55f6df56c459bd">pointIndex</a>(p);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; indMor.push_back( </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; { <a class="code" href="namespacepFlow.html#a18876974c2f9ab194cff9cc8da9e4717">xyzToMortonCode64</a>(cellInd.x(), cellInd.y(), cellInd.z()),</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; { <a class="code" href="namespacepFlow.html#af9e399d88da408c52c6c167b651766e5">xyzToMortonCode64</a>(cellInd.x(), cellInd.y(), cellInd.z()),</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; ind++});</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; </div>
@ -164,7 +164,7 @@ $(document).ready(function(){initNavTree('positionParticles_8cpp_source.html',''
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="VectorFwd_8hpp.html#a7e83353786d5cf3406a036b434c7df25">std::sort</a>(</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; indMor.begin(),</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; indMor.end(),</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; []( <span class="keyword">const</span> indexMorton &amp;lhs, <span class="keyword">const</span> indexMorton &amp;rhs){</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; []( <span class="keyword">const</span> <a class="code" href="structpFlow_1_1indexMorton.html">indexMorton</a> &amp;lhs, <span class="keyword">const</span> <a class="code" href="structpFlow_1_1indexMorton.html">indexMorton</a> &amp;rhs){</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; return lhs.morton &lt; rhs.morton; } );</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <a class="code" href="classpFlow_1_1Vector.html">realx3Vector</a> sortedPos(<a class="code" href="classpFlow_1_1positionParticles.html#a843693a42017b1ec8c292940e210ca88">position</a>.<a class="code" href="classpFlow_1_1Vector.html#a234de5cb432c97fcb4b0f806bb86624e">capacity</a>(), <a class="code" href="structRESERVE.html">RESERVE</a>());</div>
@ -254,14 +254,15 @@ $(document).ready(function(){initNavTree('positionParticles_8cpp_source.html',''
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00063">builtinTypes.hpp:63</a></div></div>
<div class="ttc" id="abox_8hpp_html"><div class="ttname"><a href="box_8hpp.html">box.hpp</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a9c4454c5f18c8245eaaebf2b4832eab0"><div class="ttname"><a href="namespacepFlow.html#a9c4454c5f18c8245eaaebf2b4832eab0">pFlow::printKeys</a></div><div class="ttdeci">iOstream &amp; printKeys(iOstream &amp;os, const wordHashMap&lt; T &gt; &amp;m)</div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html_a10efdf47ffedbdc720f71c2f72b98d98"><div class="ttname"><a href="classpFlow_1_1Vector.html#a10efdf47ffedbdc720f71c2f72b98d98">pFlow::Vector::size</a></div><div class="ttdeci">auto size() const</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00299">Vector.hpp:299</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html_a10efdf47ffedbdc720f71c2f72b98d98"><div class="ttname"><a href="classpFlow_1_1Vector.html#a10efdf47ffedbdc720f71c2f72b98d98">pFlow::Vector::size</a></div><div class="ttdeci">auto size() const</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00301">Vector.hpp:301</a></div></div>
<div class="ttc" id="astructpFlow_1_1indexMorton_html"><div class="ttname"><a href="structpFlow_1_1indexMorton.html">pFlow::indexMorton</a></div><div class="ttdef"><b>Definition:</b> <a href="mortonIndexing_8hpp_source.html#l00079">mortonIndexing.hpp:79</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_ac17b017ed4e1be84fa2e9144946603e0"><div class="ttname"><a href="classpFlow_1_1dictionary.html#ac17b017ed4e1be84fa2e9144946603e0">pFlow::dictionary::containsDictionay</a></div><div class="ttdeci">bool containsDictionay(const word &amp;name) const</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00736">dictionary.cpp:736</a></div></div>
<div class="ttc" id="astructRESERVE_html"><div class="ttname"><a href="structRESERVE.html">RESERVE</a></div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00038">Vector.hpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1positionParticles_html_a886e27b5a049d60738b9a2eae8323303"><div class="ttname"><a href="classpFlow_1_1positionParticles.html#a886e27b5a049d60738b9a2eae8323303">pFlow::positionParticles::positionParticles</a></div><div class="ttdeci">positionParticles(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="positionParticles_8cpp_source.html#l00078">positionParticles.cpp:78</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html_a234de5cb432c97fcb4b0f806bb86624e"><div class="ttname"><a href="classpFlow_1_1Vector.html#a234de5cb432c97fcb4b0f806bb86624e">pFlow::Vector::capacity</a></div><div class="ttdeci">auto capacity() const</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00304">Vector.hpp:304</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html_a234de5cb432c97fcb4b0f806bb86624e"><div class="ttname"><a href="classpFlow_1_1Vector.html#a234de5cb432c97fcb4b0f806bb86624e">pFlow::Vector::capacity</a></div><div class="ttdeci">auto capacity() const</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00306">Vector.hpp:306</a></div></div>
<div class="ttc" id="aclasspFlow_1_1positionParticles_html_a843693a42017b1ec8c292940e210ca88"><div class="ttname"><a href="classpFlow_1_1positionParticles.html#a843693a42017b1ec8c292940e210ca88">pFlow::positionParticles::position</a></div><div class="ttdeci">virtual const realx3Vector &amp; position() const =0</div></div>
<div class="ttc" id="aclasspFlow_1_1positionParticles_html_a2a11f8c764338603f765f909cf36f250"><div class="ttname"><a href="classpFlow_1_1positionParticles.html#a2a11f8c764338603f765f909cf36f250">pFlow::positionParticles::maxDiameter</a></div><div class="ttdeci">virtual real maxDiameter() const =0</div></div>
<div class="ttc" id="acells_8hpp_html"><div class="ttname"><a href="cells_8hpp.html">cells.hpp</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="aerror_8hpp_html_adfe9ae1313e6913aca3f96d3eb67906e"><div class="ttname"><a href="error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e">fatalError</a></div><div class="ttdeci">#define fatalError</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00036">error.hpp:36</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dictionary_html_a630c840647a3ebefe33336cc25a8b15d"><div class="ttname"><a href="classpFlow_1_1dictionary.html#a630c840647a3ebefe33336cc25a8b15d">pFlow::dictionary::subDict</a></div><div class="ttdeci">dictionary &amp; subDict(const word &amp;keyword)</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00547">dictionary.cpp:547</a></div></div>
<div class="ttc" id="astreams_8hpp_html"><div class="ttname"><a href="streams_8hpp.html">streams.hpp</a></div></div>
@ -276,15 +277,14 @@ $(document).ready(function(){initNavTree('positionParticles_8cpp_source.html',''
<div class="ttc" id="aclasspFlow_1_1positionParticles_html_adaf43bf7eef63499afd8a277636d8114"><div class="ttname"><a href="classpFlow_1_1positionParticles.html#adaf43bf7eef63499afd8a277636d8114">pFlow::positionParticles::getFinalPosition</a></div><div class="ttdeci">virtual realx3Vector getFinalPosition()</div><div class="ttdef"><b>Definition:</b> <a href="positionParticles_8cpp_source.html#l00101">positionParticles.cpp:101</a></div></div>
<div class="ttc" id="aclasspFlow_1_1positionParticles_html_acaa0dff282b290a55e1ce664eefb0bbd"><div class="ttname"><a href="classpFlow_1_1positionParticles.html#acaa0dff282b290a55e1ce664eefb0bbd">pFlow::positionParticles::sortByMortonCode</a></div><div class="ttdeci">realx3Vector sortByMortonCode(realx3Vector &amp;position) const</div><div class="ttdef"><b>Definition:</b> <a href="positionParticles_8cpp_source.html#l00031">positionParticles.cpp:31</a></div></div>
<div class="ttc" id="acylinder_8hpp_html"><div class="ttname"><a href="cylinder_8hpp.html">cylinder.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html"><div class="ttname"><a href="classpFlow_1_1cells.html">pFlow::cells</a></div><div class="ttdef"><b>Definition:</b> <a href="cells_8hpp_source.html#l00032">cells.hpp:32</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html"><div class="ttname"><a href="classpFlow_1_1cells.html">pFlow::cells</a></div><div class="ttdef"><b>Definition:</b> <a href="Interaction_2contactSearch_2cells_8hpp_source.html#l00032">cells.hpp:32</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triple_html"><div class="ttname"><a href="classpFlow_1_1triple.html">pFlow::triple&lt; real &gt;</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_a6a5c6423585a7ad6ad55f6df56c459bd"><div class="ttname"><a href="classpFlow_1_1cells.html#a6a5c6423585a7ad6ad55f6df56c459bd">pFlow::cells::pointIndex</a></div><div class="ttdeci">INLINE_FUNCTION_HD CellType pointIndex(const realx3 &amp;p) const</div><div class="ttdef"><b>Definition:</b> <a href="cells_8hpp_source.html#l00158">cells.hpp:158</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_a6a5c6423585a7ad6ad55f6df56c459bd"><div class="ttname"><a href="classpFlow_1_1cells.html#a6a5c6423585a7ad6ad55f6df56c459bd">pFlow::cells::pointIndex</a></div><div class="ttdeci">INLINE_FUNCTION_HD CellType pointIndex(const realx3 &amp;p) const</div><div class="ttdef"><b>Definition:</b> <a href="Interaction_2contactSearch_2cells_8hpp_source.html#l00158">cells.hpp:158</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html"><div class="ttname"><a href="classpFlow_1_1Vector.html">pFlow::Vector&lt; realx3 &gt;</a></div></div>
<div class="ttc" id="astreams_8hpp_html_a18f2ecec3edb6662b3a89a41d3787584"><div class="ttname"><a href="streams_8hpp.html#a18f2ecec3edb6662b3a89a41d3787584">endINFO</a></div><div class="ttdeci">#define endINFO</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00038">streams.hpp:38</a></div></div>
<div class="ttc" id="apositionParticles_8hpp_html"><div class="ttname"><a href="positionParticles_8hpp.html">positionParticles.hpp</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aba2f2ccdd3d4a6b403a2c2d379198396"><div class="ttname"><a href="namespacepFlow.html#aba2f2ccdd3d4a6b403a2c2d379198396">pFlow::min</a></div><div class="ttdeci">T min(const Vector&lt; T, Allocator &gt; &amp;v)</div><div class="ttdef"><b>Definition:</b> <a href="VectorMath_8hpp_source.html#l00138">VectorMath.hpp:138</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="anamespacepFlow_html_a18876974c2f9ab194cff9cc8da9e4717"><div class="ttname"><a href="namespacepFlow.html#a18876974c2f9ab194cff9cc8da9e4717">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="astreams_8hpp_html_a41fa3612202db2d335c330fb061e0054"><div class="ttname"><a href="streams_8hpp.html#a41fa3612202db2d335c330fb061e0054">INFORMATION</a></div><div class="ttdeci">#define INFORMATION</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00037">streams.hpp:37</a></div></div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>