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

<!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: indexContainer&lt; IndexType &gt;::IndexAccessor&lt; ViewType &gt; Class Template 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('classpFlow_1_1indexContainer_1_1IndexAccessor.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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classpFlow_1_1indexContainer_1_1IndexAccessor-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">indexContainer&lt; IndexType &gt;::IndexAccessor&lt; ViewType &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Helper class for accessing index on host or device.
 <a href="classpFlow_1_1indexContainer_1_1IndexAccessor.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a351934fde32badb19e21dab839d7fc3d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1indexContainer_1_1IndexAccessor.html#a351934fde32badb19e21dab839d7fc3d">IndexAccessor</a> (ViewType v)</td></tr>
<tr class="separator:a351934fde32badb19e21dab839d7fc3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a724843fd87004eeb5bf788b03b23e518"><td class="memItemLeft" align="right" valign="top"><a class="el" href="pFlowMacros_8hpp.html#a8e2f73fa5c113f21c9c9edb67a974f5e">INLINE_FUNCTION_HD</a> IndexType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1indexContainer_1_1IndexAccessor.html#a724843fd87004eeb5bf788b03b23e518">operator()</a> (<a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> i) const</td></tr>
<tr class="separator:a724843fd87004eeb5bf788b03b23e518"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29636b87d7c459031e2410e5d7623b0f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1indexContainer_1_1IndexAccessor.html#a29636b87d7c459031e2410e5d7623b0f">size</a> () const</td></tr>
<tr class="separator:a29636b87d7c459031e2410e5d7623b0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ab70db270f1fd70ba39084a449b29bbd0"><td class="memItemLeft" align="right" valign="top">ViewType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1indexContainer_1_1IndexAccessor.html#ab70db270f1fd70ba39084a449b29bbd0">view_</a></td></tr>
<tr class="separator:ab70db270f1fd70ba39084a449b29bbd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename IndexType&gt;<br />
template&lt;typename ViewType&gt;<br />
class pFlow::indexContainer&lt; IndexType &gt;::IndexAccessor&lt; ViewType &gt;</h3>

<p>Helper class for accessing index on host or device. </p>

<p class="definition">Definition at line <a class="el" href="indexContainer_8hpp_source.html#l00060">60</a> of file <a class="el" href="indexContainer_8hpp_source.html">indexContainer.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a351934fde32badb19e21dab839d7fc3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a351934fde32badb19e21dab839d7fc3d">&#9670;&nbsp;</a></span>IndexAccessor()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classpFlow_1_1indexContainer_1_1IndexAccessor.html">IndexAccessor</a> </td>
          <td>(</td>
          <td class="paramtype">ViewType&#160;</td>
          <td class="paramname"><em>v</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="indexContainer_8hpp_source.html#l00066">66</a> of file <a class="el" href="indexContainer_8hpp_source.html">indexContainer.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a724843fd87004eeb5bf788b03b23e518"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a724843fd87004eeb5bf788b03b23e518">&#9670;&nbsp;</a></span>operator()()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="pFlowMacros_8hpp.html#a8e2f73fa5c113f21c9c9edb67a974f5e">INLINE_FUNCTION_HD</a> IndexType operator() </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td>
          <td class="paramname"><em>i</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="indexContainer_8hpp_source.html#l00070">70</a> of file <a class="el" href="indexContainer_8hpp_source.html">indexContainer.hpp</a>.</p>

<p class="reference">References <a class="el" href="indexContainer_8hpp_source.html#l00063">indexContainer&lt; IndexType &gt;::IndexAccessor&lt; ViewType &gt;::view_</a>.</p>

</div>
</div>
<a id="a29636b87d7c459031e2410e5d7623b0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29636b87d7c459031e2410e5d7623b0f">&#9670;&nbsp;</a></span>size()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> size </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="indexContainer_8hpp_source.html#l00075">75</a> of file <a class="el" href="indexContainer_8hpp_source.html">indexContainer.hpp</a>.</p>

<p class="reference">References <a class="el" href="indexContainer_8hpp_source.html#l00063">indexContainer&lt; IndexType &gt;::IndexAccessor&lt; ViewType &gt;::view_</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab70db270f1fd70ba39084a449b29bbd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab70db270f1fd70ba39084a449b29bbd0">&#9670;&nbsp;</a></span>view_</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ViewType view_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="indexContainer_8hpp_source.html#l00063">63</a> of file <a class="el" href="indexContainer_8hpp_source.html">indexContainer.hpp</a>.</p>

<p class="reference">Referenced by <a class="el" href="indexContainer_8hpp_source.html#l00070">indexContainer&lt; IndexType &gt;::IndexAccessor&lt; ViewType &gt;::operator()()</a>, and <a class="el" href="indexContainer_8hpp_source.html#l00075">indexContainer&lt; IndexType &gt;::IndexAccessor&lt; ViewType &gt;::size()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/phasicFlow/containers/indexContainer/<a class="el" href="indexContainer_8hpp_source.html">indexContainer.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespacepFlow.html">pFlow</a></li><li class="navelem"><a class="el" href="classpFlow_1_1indexContainer.html">indexContainer</a></li><li class="navelem"><a class="el" href="classpFlow_1_1indexContainer_1_1IndexAccessor.html">IndexAccessor</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>