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

@ -132,17 +132,17 @@ $(document).ready(function(){initNavTree('selectBox_8cpp_source.html',''); initR
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classpFlow_1_1selectBox.html#a1374032c453ef21c7e97c572fb962a50"> 25</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classpFlow_1_1selectBox.html#a1374032c453ef21c7e97c572fb962a50">pFlow::selectBox::selectAllPointsInBox</a>()</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="comment">// to reduct allocations</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="classpFlow_1_1selectBox.html#a31c3f4eceb5e97a34ff6c2ab35a5b306">selectedPoints_</a>.<a class="code" href="classpFlow_1_1Vector.html#a3dbf7d015e95cf17d59eafb6828e9cac">reserve</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="classpFlow_1_1selectBox.html#ac08d05e6d7541bdb2e7860e43fa058a0">selectedPoints_</a>.<a class="code" href="classpFlow_1_1Vector.html#a172a7c88be982061ecefadd95725c1a1">reserve</a></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; (</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">static_cast&lt;</span><span class="keywordtype">size_t</span><span class="keyword">&gt;</span>(0.2*<a class="code" href="classpFlow_1_1pStructSelector.html#ae355b601249331cd5c4facb48df43223">pStruct</a>().size())</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; );</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classpFlow_1_1selectBox.html#a31c3f4eceb5e97a34ff6c2ab35a5b306">selectedPoints_</a>.<a class="code" href="classpFlow_1_1Vector.html#a3e122a9f9c04a4e2dffdfabde2f1de50">clear</a>();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">auto</span> pPos = <a class="code" href="classpFlow_1_1pStructSelector.html#ae355b601249331cd5c4facb48df43223">pStruct</a>().<a class="code" href="classpFlow_1_1pointStructure.html#ab9d8d4992e2a55273f2a74397321ad81">pointPosition</a>().<a class="code" href="classpFlow_1_1VectorSingle.html#a69bfde2f5814f3152a51fea88018e4c1">hostVector</a>();</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classpFlow_1_1selectBox.html#ac08d05e6d7541bdb2e7860e43fa058a0">selectedPoints_</a>.clear();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">auto</span> pPos = <a class="code" href="classpFlow_1_1pStructSelector.html#ae355b601249331cd5c4facb48df43223">pStruct</a>().<a class="code" href="classpFlow_1_1internalPoints.html#a70608727da7af695329afce5745727d4">pointPosition</a>().<a class="code" href="classpFlow_1_1VectorSingle.html#a379256561291ab5049373408178fe6fe">hostView</a>();</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="pFlowMacros_8hpp.html#ac6c2cd1218587d4992ab1344890520d6">ForAll</a>(i , pPos)</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; {</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">if</span>( <a class="code" href="classpFlow_1_1selectBox.html#aefb81f563e3df7617831459d0ab0b5ee">box_</a>.<a class="code" href="classpFlow_1_1box.html#a898603c1e4e433d2f304d86f1a22c53c">isInside</a>( pPos[i] )) <a class="code" href="classpFlow_1_1selectBox.html#a31c3f4eceb5e97a34ff6c2ab35a5b306">selectedPoints_</a>.push_back(i);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">if</span>( <a class="code" href="classpFlow_1_1selectBox.html#aefb81f563e3df7617831459d0ab0b5ee">box_</a>.<a class="code" href="classpFlow_1_1box.html#a898603c1e4e433d2f304d86f1a22c53c">isInside</a>( pPos[i] )) <a class="code" href="classpFlow_1_1selectBox.html#ac08d05e6d7541bdb2e7860e43fa058a0">selectedPoints_</a>.push_back(i);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; }</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;}</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
@ -165,22 +165,21 @@ $(document).ready(function(){initNavTree('selectBox_8cpp_source.html',''); initR
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html_a69bfde2f5814f3152a51fea88018e4c1"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html#a69bfde2f5814f3152a51fea88018e4c1">pFlow::VectorSingle::hostVector</a></div><div class="ttdeci">const INLINE_FUNCTION_H auto hostVector() const</div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8hpp_source.html#l00338">VectorSingle.hpp:338</a></div></div>
<div class="ttc" id="aclasspFlow_1_1selectBox_html_aefb81f563e3df7617831459d0ab0b5ee"><div class="ttname"><a href="classpFlow_1_1selectBox.html#aefb81f563e3df7617831459d0ab0b5ee">pFlow::selectBox::box_</a></div><div class="ttdeci">box box_</div><div class="ttdef"><b>Definition:</b> <a href="selectBox_8hpp_source.html#l00043">selectBox.hpp:43</a></div></div>
<div class="ttc" id="aclasspFlow_1_1selectBox_html_a31c3f4eceb5e97a34ff6c2ab35a5b306"><div class="ttname"><a href="classpFlow_1_1selectBox.html#a31c3f4eceb5e97a34ff6c2ab35a5b306">pFlow::selectBox::selectedPoints_</a></div><div class="ttdeci">int32Vector selectedPoints_</div><div class="ttdef"><b>Definition:</b> <a href="selectBox_8hpp_source.html#l00041">selectBox.hpp:41</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointStructure_html_ab9d8d4992e2a55273f2a74397321ad81"><div class="ttname"><a href="classpFlow_1_1pointStructure.html#ab9d8d4992e2a55273f2a74397321ad81">pFlow::pointStructure::pointPosition</a></div><div class="ttdeci">FUNCTION_H realx3Field_D &amp; pointPosition()</div><div class="ttdef"><b>Definition:</b> <a href="pointStructure_8cpp_source.html#l00065">pointStructure.cpp:65</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointStructure_html"><div class="ttname"><a href="classpFlow_1_1pointStructure.html">pFlow::pointStructure</a></div><div class="ttdef"><b>Definition:</b> <a href="pointStructure_8hpp_source.html#l00044">pointStructure.hpp:44</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html_a172a7c88be982061ecefadd95725c1a1"><div class="ttname"><a href="classpFlow_1_1Vector.html#a172a7c88be982061ecefadd95725c1a1">pFlow::Vector::reserve</a></div><div class="ttdeci">void reserve(size_t cap)</div><div class="ttdoc">Reserve capacity for vector Preserve the content.</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00284">Vector.hpp:284</a></div></div>
<div class="ttc" id="aclasspFlow_1_1internalPoints_html_a70608727da7af695329afce5745727d4"><div class="ttname"><a href="classpFlow_1_1internalPoints.html#a70608727da7af695329afce5745727d4">pFlow::internalPoints::pointPosition</a></div><div class="ttdeci">const PointsType &amp; pointPosition() const</div><div class="ttdef"><b>Definition:</b> <a href="internalPoints_8cpp_source.html#l00209">internalPoints.cpp:209</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointStructure_html"><div class="ttname"><a href="classpFlow_1_1pointStructure.html">pFlow::pointStructure</a></div><div class="ttdef"><b>Definition:</b> <a href="pointStructure_8hpp_source.html#l00034">pointStructure.hpp:34</a></div></div>
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html_a379256561291ab5049373408178fe6fe"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html#a379256561291ab5049373408178fe6fe">pFlow::VectorSingle::hostView</a></div><div class="ttdeci">INLINE_FUNCTION_H auto hostView() const</div><div class="ttdoc">Return a view accessible on Host in range [0,size)</div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8cpp_source.html#l00281">VectorSingle.cpp:281</a></div></div>
<div class="ttc" id="aclasspFlow_1_1selectBox_html_abfb4f74b0d90fc669a764151d616b648"><div class="ttname"><a href="classpFlow_1_1selectBox.html#abfb4f74b0d90fc669a764151d616b648">pFlow::selectBox::selectBox</a></div><div class="ttdeci">selectBox(const pointStructure &amp;pStruct, const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="selectBox_8cpp_source.html#l00043">selectBox.cpp:43</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html_a3dbf7d015e95cf17d59eafb6828e9cac"><div class="ttname"><a href="classpFlow_1_1Vector.html#a3dbf7d015e95cf17d59eafb6828e9cac">pFlow::Vector::reserve</a></div><div class="ttdeci">auto reserve(label len)</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00311">Vector.hpp:311</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pStructSelector_html_ae355b601249331cd5c4facb48df43223"><div class="ttname"><a href="classpFlow_1_1pStructSelector.html#ae355b601249331cd5c4facb48df43223">pFlow::pStructSelector::pStruct</a></div><div class="ttdeci">const pointStructure &amp; pStruct() const</div><div class="ttdef"><b>Definition:</b> <a href="pStructSelector_8cpp_source.html#l00035">pStructSelector.cpp:35</a></div></div>
<div class="ttc" id="apFlowMacros_8hpp_html_ac6c2cd1218587d4992ab1344890520d6"><div class="ttname"><a href="pFlowMacros_8hpp.html#ac6c2cd1218587d4992ab1344890520d6">ForAll</a></div><div class="ttdeci">#define ForAll(i, container)</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00071">pFlowMacros.hpp:71</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="aclasspFlow_1_1pStructSelector_html_ae355b601249331cd5c4facb48df43223"><div class="ttname"><a href="classpFlow_1_1pStructSelector.html#ae355b601249331cd5c4facb48df43223">pFlow::pStructSelector::pStruct</a></div><div class="ttdeci">const pointStructure &amp; pStruct() const</div><div class="ttdef"><b>Definition:</b> <a href="pStructSelector_8cpp_source.html#l00045">pStructSelector.cpp:45</a></div></div>
<div class="ttc" id="apFlowMacros_8hpp_html_ac6c2cd1218587d4992ab1344890520d6"><div class="ttname"><a href="pFlowMacros_8hpp.html#ac6c2cd1218587d4992ab1344890520d6">ForAll</a></div><div class="ttdeci">#define ForAll(i, container)</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00075">pFlowMacros.hpp:75</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="ttdoc">ref to a subdictioanry fatalExit if not found</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8cpp_source.html#l00560">dictionary.cpp:560</a></div></div>
<div class="ttc" id="asetPointStructure_8hpp_html_a385e32971df44b131e4498181a949a91"><div class="ttname"><a href="setPointStructure_8hpp.html#a385e32971df44b131e4498181a949a91">pStruct</a></div><div class="ttdeci">auto &amp; pStruct</div><div class="ttdef"><b>Definition:</b> <a href="setPointStructure_8hpp_source.html#l00024">setPointStructure.hpp:24</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html_a3e122a9f9c04a4e2dffdfabde2f1de50"><div class="ttname"><a href="classpFlow_1_1Vector.html#a3e122a9f9c04a4e2dffdfabde2f1de50">pFlow::Vector::clear</a></div><div class="ttdeci">auto clear()</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00248">Vector.hpp:248</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pStructSelector_html"><div class="ttname"><a href="classpFlow_1_1pStructSelector.html">pFlow::pStructSelector</a></div><div class="ttdef"><b>Definition:</b> <a href="pStructSelector_8hpp_source.html#l00036">pStructSelector.hpp:36</a></div></div>
<div class="ttc" id="aclasspFlow_1_1box_html_a898603c1e4e433d2f304d86f1a22c53c"><div class="ttname"><a href="classpFlow_1_1box.html#a898603c1e4e433d2f304d86f1a22c53c">pFlow::box::isInside</a></div><div class="ttdeci">INLINE_FUNCTION_HD bool isInside(const realx3 &amp;point) const</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00082">box.hpp:82</a></div></div>
<div class="ttc" id="aclasspFlow_1_1selectBox_html_ac08d05e6d7541bdb2e7860e43fa058a0"><div class="ttname"><a href="classpFlow_1_1selectBox.html#ac08d05e6d7541bdb2e7860e43fa058a0">pFlow::selectBox::selectedPoints_</a></div><div class="ttdeci">uint32Vector selectedPoints_</div><div class="ttdef"><b>Definition:</b> <a href="selectBox_8hpp_source.html#l00041">selectBox.hpp:41</a></div></div>
<div class="ttc" id="aclasspFlow_1_1box_html_a898603c1e4e433d2f304d86f1a22c53c"><div class="ttname"><a href="classpFlow_1_1box.html#a898603c1e4e433d2f304d86f1a22c53c">pFlow::box::isInside</a></div><div class="ttdeci">INLINE_FUNCTION_HD bool isInside(const realx3 &amp;point) const</div><div class="ttdef"><b>Definition:</b> <a href="box_8hpp_source.html#l00084">box.hpp:84</a></div></div>
<div class="ttc" id="aclasspFlow_1_1selectBox_html_a1374032c453ef21c7e97c572fb962a50"><div class="ttname"><a href="classpFlow_1_1selectBox.html#a1374032c453ef21c7e97c572fb962a50">pFlow::selectBox::selectAllPointsInBox</a></div><div class="ttdeci">void selectAllPointsInBox()</div><div class="ttdef"><b>Definition:</b> <a href="selectBox_8cpp_source.html#l00025">selectBox.cpp: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_1dictionary_html"><div class="ttname"><a href="classpFlow_1_1dictionary.html">pFlow::dictionary</a></div><div class="ttdoc">Dictionary holds a set of data entries or sub-dictionaries that are enclosed in a curely braces or ar...</div><div class="ttdef"><b>Definition:</b> <a href="dictionary_8hpp_source.html#l00067">dictionary.hpp:67</a></div></div>
<div class="ttc" id="aselectBox_8hpp_html"><div class="ttname"><a href="selectBox_8hpp.html">selectBox.hpp</a></div></div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>