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

@ -194,12 +194,12 @@ $(document).ready(function(){initNavTree('AdamsMoulton5_8hpp_source.html',''); i
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="keywordflow">return</span> makeUnique&lt;AdamsMoulton5&gt;(*<span class="keyword">this</span>);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; }</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1AdamsMoulton5.html#aa601d0785e68d2298567b2861996f956">predictAll</a>(<a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; y, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; dy, <a class="code" href="namespacepFlow.html#ad8085fcd475be6bdf841bcdd9b9225ee">range</a> activeRng);</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1AdamsMoulton5.html#aa601d0785e68d2298567b2861996f956">predictAll</a>(<a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; y, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; dy, <a class="code" href="namespacepFlow.html#a304d8581876270871949bf5d4755036a">range</a> activeRng);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> activeFunctor&gt;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1AdamsMoulton5.html#aaa8ac3ebc39d8702e08e1f71c5843974">predictRange</a>(<a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; y, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; dy, activeFunctor activeP);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1AdamsMoulton5.html#a152b752a6b7b37e70fa5e7c99a484783">intAll</a>(<a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; y, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; dy, <a class="code" href="namespacepFlow.html#ad8085fcd475be6bdf841bcdd9b9225ee">range</a> activeRng);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1AdamsMoulton5.html#a152b752a6b7b37e70fa5e7c99a484783">intAll</a>(<a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; y, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; dy, <a class="code" href="namespacepFlow.html#a304d8581876270871949bf5d4755036a">range</a> activeRng);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> activeFunctor&gt;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1AdamsMoulton5.html#a191dc9197b587f09bb5ee7989b0ba43e">intRange</a>(<a class="code" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; y, <a class="code" href="classpFlow_1_1VectorSingle.html">realx3Vector_D</a>&amp; dy, activeFunctor activeP );</div>
@ -298,6 +298,7 @@ $(document).ready(function(){initNavTree('AdamsMoulton5_8hpp_source.html',''); i
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html_a8da2088458d635dfa1fbe1823a3bfd6d"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#a8da2088458d635dfa1fbe1823a3bfd6d">pFlow::AdamsMoulton5::setInitialVals</a></div><div class="ttdeci">bool setInitialVals(const int32IndexContainer &amp;newIndices, const realx3Vector &amp;y) override</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton5_8cpp_source.html#l00132">AdamsMoulton5.cpp:132</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html_ace46ff4fbe3c001c816dbc4f9f67606f"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#ace46ff4fbe3c001c816dbc4f9f67606f">pFlow::AdamsMoulton5::rpIntegration</a></div><div class="ttdeci">Kokkos::RangePolicy&lt; DefaultExecutionSpace, Kokkos::Schedule&lt; Kokkos::Static &gt;, Kokkos::IndexType&lt; int32 &gt; &gt; rpIntegration</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton5_8hpp_source.html#l00052">AdamsMoulton5.hpp:52</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="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_1AdamsMoulton5_html_aaa8ac3ebc39d8702e08e1f71c5843974"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#aaa8ac3ebc39d8702e08e1f71c5843974">pFlow::AdamsMoulton5::predictRange</a></div><div class="ttdeci">bool predictRange(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy, activeFunctor activeP)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton5_8hpp_source.html#l00107">AdamsMoulton5.hpp:107</a></div></div>
<div class="ttc" id="aclasspFlow_1_1integration_html"><div class="ttname"><a href="classpFlow_1_1integration.html">pFlow::integration</a></div><div class="ttdef"><b>Definition:</b> <a href="integration_8hpp_source.html#l00035">integration.hpp:35</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html_a152b752a6b7b37e70fa5e7c99a484783"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#a152b752a6b7b37e70fa5e7c99a484783">pFlow::AdamsMoulton5::intAll</a></div><div class="ttdeci">bool intAll(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy, range activeRng)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton5_8cpp_source.html#l00174">AdamsMoulton5.cpp:174</a></div></div>
@ -307,7 +308,7 @@ $(document).ready(function(){initNavTree('AdamsMoulton5_8hpp_source.html',''); i
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html_aa18e539a33004e6d10e69a19ef0c5ddb"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#aa18e539a33004e6d10e69a19ef0c5ddb">pFlow::AdamsMoulton5::add_vCtor</a></div><div class="ttdeci">add_vCtor(integration, AdamsMoulton5, word)</div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html">pFlow::AdamsMoulton5</a></div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton5_8hpp_source.html#l00032">AdamsMoulton5.hpp:32</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html_aa601d0785e68d2298567b2861996f956"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#aa601d0785e68d2298567b2861996f956">pFlow::AdamsMoulton5::predictAll</a></div><div class="ttdeci">bool predictAll(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy, range activeRng)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton5_8cpp_source.html#l00141">AdamsMoulton5.cpp:141</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aa3a14d3c76643399fc4edd8eca14944a"><div class="ttname"><a href="namespacepFlow.html#aa3a14d3c76643399fc4edd8eca14944a">pFlow::DefaultExecutionSpace</a></div><div class="ttdeci">Kokkos::DefaultExecutionSpace DefaultExecutionSpace</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00047">KokkosTypes.hpp:47</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aa3a14d3c76643399fc4edd8eca14944a"><div class="ttname"><a href="namespacepFlow.html#aa3a14d3c76643399fc4edd8eca14944a">pFlow::DefaultExecutionSpace</a></div><div class="ttdeci">Kokkos::DefaultExecutionSpace DefaultExecutionSpace</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00049">KokkosTypes.hpp:49</a></div></div>
<div class="ttc" id="aclasspFlow_1_1integration_html_a4e30df3927ef1cdd2490cd85018518f5"><div class="ttname"><a href="classpFlow_1_1integration.html#a4e30df3927ef1cdd2490cd85018518f5">pFlow::integration::baseName</a></div><div class="ttdeci">const word &amp; baseName() const</div><div class="ttdef"><b>Definition:</b> <a href="integration_8hpp_source.html#l00089">integration.hpp:89</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"><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>
@ -319,7 +320,7 @@ $(document).ready(function(){initNavTree('AdamsMoulton5_8hpp_source.html',''); i
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html_a6c02e0d25a1b849255e67e72d1a9d026"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#a6c02e0d25a1b849255e67e72d1a9d026">pFlow::AdamsMoulton5::y0_</a></div><div class="ttdeci">realx3PointField_D &amp; y0_</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton5_8hpp_source.html#l00038">AdamsMoulton5.hpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1pointField_html_afef304b4d4497e45857f6edef9b049e6"><div class="ttname"><a href="classpFlow_1_1pointField.html#afef304b4d4497e45857f6edef9b049e6">pFlow::pointField::activeRange</a></div><div class="ttdeci">range activeRange() const</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8hpp_source.html#l00138">pointField.hpp:138</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html_ac755e4bf02c3732d1eb89de9e903ebdb"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#ac755e4bf02c3732d1eb89de9e903ebdb">pFlow::AdamsMoulton5::correct</a></div><div class="ttdeci">bool correct(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy) override</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton5_8cpp_source.html#l00114">AdamsMoulton5.cpp:114</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="aclasspFlow_1_1AdamsMoulton5_html_a84c490b65587b21f5666766e94a945bc"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#a84c490b65587b21f5666766e94a945bc">pFlow::AdamsMoulton5::AdamsMoulton5</a></div><div class="ttdeci">AdamsMoulton5(const word &amp;baseName, repository &amp;owner, const pointStructure &amp;pStruct, const word &amp;method)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton5_8cpp_source.html#l00025">AdamsMoulton5.cpp:25</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html_aceb0c803bb6e5c46a1695c4e5b6e641f"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#aceb0c803bb6e5c46a1695c4e5b6e641f">pFlow::AdamsMoulton5::needSetInitialVals</a></div><div class="ttdeci">bool needSetInitialVals() const override</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton5_8hpp_source.html#l00083">AdamsMoulton5.hpp:83</a></div></div>
<div class="ttc" id="aclasspFlow_1_1integration_html_a10329e18307a60d3fdb203bcbed2b295"><div class="ttname"><a href="classpFlow_1_1integration.html#a10329e18307a60d3fdb203bcbed2b295">pFlow::integration::owner</a></div><div class="ttdeci">repository &amp; owner()</div><div class="ttdef"><b>Definition:</b> <a href="integration_8hpp_source.html#l00094">integration.hpp:94</a></div></div>
@ -332,10 +333,9 @@ $(document).ready(function(){initNavTree('AdamsMoulton5_8hpp_source.html',''); i
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html_a191dc9197b587f09bb5ee7989b0ba43e"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#a191dc9197b587f09bb5ee7989b0ba43e">pFlow::AdamsMoulton5::intRange</a></div><div class="ttdeci">bool intRange(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy, activeFunctor activeP)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton5_8hpp_source.html#l00145">AdamsMoulton5.hpp:145</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html_a205b69055b5aebe5b9c924e435365169"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#a205b69055b5aebe5b9c924e435365169">pFlow::AdamsMoulton5::~AdamsMoulton5</a></div><div class="ttdeci">virtual ~AdamsMoulton5()=default</div></div>
<div class="ttc" id="aclasspFlow_1_1repository_html"><div class="ttname"><a href="classpFlow_1_1repository.html">pFlow::repository</a></div><div class="ttdef"><b>Definition:</b> <a href="repository_8hpp_source.html#l00034">repository.hpp:34</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_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="aclasspFlow_1_1Vector_html"><div class="ttname"><a href="classpFlow_1_1Vector.html">pFlow::Vector&lt; realx3 &gt;</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton5_html_a93700041b6e609e429801e569f554e4c"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton5.html#a93700041b6e609e429801e569f554e4c">pFlow::AdamsMoulton5::TypeInfo</a></div><div class="ttdeci">TypeInfo(&quot;AdamsMoulton5&quot;)</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_1indexContainer_html"><div class="ttname"><a href="classpFlow_1_1indexContainer.html">pFlow::indexContainer&lt; int32 &gt;</a></div></div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>