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

@ -381,7 +381,7 @@ $(document).ready(function(){initNavTree('symArrayHD_8hpp_source.html',''); init
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;<span class="preprocessor">#endif //__symArray_hpp__</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1Vector_html_aff8e92ab47032ae811d1271161cb9b22"><div class="ttname"><a href="classpFlow_1_1Vector.html#aff8e92ab47032ae811d1271161cb9b22">pFlow::Vector::read</a></div><div class="ttdeci">bool read(iIstream &amp;is)</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00378">Vector.hpp:378</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html_aff8e92ab47032ae811d1271161cb9b22"><div class="ttname"><a href="classpFlow_1_1Vector.html#aff8e92ab47032ae811d1271161cb9b22">pFlow::Vector::read</a></div><div class="ttdeci">bool read(iIstream &amp;is)</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00381">Vector.hpp:381</a></div></div>
<div class="ttc" id="aclasspFlow_1_1symArray_html_a9a3d16dd986d23d664853a85a317b50b"><div class="ttname"><a href="classpFlow_1_1symArray.html#a9a3d16dd986d23d664853a85a317b50b">pFlow::symArray::operator()</a></div><div class="ttdeci">const INLINE_FUNCTION_HD T &amp; operator()(uint32 i, uint32 j) const</div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00171">symArrayHD.hpp:171</a></div></div>
<div class="ttc" id="aclasspFlow_1_1symArray_html_a0c5a1541ecf7ad17925583cf6abd2c65"><div class="ttname"><a href="classpFlow_1_1symArray.html#a0c5a1541ecf7ad17925583cf6abd2c65">pFlow::symArray&lt; nonLinearProperties &gt;::reference</a></div><div class="ttdeci">nonLinearProperties &amp; reference</div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00065">symArrayHD.hpp:65</a></div></div>
<div class="ttc" id="aclasspFlow_1_1symArray_html_a4d1ca55c8c62d4fbf3ea42d9919125a0"><div class="ttname"><a href="classpFlow_1_1symArray.html#a4d1ca55c8c62d4fbf3ea42d9919125a0">pFlow::symArray&lt; nonLinearProperties &gt;::iterator</a></div><div class="ttdeci">nonLinearProperties * iterator</div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00061">symArrayHD.hpp:61</a></div></div>
@ -400,8 +400,8 @@ $(document).ready(function(){initNavTree('symArrayHD_8hpp_source.html',''); init
<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="aclasspFlow_1_1symArray_html_a06acc2e45214b635a293dae6fb6466f5"><div class="ttname"><a href="classpFlow_1_1symArray.html#a06acc2e45214b635a293dae6fb6466f5">pFlow::symArray::n_</a></div><div class="ttdeci">uint32 n_</div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00087">symArrayHD.hpp:87</a></div></div>
<div class="ttc" id="aKokkosTypes_8hpp_html"><div class="ttname"><a href="KokkosTypes_8hpp.html">KokkosTypes.hpp</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#l00299">Vector.hpp:299</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_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="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_1symArray_html_aaa204e5a9810b8db8dd34cc29ee4c464"><div class="ttname"><a href="classpFlow_1_1symArray.html#aaa204e5a9810b8db8dd34cc29ee4c464">pFlow::symArray::getN</a></div><div class="ttdeci">static bool getN(uint32 nElem, uint32 &amp;n)</div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00240">symArrayHD.hpp:240</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_1symArray_html_a67dc00bb76f1692582090f13a3976d32"><div class="ttname"><a href="classpFlow_1_1symArray.html#a67dc00bb76f1692582090f13a3976d32">pFlow::symArray::operator()</a></div><div class="ttdeci">INLINE_FUNCTION_HD T &amp; operator()(uint32 i, uint32 j)</div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00164">symArrayHD.hpp:164</a></div></div>
@ -425,18 +425,18 @@ $(document).ready(function(){initNavTree('symArrayHD_8hpp_source.html',''); init
<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="anamespacepFlow_html_a148d74ad0977268be8ea8b26a147f619"><div class="ttname"><a href="namespacepFlow.html#a148d74ad0977268be8ea8b26a147f619">pFlow::operator&lt;&lt;</a></div><div class="ttdeci">INLINE_FUNCTION iOstream &amp; operator&lt;&lt;(iOstream &amp;str, const AB3History &amp;ab3)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsBashforth3_8hpp_source.html#l00057">AdamsBashforth3.hpp:57</a></div></div>
<div class="ttc" id="aclasspFlow_1_1symArray_html_a1af10ba67005a939b2a93ad2439d56f9"><div class="ttname"><a href="classpFlow_1_1symArray.html#a1af10ba67005a939b2a93ad2439d56f9">pFlow::symArray&lt; nonLinearProperties &gt;::constPointer</a></div><div class="ttdeci">const nonLinearProperties * constPointer</div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00073">symArrayHD.hpp:73</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_ac9b54653d0ec63ee05f64a185437b335"><div class="ttname"><a href="classpFlow_1_1IOstream.html#ac9b54653d0ec63ee05f64a185437b335">pFlow::IOstream::name</a></div><div class="ttdeci">virtual const word &amp; name() const</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8cpp_source.html#l00031">IOstream.cpp:31</a></div></div>
<div class="ttc" id="aclasspFlow_1_1IOstream_html_ac9b54653d0ec63ee05f64a185437b335"><div class="ttname"><a href="classpFlow_1_1IOstream.html#ac9b54653d0ec63ee05f64a185437b335">pFlow::IOstream::name</a></div><div class="ttdeci">virtual const word &amp; name() const</div><div class="ttdoc">Return the name of the stream.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8cpp_source.html#l00031">IOstream.cpp:31</a></div></div>
<div class="ttc" id="aclasspFlow_1_1symArray_html_a7a87f910baaebc396ded9a2508e37f42"><div class="ttname"><a href="classpFlow_1_1symArray.html#a7a87f910baaebc396ded9a2508e37f42">pFlow::symArray&lt; nonLinearProperties &gt;::constIterator</a></div><div class="ttdeci">const nonLinearProperties * constIterator</div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00063">symArrayHD.hpp:63</a></div></div>
<div class="ttc" id="aclasspFlow_1_1symArray_html_a906cc5a36684b4ca90994f113dbf50ca"><div class="ttname"><a href="classpFlow_1_1symArray.html#a906cc5a36684b4ca90994f113dbf50ca">pFlow::symArray::TypeInfoTemplateNV2</a></div><div class="ttdeci">TypeInfoTemplateNV2(&quot;symArray&quot;, T, memoerySpaceName())</div></div>
<div class="ttc" id="anamespacepFlow_html_ad53198ba4452d5fdc966d861583fc70f"><div class="ttname"><a href="namespacepFlow.html#ad53198ba4452d5fdc966d861583fc70f">pFlow::hostViewType1D</a></div><div class="ttdeci">Kokkos::View&lt; T *, Kokkos::HostSpace &gt; hostViewType1D</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00104">KokkosTypes.hpp:104</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html_a6a40de4ceed55b2f78cf3027739dfd91"><div class="ttname"><a href="classpFlow_1_1Vector.html#a6a40de4ceed55b2f78cf3027739dfd91">pFlow::Vector::write</a></div><div class="ttdeci">bool write(iOstream &amp;os) const</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00383">Vector.hpp:383</a></div></div>
<div class="ttc" id="anamespacepFlow_html_ad53198ba4452d5fdc966d861583fc70f"><div class="ttname"><a href="namespacepFlow.html#ad53198ba4452d5fdc966d861583fc70f">pFlow::hostViewType1D</a></div><div class="ttdeci">Kokkos::View&lt; T *, Kokkos::HostSpace &gt; hostViewType1D</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00109">KokkosTypes.hpp:109</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Vector_html_a6a40de4ceed55b2f78cf3027739dfd91"><div class="ttname"><a href="classpFlow_1_1Vector.html#a6a40de4ceed55b2f78cf3027739dfd91">pFlow::Vector::write</a></div><div class="ttdeci">bool write(iOstream &amp;os) const</div><div class="ttdef"><b>Definition:</b> <a href="Vector_8hpp_source.html#l00386">Vector.hpp:386</a></div></div>
<div class="ttc" id="aclasspFlow_1_1symArray_html_aeaba820f36a592084855e0561b23186d"><div class="ttname"><a href="classpFlow_1_1symArray.html#aeaba820f36a592084855e0561b23186d">pFlow::symArray&lt; nonLinearProperties &gt;::ViewType</a></div><div class="ttdeci">ViewType1D&lt; nonLinearProperties, void &gt; ViewType</div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00076">symArrayHD.hpp:76</a></div></div>
<div class="ttc" id="aclasspFlow_1_1symArray_html_ac8d4e3a65ebdb6ecd7086b4efe7f78b2"><div class="ttname"><a href="classpFlow_1_1symArray.html#ac8d4e3a65ebdb6ecd7086b4efe7f78b2">pFlow::symArray::numElem</a></div><div class="ttdeci">static INLINE_FUNCTION_HD uint32 numElem(uint32 n)</div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00234">symArrayHD.hpp:234</a></div></div>
<div class="ttc" id="aclasspFlow_1_1symArray_html_af1d136d30330e8adca65ffa2984df482"><div class="ttname"><a href="classpFlow_1_1symArray.html#af1d136d30330e8adca65ffa2984df482">pFlow::symArray::~symArray</a></div><div class="ttdeci">INLINE_FUNCTION_H ~symArray()=default</div></div>
<div class="ttc" id="aerror_8hpp_html_a83efa053dfcfcef04cc0e721c0314ff3"><div class="ttname"><a href="error_8hpp.html#a83efa053dfcfcef04cc0e721c0314ff3">ioErrorInFile</a></div><div class="ttdeci">#define ioErrorInFile(fileName, lineNumber)</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00049">error.hpp:49</a></div></div>
<div class="ttc" id="atypeInfo_8hpp_html"><div class="ttname"><a href="typeInfo_8hpp.html">typeInfo.hpp</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="aclasspFlow_1_1IOstream_html_a607efe5fb94edbe4cfa890c4907e76c3"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a607efe5fb94edbe4cfa890c4907e76c3">pFlow::IOstream::lineNumber</a></div><div class="ttdeci">int32 lineNumber() const</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00187">IOstream.hpp:187</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_1IOstream_html_a607efe5fb94edbe4cfa890c4907e76c3"><div class="ttname"><a href="classpFlow_1_1IOstream.html#a607efe5fb94edbe4cfa890c4907e76c3">pFlow::IOstream::lineNumber</a></div><div class="ttdeci">int32 lineNumber() const</div><div class="ttdoc">Const access to the current stream line number.</div><div class="ttdef"><b>Definition:</b> <a href="IOstream_8hpp_source.html#l00221">IOstream.hpp:221</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aedf0e44e92e0f7a18c7c724daf0f52fa"><div class="ttname"><a href="namespacepFlow.html#aedf0e44e92e0f7a18c7c724daf0f52fa">pFlow::sqrt</a></div><div class="ttdeci">INLINE_FUNCTION_HD real sqrt(real x)</div><div class="ttdef"><b>Definition:</b> <a href="math_8hpp_source.html#l00148">math.hpp:148</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_1symArray_html_a783c81fb3d585a513b521ab37644da06"><div class="ttname"><a href="classpFlow_1_1symArray.html#a783c81fb3d585a513b521ab37644da06">pFlow::symArray&lt; nonLinearProperties &gt;::valueType</a></div><div class="ttdeci">nonLinearProperties valueType</div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00069">symArrayHD.hpp:69</a></div></div>
@ -445,7 +445,7 @@ $(document).ready(function(){initNavTree('symArrayHD_8hpp_source.html',''); init
<div class="ttc" id="aclasspFlow_1_1symArray_html"><div class="ttname"><a href="classpFlow_1_1symArray.html">pFlow::symArray</a></div><div class="ttdef"><b>Definition:</b> <a href="symArrayHD_8hpp_source.html#l00056">symArrayHD.hpp:56</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aaf1dcea055a0402beff3cec1b0849d74"><div class="ttname"><a href="namespacepFlow.html#aaf1dcea055a0402beff3cec1b0849d74">pFlow::equal</a></div><div class="ttdeci">INLINE_FUNCTION_HD bool equal(const real &amp;s1, const real &amp;s2)</div><div class="ttdef"><b>Definition:</b> <a href="bTypesFunctions_8hpp_source.html#l00188">bTypesFunctions.hpp:188</a></div></div>
<div class="ttc" id="aVector_8hpp_html"><div class="ttname"><a href="Vector_8hpp.html">Vector.hpp</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aa59ae59573e65855aee2d3fe25e6504a"><div class="ttname"><a href="namespacepFlow.html#aa59ae59573e65855aee2d3fe25e6504a">pFlow::kPair</a></div><div class="ttdeci">Kokkos::pair&lt; T1, T2 &gt; kPair</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00052">KokkosTypes.hpp:52</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aa59ae59573e65855aee2d3fe25e6504a"><div class="ttname"><a href="namespacepFlow.html#aa59ae59573e65855aee2d3fe25e6504a">pFlow::kPair</a></div><div class="ttdeci">Kokkos::pair&lt; T1, T2 &gt; kPair</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00054">KokkosTypes.hpp:54</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_cd7a5046d028e114fc17b2ebc2bd02d2.html">phasicFlow</a></li><li class="navelem"><a class="el" href="dir_74a3bd5d559eb2469f344a26dc365ad0.html">containers</a></li><li class="navelem"><a class="el" href="dir_d67f442c583c169126a33cc02f90b170.html">symArrayHD</a></li><li class="navelem"><a class="el" href="symArrayHD_8hpp.html">symArrayHD.hpp</a></li>