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/Particles/particles/particles.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@ -386,7 +386,7 @@ $(document).ready(function(){initNavTree('particles_8hpp_source.html',''); initR
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1particles_html_a2eeb9b0ec300769778c7553bf03b3ae4"><div class="ttname"><a href="classpFlow_1_1particles.html#a2eeb9b0ec300769778c7553bf03b3ae4">pFlow::particles::mass</a></div><div class="ttdeci">const auto &amp; mass() const</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00188">particles.hpp:188</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_a4741b994d62377ef249268f9c5ad50da"><div class="ttname"><a href="classpFlow_1_1particles.html#a4741b994d62377ef249268f9c5ad50da">pFlow::particles::shapeName_</a></div><div class="ttdeci">wordPointField &amp; shapeName_</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00049">particles.hpp:49</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_ada71b97666fe3f66b31690bf12633c32"><div class="ttname"><a href="classpFlow_1_1particles.html#ada71b97666fe3f66b31690bf12633c32">pFlow::particles::beforeIteration</a></div><div class="ttdeci">bool beforeIteration() override</div><div class="ttdef"><b>Definition:</b> <a href="particles_8cpp_source.html#l00153">particles.cpp:153</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_ada71b97666fe3f66b31690bf12633c32"><div class="ttname"><a href="classpFlow_1_1particles.html#ada71b97666fe3f66b31690bf12633c32">pFlow::particles::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="particles_8cpp_source.html#l00153">particles.cpp:153</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_a2ea82ad168ac25067aa6df3b56ca2653"><div class="ttname"><a href="classpFlow_1_1particles.html#a2ea82ad168ac25067aa6df3b56ca2653">pFlow::particles::pointVelocity</a></div><div class="ttdeci">const auto &amp; pointVelocity() const</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00164">particles.hpp:164</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_a717c0ef2ced479bb7a8896e896d00791"><div class="ttname"><a href="classpFlow_1_1particles.html#a717c0ef2ced479bb7a8896e896d00791">pFlow::particles::propertyId</a></div><div class="ttdeci">auto &amp; propertyId()</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00232">particles.hpp:232</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_ad9a718f1ea228888eba2db158b99b74a"><div class="ttname"><a href="classpFlow_1_1particles.html#ad9a718f1ea228888eba2db158b99b74a">pFlow::particles::velocity</a></div><div class="ttdeci">const auto &amp; velocity() const</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00168">particles.hpp:168</a></div></div>
@ -395,7 +395,7 @@ $(document).ready(function(){initNavTree('particles_8hpp_source.html',''); initR
<div class="ttc" id="aclasspFlow_1_1particles_html_a56fb326388f2cc9c2c4a360a6ff70f31"><div class="ttname"><a href="classpFlow_1_1particles.html#a56fb326388f2cc9c2c4a360a6ff70f31">pFlow::particles::contactTorque</a></div><div class="ttdeci">const realx3PointField_D &amp; contactTorque() const</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00223">particles.hpp:223</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="aclasspFlow_1_1particles_html_a248ed9b3af5e1fb5427f9dacb68eec9e"><div class="ttname"><a href="classpFlow_1_1particles.html#a248ed9b3af5e1fb5427f9dacb68eec9e">pFlow::particles::pointPosition</a></div><div class="ttdeci">const auto &amp; pointPosition() const</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00155">particles.hpp:155</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_1particles_html_ae69018cbb9a008005d5749278a51f7aa"><div class="ttname"><a href="classpFlow_1_1particles.html#ae69018cbb9a008005d5749278a51f7aa">pFlow::particles::position</a></div><div class="ttdeci">const auto &amp; position() const</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00159">particles.hpp:159</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_a5a5187815d4381e1ef3246ff4ca9eae3"><div class="ttname"><a href="classpFlow_1_1particles.html#a5a5187815d4381e1ef3246ff4ca9eae3">pFlow::particles::dynPointStruct</a></div><div class="ttdeci">const auto &amp; dynPointStruct() const</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00108">particles.hpp:108</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_ad265a05b680753a20eba56b91f0eab45"><div class="ttname"><a href="classpFlow_1_1particles.html#ad265a05b680753a20eba56b91f0eab45">pFlow::particles::mass</a></div><div class="ttdeci">auto &amp; mass()</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00192">particles.hpp:192</a></div></div>
@ -433,7 +433,7 @@ $(document).ready(function(){initNavTree('particles_8hpp_source.html',''); initR
<div class="ttc" id="aclasspFlow_1_1particles_html_a4c30ec373c9a8e5c48466560cb9c448b"><div class="ttname"><a href="classpFlow_1_1particles.html#a4c30ec373c9a8e5c48466560cb9c448b">pFlow::particles::pStruct</a></div><div class="ttdeci">auto &amp; pStruct()</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00122">particles.hpp:122</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_a2505bb9c917d337dddb089997023c0af"><div class="ttname"><a href="classpFlow_1_1particles.html#a2505bb9c917d337dddb089997023c0af">pFlow::particles::getFieldObjectList</a></div><div class="ttdeci">virtual uniquePtr&lt; List&lt; eventObserver * &gt; &gt; getFieldObjectList() const</div><div class="ttdef"><b>Definition:</b> <a href="particles_8cpp_source.html#l00183">particles.cpp:183</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_a10efdf47ffedbdc720f71c2f72b98d98"><div class="ttname"><a href="classpFlow_1_1particles.html#a10efdf47ffedbdc720f71c2f72b98d98">pFlow::particles::size</a></div><div class="ttdeci">auto size() const</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00126">particles.hpp:126</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dynamicPointStructure_html_a8c1e2c48f18f58f11c504050577f89f0"><div class="ttname"><a href="classpFlow_1_1dynamicPointStructure.html#a8c1e2c48f18f58f11c504050577f89f0">pFlow::dynamicPointStructure::pStruct</a></div><div class="ttdeci">pointStructure &amp; pStruct()</div><div class="ttdef"><b>Definition:</b> <a href="dynamicPointStructure_8hpp_source.html#l00088">dynamicPointStructure.hpp:88</a></div></div>
<div class="ttc" id="aclasspFlow_1_1dynamicPointStructure_html_a8c1e2c48f18f58f11c504050577f89f0"><div class="ttname"><a href="classpFlow_1_1dynamicPointStructure.html#a8c1e2c48f18f58f11c504050577f89f0">pFlow::dynamicPointStructure::pStruct</a></div><div class="ttdeci">pointStructure &amp; pStruct()</div><div class="ttdef"><b>Definition:</b> <a href="dynamicPointStructure_8hpp_source.html#l00077">dynamicPointStructure.hpp:77</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_a7699e422c8cc14e3ad75ed93ffc47b57"><div class="ttname"><a href="classpFlow_1_1particles.html#a7699e422c8cc14e3ad75ed93ffc47b57">pFlow::particles::contactTorque</a></div><div class="ttdeci">realx3PointField_D &amp; contactTorque()</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00217">particles.hpp:217</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_a0bfbc43a520897af519abd646bfd1266"><div class="ttname"><a href="classpFlow_1_1particles.html#a0bfbc43a520897af519abd646bfd1266">pFlow::particles::propertyId_</a></div><div class="ttdeci">int8PointField_D &amp; propertyId_</div><div class="ttdef"><b>Definition:</b> <a href="particles_8hpp_source.html#l00055">particles.hpp:55</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particles_html_a7c043d8a8c169debd35ac5afbce18fba"><div class="ttname"><a href="classpFlow_1_1particles.html#a7c043d8a8c169debd35ac5afbce18fba">pFlow::particles::insertParticles</a></div><div class="ttdeci">virtual bool insertParticles(const realx3Vector &amp;position, const wordVector &amp;shapes, const setFieldList &amp;setField)=0</div></div>