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

200 lines
22 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: src/Particles/particles/regularParticleIdHandler/regularParticleIdHandler.hpp Source File</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('regularParticleIdHandler_8hpp_source.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="headertitle">
<div class="title">regularParticleIdHandler.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="regularParticleIdHandler_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*------------------------------- phasicFlow ---------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> O C enter of</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> O O E ngineering and</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> O O M ultiscale modeling of</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> OOOOOOO F luid flow </span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> Copyright (C): www.cemf.ir</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> email: hamid.r.norouzi AT gmail.com</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">------------------------------------------------------------------------------ </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">Licence:</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> This file is part of phasicFlow code. It is a free software for simulating </span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> granular and multiphase flows. You can redistribute it and/or modify it under</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> the terms of GNU General Public License v3 or any other later versions. </span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> phasicFlow is distributed to help others in their research in the field of </span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> granular and multiphase flows, but WITHOUT ANY WARRANTY; without even the</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">-----------------------------------------------------------------------------*/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef __regularParticleIdHandler_hpp__</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define __regularParticleIdHandler_hpp__</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="particleIdHandler_8hpp.html">particleIdHandler.hpp</a>&quot;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacepFlow.html">pFlow</a></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classpFlow_1_1regularParticleIdHandler.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classpFlow_1_1regularParticleIdHandler.html">regularParticleIdHandler</a></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;:</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">public</span> <a class="code" href="classpFlow_1_1particleIdHandler.html">particleIdHandler</a></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classpFlow_1_1regularParticleIdHandler.html#ad7a7008edc49848ff59143b30aaaadc0"> 34</a></span>&#160; <a class="code" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> <a class="code" href="classpFlow_1_1regularParticleIdHandler.html#ad7a7008edc49848ff59143b30aaaadc0">maxId_</a> = <span class="keyword">static_cast&lt;</span><a class="code" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a><span class="keyword">&gt;</span>(-1);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1regularParticleIdHandler.html#af180a3c66359a3c4f85eabe80e953ebd">initialIdCheck</a>()<span class="keyword">override</span>; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="classpFlow_1_1regularParticleIdHandler.html#af653fd326b3ef15a633e6dea84a97a48">ClassInfo</a>(<span class="stringliteral">&quot;particleIdHandler&lt;regular&gt;&quot;</span>);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classpFlow_1_1regularParticleIdHandler.html#ad227f2703bc03d7f14ce3e67728044a3">regularParticleIdHandler</a>(<a class="code" href="classpFlow_1_1pointStructure.html">pointStructure</a>&amp; <a class="code" href="classpFlow_1_1pointField.html#af594ba73474d415474d32afc783799b1">pStruct</a>);</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="classpFlow_1_1regularParticleIdHandler.html#aa4ec77be2f828b064eb78d6d91593bd0">~regularParticleIdHandler</a>()<span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <a class="code" href="classpFlow_1_1regularParticleIdHandler.html#aa1d27b1f9c774c3ecb682aad11bdffc5">add_vCtor</a></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; (</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="classpFlow_1_1particleIdHandler.html">particleIdHandler</a>,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="classpFlow_1_1regularParticleIdHandler.html">regularParticleIdHandler</a>,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="classpFlow_1_1pointStructure.html">pointStructure</a></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; );</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="namespacepFlow.html#a5b353480033e53f7e1fd71c6328b7fc5">Pair&lt;uint32, uint32&gt;</a> <a class="code" href="classpFlow_1_1regularParticleIdHandler.html#ab494b5127808fda7af5306145a2e251f">getIdRange</a>(<a class="code" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> nNewParticles)<span class="keyword">override</span>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classpFlow_1_1regularParticleIdHandler.html#acd13fedd8424e967f8b3144af1af11b8"> 54</a></span>&#160; <a class="code" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> <a class="code" href="classpFlow_1_1regularParticleIdHandler.html#acd13fedd8424e967f8b3144af1af11b8">maxId</a>()<span class="keyword">const override</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classpFlow_1_1regularParticleIdHandler.html#ad7a7008edc49848ff59143b30aaaadc0">maxId_</a>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;};</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor">#endif //__regularParticleIdHandler_hpp__</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasspFlow_1_1regularParticleIdHandler_html_ad227f2703bc03d7f14ce3e67728044a3"><div class="ttname"><a href="classpFlow_1_1regularParticleIdHandler.html#ad227f2703bc03d7f14ce3e67728044a3">pFlow::regularParticleIdHandler::regularParticleIdHandler</a></div><div class="ttdeci">regularParticleIdHandler(pointStructure &amp;pStruct)</div><div class="ttdef"><b>Definition:</b> <a href="regularParticleIdHandler_8cpp_source.html#l00006">regularParticleIdHandler.cpp:6</a></div></div>
<div class="ttc" id="aclasspFlow_1_1regularParticleIdHandler_html"><div class="ttname"><a href="classpFlow_1_1regularParticleIdHandler.html">pFlow::regularParticleIdHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="regularParticleIdHandler_8hpp_source.html#l00028">regularParticleIdHandler.hpp:28</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a5b353480033e53f7e1fd71c6328b7fc5"><div class="ttname"><a href="namespacepFlow.html#a5b353480033e53f7e1fd71c6328b7fc5">pFlow::Pair</a></div><div class="ttdeci">Kokkos::pair&lt; T1, T2 &gt; Pair</div><div class="ttdoc">Pair of two variables.</div><div class="ttdef"><b>Definition:</b> <a href="KokkosTypes_8hpp_source.html#l00085">KokkosTypes.hpp:85</a></div></div>
<div class="ttc" id="aclasspFlow_1_1regularParticleIdHandler_html_af653fd326b3ef15a633e6dea84a97a48"><div class="ttname"><a href="classpFlow_1_1regularParticleIdHandler.html#af653fd326b3ef15a633e6dea84a97a48">pFlow::regularParticleIdHandler::ClassInfo</a></div><div class="ttdeci">ClassInfo(&quot;particleIdHandler&lt;regular&gt;&quot;)</div></div>
<div class="ttc" id="aclasspFlow_1_1pointField_html_af594ba73474d415474d32afc783799b1"><div class="ttname"><a href="classpFlow_1_1pointField.html#af594ba73474d415474d32afc783799b1">pFlow::pointField::pStruct</a></div><div class="ttdeci">const pointStructure &amp; pStruct() const</div><div class="ttdef"><b>Definition:</b> <a href="pointField_8hpp_source.html#l00134">pointField.hpp:134</a></div></div>
<div class="ttc" id="anamespacepFlow_html_abd01e8e67e3d94cab04ecaaf4f85ac1b"><div class="ttname"><a href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">pFlow::uint32</a></div><div class="ttdeci">unsigned int uint32</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00056">builtinTypes.hpp:56</a></div></div>
<div class="ttc" id="aclasspFlow_1_1particleIdHandler_html"><div class="ttname"><a href="classpFlow_1_1particleIdHandler.html">pFlow::particleIdHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="particleIdHandler_8hpp_source.html#l00030">particleIdHandler.hpp:30</a></div></div>
<div class="ttc" id="aclasspFlow_1_1regularParticleIdHandler_html_af180a3c66359a3c4f85eabe80e953ebd"><div class="ttname"><a href="classpFlow_1_1regularParticleIdHandler.html#af180a3c66359a3c4f85eabe80e953ebd">pFlow::regularParticleIdHandler::initialIdCheck</a></div><div class="ttdeci">bool initialIdCheck() override</div><div class="ttdef"><b>Definition:</b> <a href="regularParticleIdHandler_8cpp_source.html#l00035">regularParticleIdHandler.cpp:35</a></div></div>
<div class="ttc" id="aclasspFlow_1_1regularParticleIdHandler_html_ab494b5127808fda7af5306145a2e251f"><div class="ttname"><a href="classpFlow_1_1regularParticleIdHandler.html#ab494b5127808fda7af5306145a2e251f">pFlow::regularParticleIdHandler::getIdRange</a></div><div class="ttdeci">Pair&lt; uint32, uint32 &gt; getIdRange(uint32 nNewParticles) override</div><div class="ttdef"><b>Definition:</b> <a href="regularParticleIdHandler_8cpp_source.html#l00016">regularParticleIdHandler.cpp:16</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="demGeometry_8hpp_source.html#l00027">demGeometry.hpp:27</a></div></div>
<div class="ttc" id="aclasspFlow_1_1regularParticleIdHandler_html_ad7a7008edc49848ff59143b30aaaadc0"><div class="ttname"><a href="classpFlow_1_1regularParticleIdHandler.html#ad7a7008edc49848ff59143b30aaaadc0">pFlow::regularParticleIdHandler::maxId_</a></div><div class="ttdeci">uint32 maxId_</div><div class="ttdef"><b>Definition:</b> <a href="regularParticleIdHandler_8hpp_source.html#l00034">regularParticleIdHandler.hpp:34</a></div></div>
<div class="ttc" id="aclasspFlow_1_1regularParticleIdHandler_html_aa1d27b1f9c774c3ecb682aad11bdffc5"><div class="ttname"><a href="classpFlow_1_1regularParticleIdHandler.html#aa1d27b1f9c774c3ecb682aad11bdffc5">pFlow::regularParticleIdHandler::add_vCtor</a></div><div class="ttdeci">add_vCtor(particleIdHandler, regularParticleIdHandler, pointStructure)</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#l00034">pointStructure.hpp:34</a></div></div>
<div class="ttc" id="aclasspFlow_1_1regularParticleIdHandler_html_aa4ec77be2f828b064eb78d6d91593bd0"><div class="ttname"><a href="classpFlow_1_1regularParticleIdHandler.html#aa4ec77be2f828b064eb78d6d91593bd0">pFlow::regularParticleIdHandler::~regularParticleIdHandler</a></div><div class="ttdeci">~regularParticleIdHandler() override=default</div></div>
<div class="ttc" id="aclasspFlow_1_1regularParticleIdHandler_html_acd13fedd8424e967f8b3144af1af11b8"><div class="ttname"><a href="classpFlow_1_1regularParticleIdHandler.html#acd13fedd8424e967f8b3144af1af11b8">pFlow::regularParticleIdHandler::maxId</a></div><div class="ttdeci">uint32 maxId() const override</div><div class="ttdef"><b>Definition:</b> <a href="regularParticleIdHandler_8hpp_source.html#l00054">regularParticleIdHandler.hpp:54</a></div></div>
<div class="ttc" id="aparticleIdHandler_8hpp_html"><div class="ttname"><a href="particleIdHandler_8hpp.html">particleIdHandler.hpp</a></div></div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_9e72493e858003bd3d74a55a2aedd075.html">Particles</a></li><li class="navelem"><a class="el" href="dir_b351bcc3c60d144476bd2e30437abfde.html">particles</a></li><li class="navelem"><a class="el" href="dir_4ed8f90d575c23a2838162252cb36468.html">regularParticleIdHandler</a></li><li class="navelem"><a class="el" href="regularParticleIdHandler_8hpp.html">regularParticleIdHandler.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>