phasicFlow/doc/code-documentation/html/grainGranFlow_2createDEMCom...

251 lines
16 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<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 (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: solvers/grainGranFlow/createDEMComponents.hpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" >
<tbody>
<tr>
<td id="projectlogo"><a href="https://github.com/PhasicFlow"><img alt="Logo" src="phasicFlow_logo.png"></a></td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
<tr>
<td id="projectbrief">
<a href="https://https://cemf.ir">www.cemf.ir</a>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('grainGranFlow_2createDEMComponents_8hpp.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">createDEMComponents.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="grainGranFlow_2createDEMComponents_8hpp__dep__incl.png" border="0" usemap="#solvers_2grainGranFlow_2createDEMComponents_8hppdep" alt=""/></div>
</div>
</div>
<p><a href="grainGranFlow_2createDEMComponents_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a91970fa54ad14e3975c1e01d61c27882"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grainGranFlow_2createDEMComponents_8hpp.html#a91970fa54ad14e3975c1e01d61c27882">REPORT</a> (0)&lt;&lt;&quot;\nReading sphere particles . . .&quot;&lt;&lt; END_REPORT</td></tr>
<tr class="separator:a91970fa54ad14e3975c1e01d61c27882"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a952057fd993d1642ed6f0b49407c777f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1grainParticles.html">pFlow::grainParticles</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grainGranFlow_2createDEMComponents_8hpp.html#a952057fd993d1642ed6f0b49407c777f">grnParticles</a> (<a class="el" href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a>, <a class="el" href="setProperty_8hpp.html#ab0e7d0f9466a55a6fdb2417bc44ca707">proprties</a>)</td></tr>
<tr class="separator:a952057fd993d1642ed6f0b49407c777f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90df1e840f20b6442ad1f16f576e3080"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grainGranFlow_2createDEMComponents_8hpp.html#a90df1e840f20b6442ad1f16f576e3080">grnInsertion</a></td></tr>
<tr class="separator:a90df1e840f20b6442ad1f16f576e3080"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae407a77fb97d4e6375d136c1add58d21"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grainGranFlow_2createDEMComponents_8hpp.html#ae407a77fb97d4e6375d136c1add58d21">interactionPtr</a></td></tr>
<tr class="separator:ae407a77fb97d4e6375d136c1add58d21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03b3683bcf37b9897d181bf5e34be651"><td class="memItemLeft" align="right" valign="top">auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="grainGranFlow_2createDEMComponents_8hpp.html#a03b3683bcf37b9897d181bf5e34be651">grnInteraction</a> = <a class="el" href="sphereGranFlow_2createDEMComponents_8hpp.html#ae407a77fb97d4e6375d136c1add58d21">interactionPtr</a>()</td></tr>
<tr class="separator:a03b3683bcf37b9897d181bf5e34be651"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a91970fa54ad14e3975c1e01d61c27882"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91970fa54ad14e3975c1e01d61c27882">&#9670;&nbsp;</a></span>REPORT()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">REPORT </td>
<td>(</td>
<td class="paramtype">0&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a952057fd993d1642ed6f0b49407c777f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a952057fd993d1642ed6f0b49407c777f">&#9670;&nbsp;</a></span>grnParticles</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1grainParticles.html">pFlow::grainParticles</a> grnParticles(<a class="el" href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a>, <a class="el" href="setProperty_8hpp.html#ab0e7d0f9466a55a6fdb2417bc44ca707">proprties</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="periodicBoundaryGrainInteraction_8cpp_source.html#l00046">periodicBoundaryGrainInteraction&lt; contactForceModel, geometryMotionModel &gt;::grainGrainInteraction()</a>, and <a class="el" href="grainGranFlow_8cpp_source.html#l00054">main()</a>.</p>
</div>
</div>
<a id="a90df1e840f20b6442ad1f16f576e3080"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90df1e840f20b6442ad1f16f576e3080">&#9670;&nbsp;</a></span>grnInsertion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto grnInsertion</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <a class="code" href="namespacepFlow.html#a0594d23c332f8aa5c1fedbd42e9c932b">pFlow::grainInsertion</a>(</div>
<div class="line"> <a class="code" href="grainGranFlow_2createDEMComponents_8hpp.html#a952057fd993d1642ed6f0b49407c777f">grnParticles</a>, </div>
<div class="line"> <a class="code" href="grainGranFlow_2createDEMComponents_8hpp.html#a952057fd993d1642ed6f0b49407c777f">grnParticles</a>.<a class="code" href="classpFlow_1_1grainParticles.html#adc597aefab153f2441ee7d42b1de4db0">grains</a>())</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="grainGranFlow_2createDEMComponents_8hpp_source.html#l00039">39</a> of file <a class="el" href="grainGranFlow_2createDEMComponents_8hpp_source.html">createDEMComponents.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="grainGranFlow_8cpp_source.html#l00054">main()</a>.</p>
</div>
</div>
<a id="ae407a77fb97d4e6375d136c1add58d21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae407a77fb97d4e6375d136c1add58d21">&#9670;&nbsp;</a></span>interactionPtr</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto interactionPtr</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= <a class="code" href="classpFlow_1_1interaction.html#a4719440c5da75bf4bc6776501d106bf9">pFlow::interaction::create</a>(</div>
<div class="line"> <a class="code" href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a>,</div>
<div class="line"> <a class="code" href="grainGranFlow_2createDEMComponents_8hpp.html#a952057fd993d1642ed6f0b49407c777f">grnParticles</a>,</div>
<div class="line"> <a class="code" href="setSurfaceGeometry_8hpp.html#a195e279064ba2595c36f5f8d504822cb">surfGeometry</a></div>
<div class="line"> )</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="grainGranFlow_2createDEMComponents_8hpp_source.html#l00044">44</a> of file <a class="el" href="grainGranFlow_2createDEMComponents_8hpp_source.html">createDEMComponents.hpp</a>.</p>
</div>
</div>
<a id="a03b3683bcf37b9897d181bf5e34be651"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03b3683bcf37b9897d181bf5e34be651">&#9670;&nbsp;</a></span>grnInteraction</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">auto&amp; grnInteraction = <a class="el" href="sphereGranFlow_2createDEMComponents_8hpp.html#ae407a77fb97d4e6375d136c1add58d21">interactionPtr</a>()</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="grainGranFlow_2createDEMComponents_8hpp_source.html#l00050">50</a> of file <a class="el" href="grainGranFlow_2createDEMComponents_8hpp_source.html">createDEMComponents.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="grainGranFlow_8cpp_source.html#l00054">main()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="agrainGranFlow_2createDEMComponents_8hpp_html_a952057fd993d1642ed6f0b49407c777f"><div class="ttname"><a href="grainGranFlow_2createDEMComponents_8hpp.html#a952057fd993d1642ed6f0b49407c777f">grnParticles</a></div><div class="ttdeci">pFlow::grainParticles grnParticles(Control, proprties)</div></div>
<div class="ttc" id="aclasspFlow_1_1interaction_html_a4719440c5da75bf4bc6776501d106bf9"><div class="ttname"><a href="classpFlow_1_1interaction.html#a4719440c5da75bf4bc6776501d106bf9">pFlow::interaction::create</a></div><div class="ttdeci">static uniquePtr&lt; interaction &gt; create(systemControl &amp;control, const particles &amp;prtcl, const geometry &amp;geom)</div><div class="ttdef"><b>Definition:</b> <a href="interaction_8cpp_source.html#l00048">interaction.cpp:48</a></div></div>
<div class="ttc" id="asetSurfaceGeometry_8hpp_html_a195e279064ba2595c36f5f8d504822cb"><div class="ttname"><a href="setSurfaceGeometry_8hpp.html#a195e279064ba2595c36f5f8d504822cb">surfGeometry</a></div><div class="ttdeci">auto &amp; surfGeometry</div><div class="ttdef"><b>Definition:</b> <a href="setSurfaceGeometry_8hpp_source.html#l00026">setSurfaceGeometry.hpp:26</a></div></div>
<div class="ttc" id="aclasspFlow_1_1grainParticles_html_adc597aefab153f2441ee7d42b1de4db0"><div class="ttname"><a href="classpFlow_1_1grainParticles.html#adc597aefab153f2441ee7d42b1de4db0">pFlow::grainParticles::grains</a></div><div class="ttdeci">const auto &amp; grains() const</div><div class="ttdoc">const reference to shapes object</div><div class="ttdef"><b>Definition:</b> <a href="grainParticles_8hpp_source.html#l00147">grainParticles.hpp:147</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a0594d23c332f8aa5c1fedbd42e9c932b"><div class="ttname"><a href="namespacepFlow.html#a0594d23c332f8aa5c1fedbd42e9c932b">pFlow::grainInsertion</a></div><div class="ttdeci">Insertion&lt; grainShape &gt; grainInsertion</div><div class="ttdef"><b>Definition:</b> <a href="Insertions_8hpp_source.html#l00034">Insertions.hpp:34</a></div></div>
<div class="ttc" id="ainitialize__Control_8hpp_html_a4f5e4e852648762473ecd75a907417ca"><div class="ttname"><a href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a></div><div class="ttdeci">auto &amp; Control</div><div class="ttdef"><b>Definition:</b> <a href="initialize__Control_8hpp_source.html#l00047">initialize_Control.hpp:47</a></div></div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_65b24c28d0f232e494405d4f9f0c5236.html">solvers</a></li><li class="navelem"><a class="el" href="dir_f878b601cb94070fd337cd7cf0df761f.html">grainGranFlow</a></li><li class="navelem"><a class="el" href="grainGranFlow_2createDEMComponents_8hpp.html">createDEMComponents.hpp</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>