xfygogo/phasicFlow
1
0
Fork 0
mirror of https://github.com/PhasicFlow/phasicFlow.git synced 2025-06-22 16:28:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/html updated for integration

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/code-documentation/html/sphereInteraction_8hpp_source.html
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/Interaction/sphereInteraction/sphereInteraction.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@ -207,8 +207,8 @@ $(document).ready(function(){initNavTree('sphereInteraction_8hpp_source.html',''
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <a class="code" href="classpFlow_1_1interaction.html">interaction</a>(<a class="code" href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">control</a>, prtcl, geom),</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <a class="code" href="classpFlow_1_1sphereInteraction.html#a85c5692b97a3b485cc3f52368b063942">geometryMotion_</a>(dynamic_cast&lt;const <a class="code" href="classpFlow_1_1sphereInteraction.html#a92d80c9a6ba7b1c4bd6cf62df514a095">GeometryMotionModel</a>&amp;&gt;(geom)),</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; <a class="code" href="classpFlow_1_1sphereInteraction.html#af9b03fc5ca999442443d1c28771d0a94">sphParticles_</a>(dynamic_cast&lt;const <a class="code" href="classpFlow_1_1sphereParticles.html">sphereParticles</a>&amp;&gt;(prtcl)),</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <a class="code" href="classpFlow_1_1sphereInteraction.html#abeef262bf78ee4dd6e40ee7834767b35">ppInteractionTimer_</a>(<span class="stringliteral">&quot;sphere-sphere interaction&quot;</span>, &amp;this-&gt;<a class="code" href="classpFlow_1_1demComponent.html#a49e56dd259a0f440e947ed17b149f32f">timers</a>()),</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <a class="code" href="classpFlow_1_1sphereInteraction.html#a7fe511b7575f6a62d774460cc38ae78e">pwInteractionTimer_</a>(<span class="stringliteral">&quot;sphere-wall interaction&quot;</span>, &amp;this-&gt;<a class="code" href="classpFlow_1_1demComponent.html#a49e56dd259a0f440e947ed17b149f32f">timers</a>())</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <a class="code" href="classpFlow_1_1sphereInteraction.html#abeef262bf78ee4dd6e40ee7834767b35">ppInteractionTimer_</a>(<span class="stringliteral">&quot;sphere-sphere interaction&quot;</span>, &amp;this-&gt;<a class="code" href="classpFlow_1_1demComponent.html#ae69e59e991f33e7d278ff6ad19d2e87d">timers</a>()),</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; <a class="code" href="classpFlow_1_1sphereInteraction.html#a7fe511b7575f6a62d774460cc38ae78e">pwInteractionTimer_</a>(<span class="stringliteral">&quot;sphere-wall interaction&quot;</span>, &amp;this-&gt;<a class="code" href="classpFlow_1_1demComponent.html#ae69e59e991f33e7d278ff6ad19d2e87d">timers</a>())</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; {</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordflow">if</span>(!<a class="code" href="classpFlow_1_1sphereInteraction.html#a9eab7f2a8f2976d43a4ae0bfaa31b142">createSphereInteraction</a>())</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; {</div>
@ -325,13 +325,13 @@ $(document).ready(function(){initNavTree('sphereInteraction_8hpp_source.html',''
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a896e9608ca8d44dee25f2f9d54344c0c"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a896e9608ca8d44dee25f2f9d54344c0c">pFlow::sphereInteraction::sphereWallInteraction</a></div><div class="ttdeci">bool sphereWallInteraction()</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8cpp_source.html#l00095">sphereInteraction.cpp:95</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a0d1ed1e8837f1f0d7faab5634fc10311"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a0d1ed1e8837f1f0d7faab5634fc10311">pFlow::sphereInteraction::PairsContainerType</a></div><div class="ttdeci">typename contactSearch::PairContainerType PairsContainerType</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00059">sphereInteraction.hpp:59</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_ada71b97666fe3f66b31690bf12633c32"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#ada71b97666fe3f66b31690bf12633c32">pFlow::sphereInteraction::beforeIteration</a></div><div class="ttdeci">bool beforeIteration() override</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00129">sphereInteraction.hpp:129</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_ada71b97666fe3f66b31690bf12633c32"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#ada71b97666fe3f66b31690bf12633c32">pFlow::sphereInteraction::beforeIteration</a></div><div class="ttdeci">bool beforeIteration() override</div><div class="ttdoc">This is called in time loop, before iterate.</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00129">sphereInteraction.hpp:129</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a85c5692b97a3b485cc3f52368b063942"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a85c5692b97a3b485cc3f52368b063942">pFlow::sphereInteraction::geometryMotion_</a></div><div class="ttdeci">const GeometryMotionModel &amp; geometryMotion_</div><div class="ttdoc">const reference to geometry</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00064">sphereInteraction.hpp:64</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="aclasspFlow_1_1sphereInteraction_html_a9609236c05a92088701e0be353ae1aa9"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a9609236c05a92088701e0be353ae1aa9">pFlow::sphereInteraction::MotionModel</a></div><div class="ttdeci">typename geometryMotionModel::MotionModel MotionModel</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00046">sphereInteraction.hpp:46</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a5ab4b6c611c3256e54f51bbfc484d58e"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a5ab4b6c611c3256e54f51bbfc484d58e">pFlow::sphereInteraction::afterIteration</a></div><div class="ttdeci">bool afterIteration() override</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00203">sphereInteraction.hpp:203</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a5ab4b6c611c3256e54f51bbfc484d58e"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a5ab4b6c611c3256e54f51bbfc484d58e">pFlow::sphereInteraction::afterIteration</a></div><div class="ttdeci">bool afterIteration() override</div><div class="ttdoc">This is called in time loop, after iterate.</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00203">sphereInteraction.hpp:203</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_1demComponent_html_a647786897b3da03fcd415b2ebcf541c0"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">pFlow::demComponent::control</a></div><div class="ttdeci">const auto &amp; control() const</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00057">demComponent.hpp:57</a></div></div>
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a647786897b3da03fcd415b2ebcf541c0"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a647786897b3da03fcd415b2ebcf541c0">pFlow::demComponent::control</a></div><div class="ttdeci">const auto &amp; control() const</div><div class="ttdoc">Const ref to systemControl.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00089">demComponent.hpp:89</a></div></div>
<div class="ttc" id="aclasspFlow_1_1Timer_html_a60de64d75454385b23995437f1d72669"><div class="ttname"><a href="classpFlow_1_1Timer.html#a60de64d75454385b23995437f1d72669">pFlow::Timer::start</a></div><div class="ttdeci">void start()</div><div class="ttdef"><b>Definition:</b> <a href="Timer_8hpp_source.html#l00097">Timer.hpp:97</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a9eab7f2a8f2976d43a4ae0bfaa31b142"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a9eab7f2a8f2976d43a4ae0bfaa31b142">pFlow::sphereInteraction::createSphereInteraction</a></div><div class="ttdeci">bool createSphereInteraction()</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8cpp_source.html#l00026">sphereInteraction.cpp:26</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a829b8d15f91240e6bf9147f73f939d11"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a829b8d15f91240e6bf9147f73f939d11">pFlow::sphereInteraction::managePWContactLists</a></div><div class="ttdeci">bool managePWContactLists()</div></div>
@ -341,6 +341,7 @@ $(document).ready(function(){initNavTree('sphereInteraction_8hpp_source.html',''
<div class="ttc" id="aclasspFlow_1_1interaction_html_a18d3281d135de549b69af821b3fef223"><div class="ttname"><a href="classpFlow_1_1interaction.html#a18d3281d135de549b69af821b3fef223">pFlow::interaction::ExecutionSpace</a></div><div class="ttdeci">typename interactionBase::ExecutionSpace ExecutionSpace</div><div class="ttdef"><b>Definition:</b> <a href="interaction_8hpp_source.html#l00046">interaction.hpp:46</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a98372d2b87e1c67d4b2eb0517336abf7"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a98372d2b87e1c67d4b2eb0517336abf7">pFlow::sphereInteraction::update</a></div><div class="ttdeci">bool update(const eventMessage &amp;msg) override</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00209">sphereInteraction.hpp:209</a></div></div>
<div class="ttc" id="ainteraction_8hpp_html"><div class="ttname"><a href="interaction_8hpp.html">interaction.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1demComponent_html_ae69e59e991f33e7d278ff6ad19d2e87d"><div class="ttname"><a href="classpFlow_1_1demComponent.html#ae69e59e991f33e7d278ff6ad19d2e87d">pFlow::demComponent::timers</a></div><div class="ttdeci">const auto &amp; timers() const</div><div class="ttdoc">Const ref to timers.</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00117">demComponent.hpp:117</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_ae4ee93ce294f9a505bf6d222cda16426"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#ae4ee93ce294f9a505bf6d222cda16426">pFlow::sphereInteraction::rpPWInteraction</a></div><div class="ttdeci">rpPPInteraction rpPWInteraction</div><div class="ttdoc">range policy for p-w interaction execution</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00096">sphereInteraction.hpp:96</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_adbda74b13fb6f253badf2478c99fd3cf"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#adbda74b13fb6f253badf2478c99fd3cf">pFlow::sphereInteraction::sphereInteraction</a></div><div class="ttdeci">sphereInteraction(systemControl &amp;control, const particles &amp;prtcl, const geometry &amp;geom)</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00104">sphereInteraction.hpp:104</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_abeef262bf78ee4dd6e40ee7834767b35"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#abeef262bf78ee4dd6e40ee7834767b35">pFlow::sphereInteraction::ppInteractionTimer_</a></div><div class="ttdeci">Timer ppInteractionTimer_</div><div class="ttdoc">timer for particle-particle interaction computations</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00080">sphereInteraction.hpp:80</a></div></div>
@ -365,14 +366,13 @@ $(document).ready(function(){initNavTree('sphereInteraction_8hpp_source.html',''
<div class="ttc" id="aclasspFlow_1_1geometry_html"><div class="ttname"><a href="classpFlow_1_1geometry.html">pFlow::geometry</a></div><div class="ttdoc">Base class for geometry for managing tri-surfaces, geometry motion, and surface physical properties.</div><div class="ttdef"><b>Definition:</b> <a href="geometry_8hpp_source.html#l00043">geometry.hpp:43</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a7fe511b7575f6a62d774460cc38ae78e"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a7fe511b7575f6a62d774460cc38ae78e">pFlow::sphereInteraction::pwInteractionTimer_</a></div><div class="ttdeci">Timer pwInteractionTimer_</div><div class="ttdoc">timer for particle-wall interaction computations</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00083">sphereInteraction.hpp:83</a></div></div>
<div class="ttc" id="aclasspFlow_1_1interaction_html_a8c210b9197467ebb4878ea56cb1d3270"><div class="ttname"><a href="classpFlow_1_1interaction.html#a8c210b9197467ebb4878ea56cb1d3270">pFlow::interaction::contactSearch_</a></div><div class="ttdeci">uniquePtr&lt; contactSearch &gt; contactSearch_</div><div class="ttdoc">contact search object for pp and pw interactions</div><div class="ttdef"><b>Definition:</b> <a href="interaction_8hpp_source.html#l00054">interaction.hpp:54</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_afa767bddda52eb71cea18f755e17d559"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#afa767bddda52eb71cea18f755e17d559">pFlow::sphereInteraction::iterate</a></div><div class="ttdeci">bool iterate() override</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00135">sphereInteraction.hpp:135</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_afa767bddda52eb71cea18f755e17d559"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#afa767bddda52eb71cea18f755e17d559">pFlow::sphereInteraction::iterate</a></div><div class="ttdeci">bool iterate() override</div><div class="ttdoc">This is called in time loop.</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00135">sphereInteraction.hpp:135</a></div></div>
<div class="ttc" id="asphereParticles_8hpp_html"><div class="ttname"><a href="sphereParticles_8hpp.html">sphereParticles.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a54a996dc239c37bbbdd265524a386065"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a54a996dc239c37bbbdd265524a386065">pFlow::sphereInteraction::forceModel_</a></div><div class="ttdeci">uniquePtr&lt; ContactForceModel &gt; forceModel_</div><div class="ttdoc">contact force model</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00071">sphereInteraction.hpp:71</a></div></div>
<div class="ttc" id="aclasspFlow_1_1interaction_html_a3af07639d0071df31d0741a89d85ea76"><div class="ttname"><a href="classpFlow_1_1interaction.html#a3af07639d0071df31d0741a89d85ea76">pFlow::interaction::IdType</a></div><div class="ttdeci">typename interactionBase::IdType IdType</div><div class="ttdef"><b>Definition:</b> <a href="interaction_8hpp_source.html#l00042">interaction.hpp:42</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a597cbd8042eaa556357094485b716c05"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a597cbd8042eaa556357094485b716c05">pFlow::sphereInteraction::managePPContactLists</a></div><div class="ttdeci">bool managePPContactLists()</div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_ae0579d94abaf8427e10a2f0d69a96563"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#ae0579d94abaf8427e10a2f0d69a96563">pFlow::sphereInteraction::rpPPInteraction</a></div><div class="ttdeci">Kokkos::RangePolicy&lt; Kokkos::IndexType&lt; int32 &gt;, Kokkos::Schedule&lt; Kokkos::Dynamic &gt; &gt; rpPPInteraction</div><div class="ttdoc">range policy for p-p interaction execution</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00093">sphereInteraction.hpp:93</a></div></div>
<div class="ttc" id="aclasspFlow_1_1interaction_html"><div class="ttname"><a href="classpFlow_1_1interaction.html">pFlow::interaction</a></div><div class="ttdef"><b>Definition:</b> <a href="interaction_8hpp_source.html#l00034">interaction.hpp:34</a></div></div>
<div class="ttc" id="aclasspFlow_1_1demComponent_html_a49e56dd259a0f440e947ed17b149f32f"><div class="ttname"><a href="classpFlow_1_1demComponent.html#a49e56dd259a0f440e947ed17b149f32f">pFlow::demComponent::timers</a></div><div class="ttdeci">auto &amp; timers()</div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00079">demComponent.hpp:79</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a98e515ac9de730dafe652cf79d3ce1ce"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a98e515ac9de730dafe652cf79d3ce1ce">pFlow::sphereInteraction::TypeInfoTemplate3</a></div><div class="ttdeci">TypeInfoTemplate3(&quot;sphereInteraction&quot;, ContactForceModel, MotionModel, ContactListType)</div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_a6198cba78b395b0bcc307eadfb31b82a"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#a6198cba78b395b0bcc307eadfb31b82a">pFlow::sphereInteraction::sphereSphereInteraction</a></div><div class="ttdeci">bool sphereSphereInteraction()</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8cpp_source.html#l00056">sphereInteraction.cpp:56</a></div></div>
<div class="ttc" id="aclasspFlow_1_1sphereInteraction_html_ae368a1ff5d1ee44cd9e169593c734d2f"><div class="ttname"><a href="classpFlow_1_1sphereInteraction.html#ae368a1ff5d1ee44cd9e169593c734d2f">pFlow::sphereInteraction::ContactListType</a></div><div class="ttdeci">contactListType&lt; ModelStorage, ExecutionSpace, IdType &gt; ContactListType</div><div class="ttdef"><b>Definition:</b> <a href="sphereInteraction_8hpp_source.html#l00057">sphereInteraction.hpp:57</a></div></div>