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

@ -127,7 +127,7 @@ $(document).ready(function(){initNavTree('rectangleMesh_8hpp_source.html',''); i
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#ifndef __rectangleMesh_hpp__</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#define __rectangleMesh_hpp__</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</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="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &quot;cells.hpp&quot;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacepFlow.html">pFlow</a></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;{</div>
@ -268,36 +268,35 @@ $(document).ready(function(){initNavTree('rectangleMesh_8hpp_source.html',''); i
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="preprocessor">#endif // __rectangleMesh_hpp__</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1cells_html_a5e549f8b31612df62519b37e65954fc8"><div class="ttname"><a href="classpFlow_1_1cells.html#a5e549f8b31612df62519b37e65954fc8">pFlow::cells&lt; int32 &gt;::nz</a></div><div class="ttdeci">INLINE_FUNCTION_HD int32 nz() const</div><div class="ttdef"><b>Definition:</b> <a href="cells_8hpp_source.html#l00139">cells.hpp:139</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_a5e549f8b31612df62519b37e65954fc8"><div class="ttname"><a href="classpFlow_1_1cells.html#a5e549f8b31612df62519b37e65954fc8">pFlow::cells&lt; int32 &gt;::nz</a></div><div class="ttdeci">INLINE_FUNCTION_HD int32 nz() const</div><div class="ttdef"><b>Definition:</b> <a href="Interaction_2contactSearch_2cells_8hpp_source.html#l00139">cells.hpp:139</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="aclasspFlow_1_1rectangleMesh_html_a0fe74c638bf0643238dbd8b6061811fa"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#a0fe74c638bf0643238dbd8b6061811fa">pFlow::rectangleMesh::rectangleMesh</a></div><div class="ttdeci">INLINE_FUNCTION_H rectangleMesh(const dictionary &amp;dict)</div><div class="ttdef"><b>Definition:</b> <a href="rectangleMesh_8hpp_source.html#l00058">rectangleMesh.hpp:58</a></div></div>
<div class="ttc" id="aclasspFlow_1_1rectangleMesh_html_ad12f09f1fe501f833073287c5a1208cf"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#ad12f09f1fe501f833073287c5a1208cf">pFlow::rectangleMesh::operator=</a></div><div class="ttdeci">INLINE_FUNCTION_HD rectangleMesh &amp; operator=(const rectangleMesh &amp;)=default</div></div>
<div class="ttc" id="aclasspFlow_1_1rectangleMesh_html_af2378132894a4925db728a29dd6cfd65"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#af2378132894a4925db728a29dd6cfd65">pFlow::rectangleMesh::rectangleMesh</a></div><div class="ttdeci">INLINE_FUNCTION_HD rectangleMesh()</div><div class="ttdef"><b>Definition:</b> <a href="rectangleMesh_8hpp_source.html#l00042">rectangleMesh.hpp:42</a></div></div>
<div class="ttc" id="aclasspFlow_1_1rectangleMesh_html_a61b34edb9a411ddf347a902fa6f5c9a2"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#a61b34edb9a411ddf347a902fa6f5c9a2">pFlow::rectangleMesh::writeToVtk</a></div><div class="ttdeci">bool writeToVtk(iOstream &amp;os) const</div><div class="ttdef"><b>Definition:</b> <a href="rectangleMesh_8hpp_source.html#l00121">rectangleMesh.hpp:121</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a94809bdb48183ff3ef62935d56f5c1e0"><div class="ttname"><a href="namespacepFlow.html#a94809bdb48183ff3ef62935d56f5c1e0">pFlow::int64</a></div><div class="ttdeci">long long int int64</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00055">builtinTypes.hpp:55</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_a103c0d44baf9aa23e9f2fc151678905f"><div class="ttname"><a href="classpFlow_1_1cells.html#a103c0d44baf9aa23e9f2fc151678905f">pFlow::cells&lt; int32 &gt;::nx</a></div><div class="ttdeci">INLINE_FUNCTION_HD int32 nx() const</div><div class="ttdef"><b>Definition:</b> <a href="cells_8hpp_source.html#l00127">cells.hpp:127</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream &amp; endl(iOstream &amp;os)</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00312">iOstream.hpp:312</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_a103c0d44baf9aa23e9f2fc151678905f"><div class="ttname"><a href="classpFlow_1_1cells.html#a103c0d44baf9aa23e9f2fc151678905f">pFlow::cells&lt; int32 &gt;::nx</a></div><div class="ttdeci">INLINE_FUNCTION_HD int32 nx() const</div><div class="ttdef"><b>Definition:</b> <a href="Interaction_2contactSearch_2cells_8hpp_source.html#l00127">cells.hpp:127</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream &amp; endl(iOstream &amp;os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00320">iOstream.hpp:320</a></div></div>
<div class="ttc" id="aclasspFlow_1_1rectangleMesh_html_a2f4d0c6add48d99f499aa6d0d69eee76"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#a2f4d0c6add48d99f499aa6d0d69eee76">pFlow::rectangleMesh::minPoint</a></div><div class="ttdeci">INLINE_FUNCTION_H auto minPoint() const</div><div class="ttdef"><b>Definition:</b> <a href="rectangleMesh_8hpp_source.html#l00100">rectangleMesh.hpp:100</a></div></div>
<div class="ttc" id="aclasspFlow_1_1rectangleMesh_html"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html">pFlow::rectangleMesh</a></div><div class="ttdef"><b>Definition:</b> <a href="rectangleMesh_8hpp_source.html#l00031">rectangleMesh.hpp:31</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_1rectangleMesh_html_ae8f828ad15d4718d4ac69d092e1eeb46"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#ae8f828ad15d4718d4ac69d092e1eeb46">pFlow::rectangleMesh::~rectangleMesh</a></div><div class="ttdeci">INLINE_FUNCTION_HD ~rectangleMesh()=default</div></div>
<div class="ttc" id="aclasspFlow_1_1iIstream_html"><div class="ttname"><a href="classpFlow_1_1iIstream.html">pFlow::iIstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iIstream_8hpp_source.html#l00033">iIstream.hpp:33</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aae6ad039f09c0676db11bd114136a3fa"><div class="ttname"><a href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">pFlow::int32</a></div><div class="ttdeci">int int32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00053">builtinTypes.hpp:53</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_a3f60000177e9be96d15a5cb63bdd4c17"><div class="ttname"><a href="classpFlow_1_1cells.html#a3f60000177e9be96d15a5cb63bdd4c17">pFlow::cells&lt; int32 &gt;::domain</a></div><div class="ttdeci">const auto &amp; domain() const</div><div class="ttdef"><b>Definition:</b> <a href="cells_8hpp_source.html#l00152">cells.hpp:152</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_a3f60000177e9be96d15a5cb63bdd4c17"><div class="ttname"><a href="classpFlow_1_1cells.html#a3f60000177e9be96d15a5cb63bdd4c17">pFlow::cells&lt; int32 &gt;::domain</a></div><div class="ttdeci">const auto &amp; domain() const</div><div class="ttdef"><b>Definition:</b> <a href="Interaction_2contactSearch_2cells_8hpp_source.html#l00152">cells.hpp:152</a></div></div>
<div class="ttc" id="aclasspFlow_1_1rectangleMesh_html_a6a40de4ceed55b2f78cf3027739dfd91"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#a6a40de4ceed55b2f78cf3027739dfd91">pFlow::rectangleMesh::write</a></div><div class="ttdeci">bool write(iOstream &amp;os) const</div><div class="ttdef"><b>Definition:</b> <a href="rectangleMesh_8hpp_source.html#l00116">rectangleMesh.hpp:116</a></div></div>
<div class="ttc" id="apFlowMacros_8hpp_html_a542d326bc30e30d52e9deb402759b872"><div class="ttname"><a href="pFlowMacros_8hpp.html#a542d326bc30e30d52e9deb402759b872">INLINE_FUNCTION_H</a></div><div class="ttdeci">#define INLINE_FUNCTION_H</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00053">pFlowMacros.hpp:53</a></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="aclasspFlow_1_1rectangleMesh_html_aff8e92ab47032ae811d1271161cb9b22"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#aff8e92ab47032ae811d1271161cb9b22">pFlow::rectangleMesh::read</a></div><div class="ttdeci">bool read(iIstream &amp;is)</div><div class="ttdef"><b>Definition:</b> <a href="rectangleMesh_8hpp_source.html#l00111">rectangleMesh.hpp:111</a></div></div>
<div class="ttc" id="aclasspFlow_1_1rectangleMesh_html_a9c4607334754054ca306b31fb749a6c0"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#a9c4607334754054ca306b31fb749a6c0">pFlow::rectangleMesh::cellVol</a></div><div class="ttdeci">INLINE_FUNCTION_HD real cellVol() const</div><div class="ttdef"><b>Definition:</b> <a href="rectangleMesh_8hpp_source.html#l00093">rectangleMesh.hpp:93</a></div></div>
<div class="ttc" id="aclasspFlow_1_1rectangleMesh_html_ae385521c7dc99c52ccd8bcd42a01b83b"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#ae385521c7dc99c52ccd8bcd42a01b83b">pFlow::rectangleMesh::rectangleMesh</a></div><div class="ttdeci">INLINE_FUNCTION_HD rectangleMesh(const realx3 &amp;minP, const realx3 &amp;maxP, int32 nx, int32 ny, int32 nz)</div><div class="ttdef"><b>Definition:</b> <a href="rectangleMesh_8hpp_source.html#l00045">rectangleMesh.hpp:45</a></div></div>
<div class="ttc" id="aclasspFlow_1_1rectangleMesh_html_a2bf2932530024402644f21e7316d3b83"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#a2bf2932530024402644f21e7316d3b83">pFlow::rectangleMesh::TypeInfoNV</a></div><div class="ttdeci">TypeInfoNV(&quot;rectangleMesh&quot;)</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_1cells_html_aa70433dff70a92ca9c74616c1e3b48e6"><div class="ttname"><a href="classpFlow_1_1cells.html#aa70433dff70a92ca9c74616c1e3b48e6">pFlow::cells&lt; int32 &gt;::ny</a></div><div class="ttdeci">INLINE_FUNCTION_HD int32 ny() const</div><div class="ttdef"><b>Definition:</b> <a href="cells_8hpp_source.html#l00133">cells.hpp:133</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_a6507d41c8151540f5972661c7a3f8d30"><div class="ttname"><a href="classpFlow_1_1cells.html#a6507d41c8151540f5972661c7a3f8d30">pFlow::cells&lt; int32 &gt;::cellSize</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3 cellSize() const</div><div class="ttdef"><b>Definition:</b> <a href="cells_8hpp_source.html#l00115">cells.hpp:115</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_aa70433dff70a92ca9c74616c1e3b48e6"><div class="ttname"><a href="classpFlow_1_1cells.html#aa70433dff70a92ca9c74616c1e3b48e6">pFlow::cells&lt; int32 &gt;::ny</a></div><div class="ttdeci">INLINE_FUNCTION_HD int32 ny() const</div><div class="ttdef"><b>Definition:</b> <a href="Interaction_2contactSearch_2cells_8hpp_source.html#l00133">cells.hpp:133</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_a6507d41c8151540f5972661c7a3f8d30"><div class="ttname"><a href="classpFlow_1_1cells.html#a6507d41c8151540f5972661c7a3f8d30">pFlow::cells&lt; int32 &gt;::cellSize</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3 cellSize() const</div><div class="ttdef"><b>Definition:</b> <a href="Interaction_2contactSearch_2cells_8hpp_source.html#l00115">cells.hpp:115</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="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&lt; real &gt;</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_a30407b0f1d3278ff34800ef45997cb84"><div class="ttname"><a href="classpFlow_1_1cells.html#a30407b0f1d3278ff34800ef45997cb84">pFlow::cells&lt; int32 &gt;::totalCells</a></div><div class="ttdeci">INLINE_FUNCTION_HD int64 totalCells() const</div><div class="ttdef"><b>Definition:</b> <a href="cells_8hpp_source.html#l00145">cells.hpp:145</a></div></div>
<div class="ttc" id="aclasspFlow_1_1cells_html_a30407b0f1d3278ff34800ef45997cb84"><div class="ttname"><a href="classpFlow_1_1cells.html#a30407b0f1d3278ff34800ef45997cb84">pFlow::cells&lt; int32 &gt;::totalCells</a></div><div class="ttdeci">INLINE_FUNCTION_HD int64 totalCells() const</div><div class="ttdef"><b>Definition:</b> <a href="Interaction_2contactSearch_2cells_8hpp_source.html#l00145">cells.hpp:145</a></div></div>
<div class="ttc" id="aclasspFlow_1_1rectangleMesh_html_abf3bc0d1aa6f6cedfde5da544f6613a0"><div class="ttname"><a href="classpFlow_1_1rectangleMesh.html#abf3bc0d1aa6f6cedfde5da544f6613a0">pFlow::rectangleMesh::size</a></div><div class="ttdeci">INLINE_FUNCTION_HD int64 size() const</div><div class="ttdef"><b>Definition:</b> <a href="rectangleMesh_8hpp_source.html#l00087">rectangleMesh.hpp:87</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html"><div class="ttname"><a href="classpFlow_1_1iOstream.html">pFlow::iOstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00053">iOstream.hpp:53</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>