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

@ -238,7 +238,7 @@ $(document).ready(function(){initNavTree('pointField_8hpp_source.html',''); init
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1pointField.html#a5c62d7bde0e3c333317fabe4b8806bef">pStruct_</a>.<a class="code" href="classpFlow_1_1pointStructure.html#a8c8fdb437cc5162b6a36acb35cad4c61">pointFlag</a>();</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; }</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160; </div>
<div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="classpFlow_1_1pointField.html#afef304b4d4497e45857f6edef9b049e6"> 138</a></span>&#160; <a class="code" href="namespacepFlow.html#ad8085fcd475be6bdf841bcdd9b9225ee">range</a> <a class="code" href="classpFlow_1_1pointField.html#afef304b4d4497e45857f6edef9b049e6">activeRange</a>()<span class="keyword">const</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="classpFlow_1_1pointField.html#afef304b4d4497e45857f6edef9b049e6"> 138</a></span>&#160; <a class="code" href="namespacepFlow.html#a304d8581876270871949bf5d4755036a">range</a> <a class="code" href="classpFlow_1_1pointField.html#afef304b4d4497e45857f6edef9b049e6">activeRange</a>()<span class="keyword">const</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1pointField.html#a5c62d7bde0e3c333317fabe4b8806bef">pStruct_</a>.<a class="code" href="classpFlow_1_1pointStructure.html#a7d8fce812101d1c38607cac47a618b8f">activeRange</a>();</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; }</div>
@ -302,12 +302,13 @@ $(document).ready(function(){initNavTree('pointField_8hpp_source.html',''); init
<div class="ttc" id="aclasspFlow_1_1Field_html_a8cce8c465d5f59897e0e94fa3d29f816"><div class="ttname"><a href="classpFlow_1_1Field.html#a8cce8c465d5f59897e0e94fa3d29f816">pFlow::Field&lt; T, T, void &gt;::constReference</a></div><div class="ttdeci">typename VectorType::constReference constReference</div><div class="ttdef"><b>Definition:</b> <a href="Field_8hpp_source.html#l00050">Field.hpp:50</a></div></div>
<div class="ttc" id="aclasspFlow_1_1eventObserver_html_a7d5ac42c30174e7700a36b3d05de5747"><div class="ttname"><a href="classpFlow_1_1eventObserver.html#a7d5ac42c30174e7700a36b3d05de5747">pFlow::eventObserver::subscribe</a></div><div class="ttdeci">bool subscribe(const eventSubscriber &amp;subscriber)</div><div class="ttdef"><b>Definition:</b> <a href="eventObserver_8cpp_source.html#l00050">eventObserver.cpp:50</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00057">error.hpp:57</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a304d8581876270871949bf5d4755036a"><div class="ttname"><a href="namespacepFlow.html#a304d8581876270871949bf5d4755036a">pFlow::range</a></div><div class="ttdeci">kRange&lt; int &gt; range</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00059">KokkosTypes.hpp:59</a></div></div>
<div class="ttc" id="aclasspFlow_1_1eventMessage_html"><div class="ttname"><a href="classpFlow_1_1eventMessage.html">pFlow::eventMessage</a></div><div class="ttdef"><b>Definition:</b> <a href="eventMessage_8hpp_source.html#l00029">eventMessage.hpp:29</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointField_html_a785cd9cdbd48a18c6bddb623fa1740da"><div class="ttname"><a href="classpFlow_1_1pointField.html#a785cd9cdbd48a18c6bddb623fa1740da">pFlow::pointField::isActive</a></div><div class="ttdeci">INLINE_FUNCTION_H bool isActive(label i) const</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8hpp_source.html#l00129">pointField.hpp:129</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointField_html_af594ba73474d415474d32afc783799b1"><div class="ttname"><a href="classpFlow_1_1pointField.html#af594ba73474d415474d32afc783799b1">pFlow::pointField::pStruct</a></div><div class="ttdeci">const pointStructure &amp; pStruct() const</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8hpp_source.html#l00117">pointField.hpp:117</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointStructure_html_a8c8fdb437cc5162b6a36acb35cad4c61"><div class="ttname"><a href="classpFlow_1_1pointStructure.html#a8c8fdb437cc5162b6a36acb35cad4c61">pFlow::pointStructure::pointFlag</a></div><div class="ttdeci">FUNCTION_H int8Field_HD &amp; pointFlag()</div><div class="ttdef"><b>Definition:</b> <a href="pointStructure_8cpp_source.html#l00070">pointStructure.cpp:70</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointStructure_html_a8c8fdb437cc5162b6a36acb35cad4c61"><div class="ttname"><a href="classpFlow_1_1pointStructure.html#a8c8fdb437cc5162b6a36acb35cad4c61">pFlow::pointStructure::pointFlag</a></div><div class="ttdeci">FUNCTION_H int8Field_HD &amp; pointFlag()</div><div class="ttdef"><b>Definition:</b> <a href="pointStructure_8cpp_source.html#l00071">pointStructure.cpp:71</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Field_html_a31d8ae42c5b5086aac03094022636a7e"><div class="ttname"><a href="classpFlow_1_1Field.html#a31d8ae42c5b5086aac03094022636a7e">pFlow::Field&lt; T, T, void &gt;::constPointer</a></div><div class="ttdeci">typename VectorType::constPointer constPointer</div><div class="ttdef"><b>Definition:</b> <a href="Field_8hpp_source.html#l00056">Field.hpp:56</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointStructure_html_a7d8fce812101d1c38607cac47a618b8f"><div class="ttname"><a href="classpFlow_1_1pointStructure.html#a7d8fce812101d1c38607cac47a618b8f">pFlow::pointStructure::activeRange</a></div><div class="ttdeci">INLINE_FUNCTION_H range activeRange() const</div><div class="ttdef"><b>Definition:</b> <a href="pointStructure_8hpp_source.html#l00281">pointStructure.hpp:281</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointStructure_html_a7d8fce812101d1c38607cac47a618b8f"><div class="ttname"><a href="classpFlow_1_1pointStructure.html#a7d8fce812101d1c38607cac47a618b8f">pFlow::pointStructure::activeRange</a></div><div class="ttdeci">INLINE_FUNCTION_H range activeRange() const</div><div class="ttdef"><b>Definition:</b> <a href="pointStructure_8hpp_source.html#l00284">pointStructure.hpp:284</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointField_html_a299b5ee396d969589ede9a5880bfa831"><div class="ttname"><a href="classpFlow_1_1pointField.html#a299b5ee396d969589ede9a5880bfa831">pFlow::pointField::TypeInfoTemplateNV2</a></div><div class="ttdeci">TypeInfoTemplateNV2(&quot;pointField&quot;, T, VectorType::memoerySpaceName())</div></div>
<div class="ttc" id="aclasspFlow_1_1pointField_html_a3ede7be1f8d98c2fa4af7860cdcaf787"><div class="ttname"><a href="classpFlow_1_1pointField.html#a3ede7be1f8d98c2fa4af7860cdcaf787">pFlow::pointField::defaultValue_</a></div><div class="ttdeci">T defaultValue_</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8hpp_source.html#l00068">pointField.hpp:68</a></div></div>
<div class="ttc" id="aclasspFlow_1_1eventObserver_html"><div class="ttname"><a href="classpFlow_1_1eventObserver.html">pFlow::eventObserver</a></div><div class="ttdef"><b>Definition:</b> <a href="eventObserver_8hpp_source.html#l00033">eventObserver.hpp:33</a></div></div>
@ -315,8 +316,8 @@ $(document).ready(function(){initNavTree('pointField_8hpp_source.html',''); init
<div class="ttc" id="aclasspFlow_1_1Field_html"><div class="ttname"><a href="classpFlow_1_1Field.html">pFlow::Field</a></div><div class="ttdef"><b>Definition:</b> <a href="Field_8hpp_source.html#l00033">Field.hpp:33</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_1pointField_html_a1063c9fa94710fcea36468cd35295fe0"><div class="ttname"><a href="classpFlow_1_1pointField.html#a1063c9fa94710fcea36468cd35295fe0">pFlow::pointField::pointFieldType</a></div><div class="ttdeci">pointField&lt; VectorField, T, MemorySpace &gt; pointFieldType</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8hpp_source.html#l00042">pointField.hpp:42</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointStructure_html_a785cd9cdbd48a18c6bddb623fa1740da"><div class="ttname"><a href="classpFlow_1_1pointStructure.html#a785cd9cdbd48a18c6bddb623fa1740da">pFlow::pointStructure::isActive</a></div><div class="ttdeci">INLINE_FUNCTION_H bool isActive(label i) const</div><div class="ttdef"><b>Definition:</b> <a href="pointStructure_8hpp_source.html#l00287">pointStructure.hpp:287</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointStructure_html_a2ce5480679b04413dd607e300cfd1d7b"><div class="ttname"><a href="classpFlow_1_1pointStructure.html#a2ce5480679b04413dd607e300cfd1d7b">pFlow::pointStructure::allActive</a></div><div class="ttdeci">FUNCTION_H bool allActive() const</div><div class="ttdef"><b>Definition:</b> <a href="pointStructure_8cpp_source.html#l00228">pointStructure.cpp:228</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointStructure_html_a785cd9cdbd48a18c6bddb623fa1740da"><div class="ttname"><a href="classpFlow_1_1pointStructure.html#a785cd9cdbd48a18c6bddb623fa1740da">pFlow::pointStructure::isActive</a></div><div class="ttdeci">INLINE_FUNCTION_H bool isActive(label i) const</div><div class="ttdef"><b>Definition:</b> <a href="pointStructure_8hpp_source.html#l00290">pointStructure.hpp:290</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointStructure_html_a2ce5480679b04413dd607e300cfd1d7b"><div class="ttname"><a href="classpFlow_1_1pointStructure.html#a2ce5480679b04413dd607e300cfd1d7b">pFlow::pointStructure::allActive</a></div><div class="ttdeci">FUNCTION_H bool allActive() const</div><div class="ttdef"><b>Definition:</b> <a href="pointStructure_8cpp_source.html#l00230">pointStructure.cpp:230</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointField_html"><div class="ttname"><a href="classpFlow_1_1pointField.html">pFlow::pointField</a></div><div class="ttdef"><b>Definition:</b> <a href="pointField_8hpp_source.html#l00035">pointField.hpp:35</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_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>
@ -328,7 +329,7 @@ $(document).ready(function(){initNavTree('pointField_8hpp_source.html',''); init
<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_1pointField_html_aab9550b3f59f76a254d15a2d537bb395"><div class="ttname"><a href="classpFlow_1_1pointField.html#aab9550b3f59f76a254d15a2d537bb395">pFlow::pointField::allActive</a></div><div class="ttdeci">INLINE_FUNCTION_H bool allActive() const</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8hpp_source.html#l00123">pointField.hpp:123</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointField_html_ab0f80e66016e581c7c92ac96e43c3eca"><div class="ttname"><a href="classpFlow_1_1pointField.html#ab0f80e66016e581c7c92ac96e43c3eca">pFlow::pointField::readPointField</a></div><div class="ttdeci">bool readPointField(iIstream &amp;is)</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8cpp_source.html#l00024">pointField.cpp:24</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_1Field_html_a15206b415c09500493d38c91b970e958"><div class="ttname"><a href="classpFlow_1_1Field.html#a15206b415c09500493d38c91b970e958">pFlow::Field&lt; T, T, void &gt;::pointer</a></div><div class="ttdeci">typename VectorType::pointer pointer</div><div class="ttdef"><b>Definition:</b> <a href="Field_8hpp_source.html#l00054">Field.hpp:54</a></div></div>
<div class="ttc" id="aclasspFlow_1_1uniquePtr_html"><div class="ttname"><a href="classpFlow_1_1uniquePtr.html">pFlow::uniquePtr</a></div><div class="ttdef"><b>Definition:</b> <a href="uniquePtr_8hpp_source.html#l00044">uniquePtr.hpp:44</a></div></div>
<div class="ttc" id="aField_8hpp_html"><div class="ttname"><a href="Field_8hpp.html">Field.hpp</a></div></div>
@ -337,7 +338,7 @@ $(document).ready(function(){initNavTree('pointField_8hpp_source.html',''); init
<div class="ttc" id="aclasspFlow_1_1Field_html_a74686019fa98a3db8312edc2c71076ea"><div class="ttname"><a href="classpFlow_1_1Field.html#a74686019fa98a3db8312edc2c71076ea">pFlow::Field&lt; T, T, void &gt;::valueType</a></div><div class="ttdeci">typename VectorType::valueType valueType</div><div class="ttdef"><b>Definition:</b> <a href="Field_8hpp_source.html#l00052">Field.hpp:52</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a39f5f71474553bc78726494fa09dd0fb"><div class="ttname"><a href="namespacepFlow.html#a39f5f71474553bc78726494fa09dd0fb">pFlow::label</a></div><div class="ttdeci">std::size_t label</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00061">builtinTypes.hpp:61</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointField_html_a2dd413ae6bd64de854f127dfd90b23d5"><div class="ttname"><a href="classpFlow_1_1pointField.html#a2dd413ae6bd64de854f127dfd90b23d5">pFlow::pointField::operator=</a></div><div class="ttdeci">pointField &amp; operator=(const pointField &amp;rhs)</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8cpp_source.html#l00099">pointField.cpp:99</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_1Field_html_a2b8f0ba308c4037e39ec503b9a1e4d0b"><div class="ttname"><a href="classpFlow_1_1Field.html#a2b8f0ba308c4037e39ec503b9a1e4d0b">pFlow::Field&lt; T, T, void &gt;::iterator</a></div><div class="ttdeci">typename VectorType::iterator iterator</div><div class="ttdef"><b>Definition:</b> <a href="Field_8hpp_source.html#l00044">Field.hpp:44</a></div></div>
<div class="ttc" id="apointField_8cpp_html"><div class="ttname"><a href="pointField_8cpp.html">pointField.cpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointField_html_abae5b084c84ba20afd60cbbec92e3124"><div class="ttname"><a href="classpFlow_1_1pointField.html#abae5b084c84ba20afd60cbbec92e3124">pFlow::pointField::update</a></div><div class="ttdeci">bool update(const eventMessage &amp;msg)</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8cpp_source.html#l00111">pointField.cpp:111</a></div></div>
@ -347,7 +348,6 @@ $(document).ready(function(){initNavTree('pointField_8hpp_source.html',''); init
<div class="ttc" id="apointStructure_8hpp_html"><div class="ttname"><a href="pointStructure_8hpp.html">pointStructure.hpp</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_1pointField_html_a5c62d7bde0e3c333317fabe4b8806bef"><div class="ttname"><a href="classpFlow_1_1pointField.html#a5c62d7bde0e3c333317fabe4b8806bef">pFlow::pointField::pStruct_</a></div><div class="ttdeci">const pointStructure &amp; pStruct_</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8hpp_source.html#l00065">pointField.hpp:65</a></div></div>
<div class="ttc" id="anamespacepFlow_html_ad8085fcd475be6bdf841bcdd9b9225ee"><div class="ttname"><a href="namespacepFlow.html#ad8085fcd475be6bdf841bcdd9b9225ee">pFlow::range</a></div><div class="ttdeci">kPair&lt; int, int &gt; range</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00054">KokkosTypes.hpp:54</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Field_html_a17f93ef6c6f1b09493247dc4bfc8034e"><div class="ttname"><a href="classpFlow_1_1Field.html#a17f93ef6c6f1b09493247dc4bfc8034e">pFlow::Field&lt; T, T, void &gt;::VectorType</a></div><div class="ttdeci">T&lt; T, void &gt; VectorType</div><div class="ttdef"><b>Definition:</b> <a href="Field_8hpp_source.html#l00040">Field.hpp:40</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointField_html_a313b7aa0a8e0fc78d0e9d1d8ee0b3f47"><div class="ttname"><a href="classpFlow_1_1pointField.html#a313b7aa0a8e0fc78d0e9d1d8ee0b3f47">pFlow::pointField::pointFlag</a></div><div class="ttdeci">const auto &amp; pointFlag() const</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8hpp_source.html#l00133">pointField.hpp:133</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Field_html_a24e1cc28757f0776d455faa2a92cc094"><div class="ttname"><a href="classpFlow_1_1Field.html#a24e1cc28757f0776d455faa2a92cc094">pFlow::Field&lt; T, T, void &gt;::reference</a></div><div class="ttdeci">typename VectorType::reference reference</div><div class="ttdef"><b>Definition:</b> <a href="Field_8hpp_source.html#l00048">Field.hpp:48</a></div></div>