doc/html updated for integration

This commit is contained in:
Hamidreza Norouzi
2023-04-23 12:52:57 -07:00
parent 01034d0a26
commit ce7070dc37
3087 changed files with 13986 additions and 12088 deletions

View File

@ -4,7 +4,7 @@
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="description" content="PhasicFlow is an open-source parallel DEM package for simulating granular flow developed in C++ and can be exectued on both GPU (like cuda) and CPU.">
<meta name="description" content="PhasicFlow is an open-source parallel DEM (discrete element method) package for simulating granular flow. It is developed in C++ and can be exectued on both GPU (like CUDA) and CPU.">
<title>PhasicFlow: src/Integration/AdamsMoulton3/AdamsMoulton3.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@ -285,27 +285,27 @@ $(document).ready(function(){initNavTree('AdamsMoulton3_8cpp_source.html',''); i
<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="aAdamsMoulton3_8hpp_html"><div class="ttname"><a href="AdamsMoulton3_8hpp.html">AdamsMoulton3.hpp</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_1AdamsMoulton3_html_ad0d8f6814b44931c5a758e93505e0a6e"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#ad0d8f6814b44931c5a758e93505e0a6e">pFlow::AdamsMoulton3::AdamsMoulton3</a></div><div class="ttdeci">AdamsMoulton3(const word &amp;baseName, repository &amp;owner, const pointStructure &amp;pStruct, const word &amp;method)</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton3_8cpp_source.html#l00026">AdamsMoulton3.cpp:26</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="ttdoc">Base class for integrating the first order ODE (IVP)</div><div class="ttdef"><b>Definition:</b> <a href="integration_8hpp_source.html#l00049">integration.hpp:49</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_ad0d8f6814b44931c5a758e93505e0a6e"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#ad0d8f6814b44931c5a758e93505e0a6e">pFlow::AdamsMoulton3::AdamsMoulton3</a></div><div class="ttdeci">AdamsMoulton3(const word &amp;baseName, repository &amp;owner, const pointStructure &amp;pStruct, const word &amp;method)</div><div class="ttdoc">Construct from components.</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton3_8cpp_source.html#l00026">AdamsMoulton3.cpp:26</a></div></div>
<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_1AdamsMoulton3_html_a152b752a6b7b37e70fa5e7c99a484783"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#a152b752a6b7b37e70fa5e7c99a484783">pFlow::AdamsMoulton3::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="AdamsMoulton3_8cpp_source.html#l00146">AdamsMoulton3.cpp:146</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_a152b752a6b7b37e70fa5e7c99a484783"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#a152b752a6b7b37e70fa5e7c99a484783">pFlow::AdamsMoulton3::intAll</a></div><div class="ttdeci">bool intAll(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy, range activeRng)</div><div class="ttdoc">Integrate on all points in the active range.</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton3_8cpp_source.html#l00146">AdamsMoulton3.cpp:146</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a477d522d35403bd985ae105bd759e9d1"><div class="ttname"><a href="namespacepFlow.html#a477d522d35403bd985ae105bd759e9d1">pFlow::zero3</a></div><div class="ttdeci">const realx3 zero3(0.0)</div><div class="ttdef"><b>Definition:</b> <a href="types_8hpp_source.html#l00097">types.hpp:97</a></div></div>
<div class="ttc" id="aclasspFlow_1_1repository_html_a5bbe8f5fd6ec57500bcbc3e5cd5c9cf4"><div class="ttname"><a href="classpFlow_1_1repository.html#a5bbe8f5fd6ec57500bcbc3e5cd5c9cf4">pFlow::repository::emplaceObject</a></div><div class="ttdeci">T &amp; emplaceObject(const objectFile &amp;objf, Args &amp;&amp;... args)</div><div class="ttdef"><b>Definition:</b> <a href="repositoryTemplates_8cpp_source.html#l00038">repositoryTemplates.cpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_ace46ff4fbe3c001c816dbc4f9f67606f"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#ace46ff4fbe3c001c816dbc4f9f67606f">pFlow::AdamsMoulton3::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="AdamsMoulton3_8hpp_source.html#l00048">AdamsMoulton3.hpp:48</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_ace46ff4fbe3c001c816dbc4f9f67606f"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#ace46ff4fbe3c001c816dbc4f9f67606f">pFlow::AdamsMoulton3::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="ttdoc">Range policy for integration kernel.</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton3_8hpp_source.html#l00056">AdamsMoulton3.hpp:56</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a16a2137651b2c6b8ea4a8daf1d89ff61"><div class="ttname"><a href="namespacepFlow.html#a16a2137651b2c6b8ea4a8daf1d89ff61">pFlow::baseName</a></div><div class="ttdeci">word baseName(const word &amp;w, char sep='.')</div><div class="ttdef"><b>Definition:</b> <a href="bTypesFunctions_8cpp_source.html#l00156">bTypesFunctions.cpp:156</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_1AdamsMoulton3_html_a8da2088458d635dfa1fbe1823a3bfd6d"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#a8da2088458d635dfa1fbe1823a3bfd6d">pFlow::AdamsMoulton3::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="AdamsMoulton3_8cpp_source.html#l00111">AdamsMoulton3.cpp:111</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_a8da2088458d635dfa1fbe1823a3bfd6d"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#a8da2088458d635dfa1fbe1823a3bfd6d">pFlow::AdamsMoulton3::setInitialVals</a></div><div class="ttdeci">bool setInitialVals(const int32IndexContainer &amp;newIndices, const realx3Vector &amp;y) override</div><div class="ttdoc">Set the initial values for new indices.</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton3_8cpp_source.html#l00111">AdamsMoulton3.cpp:111</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_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_1objectFile_html"><div class="ttname"><a href="classpFlow_1_1objectFile.html">pFlow::objectFile</a></div><div class="ttdef"><b>Definition:</b> <a href="objectFile_8hpp_source.html#l00033">objectFile.hpp:33</a></div></div>
<div class="ttc" id="asetPointStructure_8hpp_html_a385e32971df44b131e4498181a949a91"><div class="ttname"><a href="setPointStructure_8hpp.html#a385e32971df44b131e4498181a949a91">pStruct</a></div><div class="ttdeci">auto &amp; pStruct</div><div class="ttdef"><b>Definition:</b> <a href="setPointStructure_8hpp_source.html#l00024">setPointStructure.hpp:24</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_aa601d0785e68d2298567b2861996f956"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#aa601d0785e68d2298567b2861996f956">pFlow::AdamsMoulton3::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="AdamsMoulton3_8cpp_source.html#l00120">AdamsMoulton3.cpp:120</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_a565b658e8641f9fd9a6a5c8e93089d5d"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#a565b658e8641f9fd9a6a5c8e93089d5d">pFlow::AdamsMoulton3::predict</a></div><div class="ttdeci">bool predict(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy) override</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton3_8cpp_source.html#l00073">AdamsMoulton3.cpp:73</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_aa601d0785e68d2298567b2861996f956"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#aa601d0785e68d2298567b2861996f956">pFlow::AdamsMoulton3::predictAll</a></div><div class="ttdeci">bool predictAll(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy, range activeRng)</div><div class="ttdoc">Prediction step on all points in the active range.</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton3_8cpp_source.html#l00120">AdamsMoulton3.cpp:120</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_a565b658e8641f9fd9a6a5c8e93089d5d"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#a565b658e8641f9fd9a6a5c8e93089d5d">pFlow::AdamsMoulton3::predict</a></div><div class="ttdeci">bool predict(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy) override</div><div class="ttdoc">Prediction step in integration.</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton3_8cpp_source.html#l00073">AdamsMoulton3.cpp:73</a></div></div>
<div class="ttc" id="apFlowMacros_8hpp_html_aa7d4742cdf24a3792276e669531d145c"><div class="ttname"><a href="pFlowMacros_8hpp.html#aa7d4742cdf24a3792276e669531d145c">LAMBDA_HD</a></div><div class="ttdeci">#define LAMBDA_HD</div><div class="ttdef"><b>Definition:</b> <a href="pFlowMacros_8hpp_source.html#l00054">pFlowMacros.hpp:54</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a12b4d93aa9730629403d73e84386bff5"><div class="ttname"><a href="namespacepFlow.html#a12b4d93aa9730629403d73e84386bff5">pFlow::groupNames</a></div><div class="ttdeci">word groupNames(const word &amp;bw, const word &amp;tw, char sep='.')</div><div class="ttdef"><b>Definition:</b> <a href="bTypesFunctions_8cpp_source.html#l00151">bTypesFunctions.cpp:151</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_a6c02e0d25a1b849255e67e72d1a9d026"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#a6c02e0d25a1b849255e67e72d1a9d026">pFlow::AdamsMoulton3::y0_</a></div><div class="ttdeci">realx3PointField_D &amp; y0_</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton3_8hpp_source.html#l00038">AdamsMoulton3.hpp:38</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_ac755e4bf02c3732d1eb89de9e903ebdb"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#ac755e4bf02c3732d1eb89de9e903ebdb">pFlow::AdamsMoulton3::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="AdamsMoulton3_8cpp_source.html#l00093">AdamsMoulton3.cpp:93</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_a6c02e0d25a1b849255e67e72d1a9d026"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#a6c02e0d25a1b849255e67e72d1a9d026">pFlow::AdamsMoulton3::y0_</a></div><div class="ttdeci">realx3PointField_D &amp; y0_</div><div class="ttdoc">y at time t</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton3_8hpp_source.html#l00043">AdamsMoulton3.hpp:43</a></div></div>
<div class="ttc" id="aclasspFlow_1_1AdamsMoulton3_html_ac755e4bf02c3732d1eb89de9e903ebdb"><div class="ttname"><a href="classpFlow_1_1AdamsMoulton3.html#ac755e4bf02c3732d1eb89de9e903ebdb">pFlow::AdamsMoulton3::correct</a></div><div class="ttdeci">bool correct(real dt, realx3Vector_D &amp;y, realx3Vector_D &amp;dy) override</div><div class="ttdoc">Correction/main integration step.</div><div class="ttdef"><b>Definition:</b> <a href="AdamsMoulton3_8cpp_source.html#l00093">AdamsMoulton3.cpp:93</a></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#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>