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

@ -400,17 +400,17 @@ $(document).ready(function(){initNavTree('triSurface_8hpp_source.html',''); init
<div class="ttc" id="aclasspFlow_1_1triSurface_1_1triangleAccessor_html_aa734460d08913831fe8487427279ff70"><div class="ttname"><a href="classpFlow_1_1triSurface_1_1triangleAccessor.html#aa734460d08913831fe8487427279ff70">pFlow::triSurface::triangleAccessor::dPoints_</a></div><div class="ttdeci">deviceViewType1D&lt; realx3 &gt; dPoints_</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00053">triSurface.hpp:53</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="aclasspFlow_1_1triSurface_1_1triangleAccessor_html_ad9677b15888dc68e739b84d0cf69769e"><div class="ttname"><a href="classpFlow_1_1triSurface_1_1triangleAccessor.html#ad9677b15888dc68e739b84d0cf69769e">pFlow::triSurface::triangleAccessor::operator[]</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3x3 operator[](int32 i) const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00099">triSurface.hpp:99</a></div></div>
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html_afd32d1c4cda15e685fd3008f4ded29f2"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html#afd32d1c4cda15e685fd3008f4ded29f2">pFlow::VectorSingle::clear</a></div><div class="ttdeci">INLINE_FUNCTION_H void clear()</div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8hpp_source.html#l00418">VectorSingle.hpp:418</a></div></div>
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html_afd32d1c4cda15e685fd3008f4ded29f2"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html#afd32d1c4cda15e685fd3008f4ded29f2">pFlow::VectorSingle::clear</a></div><div class="ttdeci">INLINE_FUNCTION_H void clear()</div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8hpp_source.html#l00420">VectorSingle.hpp:420</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_html_af01ae6e5e5f1b190954e7487152e9b79"><div class="ttname"><a href="classpFlow_1_1triSurface.html#af01ae6e5e5f1b190954e7487152e9b79">pFlow::triSurface::calcMaxIndex</a></div><div class="ttdeci">int32 calcMaxIndex() const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8cpp_source.html#l00081">triSurface.cpp:81</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_html_a3618cbc4ad85f3c408854688f26a3bec"><div class="ttname"><a href="classpFlow_1_1triSurface.html#a3618cbc4ad85f3c408854688f26a3bec">pFlow::triSurface::area</a></div><div class="ttdeci">const realVector_D &amp; area() const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00194">triSurface.hpp:194</a></div></div>
<div class="ttc" id="aVectors_8hpp_html"><div class="ttname"><a href="Vectors_8hpp.html">Vectors.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_1_1triangleAccessor_html_ada38a65882979f09dcaa876abbcb27b4"><div class="ttname"><a href="classpFlow_1_1triSurface_1_1triangleAccessor.html#ada38a65882979f09dcaa876abbcb27b4">pFlow::triSurface::triangleAccessor::numTriangles_</a></div><div class="ttdeci">int32 numTriangles_</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00051">triSurface.hpp:51</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_1_1triangleAccessor_html_a5d7a84d0e438d151c01b0112f85a4c25"><div class="ttname"><a href="classpFlow_1_1triSurface_1_1triangleAccessor.html#a5d7a84d0e438d151c01b0112f85a4c25">pFlow::triSurface::triangleAccessor::triangle</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3x3 triangle(int32 i) const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00087">triSurface.hpp:87</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Field_html"><div class="ttname"><a href="classpFlow_1_1Field.html">pFlow::Field&lt; VectorSingle, realx3 &gt;</a></div></div>
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html_a5bbce2ec98238f8f408ba4a4dfb96da4"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html#a5bbce2ec98238f8f408ba4a4dfb96da4">pFlow::VectorSingle::capacity</a></div><div class="ttdeci">INLINE_FUNCTION_H size_t capacity() const</div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8hpp_source.html#l00367">VectorSingle.hpp:367</a></div></div>
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html_a5bbce2ec98238f8f408ba4a4dfb96da4"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html#a5bbce2ec98238f8f408ba4a4dfb96da4">pFlow::VectorSingle::capacity</a></div><div class="ttdeci">INLINE_FUNCTION_H size_t capacity() const</div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8hpp_source.html#l00369">VectorSingle.hpp:369</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_html_acb8e080702927e798327564bc64ead68"><div class="ttname"><a href="classpFlow_1_1triSurface.html#acb8e080702927e798327564bc64ead68">pFlow::triSurface::points_</a></div><div class="ttdeci">realx3Field_D points_</div><div class="ttdoc">points of triangles</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00111">triSurface.hpp:111</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aa5276597d4016d6696f1f265a13d2164"><div class="ttname"><a href="namespacepFlow.html#aa5276597d4016d6696f1f265a13d2164">pFlow::deviceViewType1D</a></div><div class="ttdeci">Kokkos::View&lt; T * &gt; deviceViewType1D</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00093">KokkosTypes.hpp:93</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_html_ae4e3a0ce5f1ac644fc112ed7d5311a3c"><div class="ttname"><a href="classpFlow_1_1triSurface.html#ae4e3a0ce5f1ac644fc112ed7d5311a3c">pFlow::triSurface::writeTriSurface</a></div><div class="ttdeci">bool writeTriSurface(iOstream &amp;os) const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8cpp_source.html#l00219">triSurface.cpp:219</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aa5276597d4016d6696f1f265a13d2164"><div class="ttname"><a href="namespacepFlow.html#aa5276597d4016d6696f1f265a13d2164">pFlow::deviceViewType1D</a></div><div class="ttdeci">Kokkos::View&lt; T * &gt; deviceViewType1D</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00098">KokkosTypes.hpp:98</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_html_ae4e3a0ce5f1ac644fc112ed7d5311a3c"><div class="ttname"><a href="classpFlow_1_1triSurface.html#ae4e3a0ce5f1ac644fc112ed7d5311a3c">pFlow::triSurface::writeTriSurface</a></div><div class="ttdeci">bool writeTriSurface(iOstream &amp;os) const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8cpp_source.html#l00221">triSurface.cpp:221</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_html_af991c975c219d08ae35568d2692063d5"><div class="ttname"><a href="classpFlow_1_1triSurface.html#af991c975c219d08ae35568d2692063d5">pFlow::triSurface::points</a></div><div class="ttdeci">const realx3Vector_D &amp; points() const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00184">triSurface.hpp:184</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="aVectorSingles_8hpp_html"><div class="ttname"><a href="VectorSingles_8hpp.html">VectorSingles.hpp</a></div></div>
@ -430,10 +430,10 @@ $(document).ready(function(){initNavTree('triSurface_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_1triSurface_html_a08c12fb233edbde039e917768f478ed2"><div class="ttname"><a href="classpFlow_1_1triSurface.html#a08c12fb233edbde039e917768f478ed2">pFlow::triSurface::numPoints</a></div><div class="ttdeci">size_t numPoints() const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00149">triSurface.hpp:149</a></div></div>
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html">pFlow::VectorSingle</a></div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8hpp_source.html#l00045">VectorSingle.hpp:45</a></div></div>
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html">pFlow::VectorSingle</a></div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8hpp_source.html#l00047">VectorSingle.hpp:47</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a1f679e3de3ea62dfad0ac20f7c992277"><div class="ttname"><a href="namespacepFlow.html#a1f679e3de3ea62dfad0ac20f7c992277">pFlow::realx3x3</a></div><div class="ttdeci">triple&lt; realx3 &gt; realx3x3</div><div class="ttdef"><b>Definition:</b> <a href="types_8hpp_source.html#l00054">types.hpp:54</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_html_adcec02003260f82a214e0f9d595da206"><div class="ttname"><a href="classpFlow_1_1triSurface.html#adcec02003260f82a214e0f9d595da206">pFlow::triSurface::pointsData_D</a></div><div class="ttdeci">const realx3 * pointsData_D() const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00204">triSurface.hpp:204</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_1triSurface_1_1triangleAccessor_html_a3e9613ca286df0e58d9c39d6afbc5adc"><div class="ttname"><a href="classpFlow_1_1triSurface_1_1triangleAccessor.html#a3e9613ca286df0e58d9c39d6afbc5adc">pFlow::triSurface::triangleAccessor::numPoints</a></div><div class="ttdeci">INLINE_FUNCTION_HD int32 numPoints() const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00102">triSurface.hpp:102</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_html_ae1f608287041cc0b8420a8e195bd434b"><div class="ttname"><a href="classpFlow_1_1triSurface.html#ae1f608287041cc0b8420a8e195bd434b">pFlow::triSurface::~triSurface</a></div><div class="ttdeci">virtual ~triSurface()=default</div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_html_a7223528283cd4e5872e0cc716bf9bd9d"><div class="ttname"><a href="classpFlow_1_1triSurface.html#a7223528283cd4e5872e0cc716bf9bd9d">pFlow::triSurface::capacity</a></div><div class="ttdeci">size_t capacity() const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00164">triSurface.hpp:164</a></div></div>
@ -445,11 +445,11 @@ $(document).ready(function(){initNavTree('triSurface_8hpp_source.html',''); init
<div class="ttc" id="aeventSubscriber_8hpp_html"><div class="ttname"><a href="eventSubscriber_8hpp.html">eventSubscriber.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_html_a6a40de4ceed55b2f78cf3027739dfd91"><div class="ttname"><a href="classpFlow_1_1triSurface.html#a6a40de4ceed55b2f78cf3027739dfd91">pFlow::triSurface::write</a></div><div class="ttdeci">bool write(iOstream &amp;os) const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00254">triSurface.hpp:254</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_1_1triangleAccessor_html_a9029220d5fc7180a9cadf126967868a7"><div class="ttname"><a href="classpFlow_1_1triSurface_1_1triangleAccessor.html#a9029220d5fc7180a9cadf126967868a7">pFlow::triSurface::triangleAccessor::operator()</a></div><div class="ttdeci">INLINE_FUNCTION_HD realx3x3 operator()(int32 i) const</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00096">triSurface.hpp:96</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="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="aclasspFlow_1_1triSurface_html_a39d684f10dc57c49b15fba0a594e5515"><div class="ttname"><a href="classpFlow_1_1triSurface.html#a39d684f10dc57c49b15fba0a594e5515">pFlow::triSurface::area_</a></div><div class="ttdeci">realField_D area_</div><div class="ttdoc">area of each triangle</div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00117">triSurface.hpp:117</a></div></div>
<div class="ttc" id="aclasspFlow_1_1triSurface_html"><div class="ttname"><a href="classpFlow_1_1triSurface.html">pFlow::triSurface</a></div><div class="ttdef"><b>Definition:</b> <a href="triSurface_8hpp_source.html#l00038">triSurface.hpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html_a334c2560412a3bc4fc1c215a77a48337"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html#a334c2560412a3bc4fc1c215a77a48337">pFlow::VectorSingle::size</a></div><div class="ttdeci">INLINE_FUNCTION_H size_t size() const</div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8hpp_source.html#l00360">VectorSingle.hpp:360</a></div></div>
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html_a18052bc1ad8ea07ea5b6205321cba10e"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html#a18052bc1ad8ea07ea5b6205321cba10e">pFlow::VectorSingle::deviceVectorAll</a></div><div class="ttdeci">INLINE_FUNCTION_H viewType &amp; deviceVectorAll()</div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8hpp_source.html#l00295">VectorSingle.hpp:295</a></div></div>
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html_a334c2560412a3bc4fc1c215a77a48337"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html#a334c2560412a3bc4fc1c215a77a48337">pFlow::VectorSingle::size</a></div><div class="ttdeci">INLINE_FUNCTION_H size_t size() const</div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8hpp_source.html#l00362">VectorSingle.hpp:362</a></div></div>
<div class="ttc" id="aclasspFlow_1_1VectorSingle_html_a18052bc1ad8ea07ea5b6205321cba10e"><div class="ttname"><a href="classpFlow_1_1VectorSingle.html#a18052bc1ad8ea07ea5b6205321cba10e">pFlow::VectorSingle::deviceVectorAll</a></div><div class="ttdeci">INLINE_FUNCTION_H viewType &amp; deviceVectorAll()</div><div class="ttdef"><b>Definition:</b> <a href="VectorSingle_8hpp_source.html#l00297">VectorSingle.hpp:297</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_1Vector_html"><div class="ttname"><a href="classpFlow_1_1Vector.html">pFlow::Vector&lt; realx3 &gt;</a></div></div>