<area href="classvoro_1_1c__loop__all.html" title="Class for looping over all of the particles in a container." alt="voro::c_loop_all" shape="rect" coords="0,56,173,80"/>
<area href="classvoro_1_1c__loop__all__periodic.html" title="A class for looping over all particles in a container_periodic or container_periodic_poly class..." alt="voro::c_loop_all_periodic" shape="rect" coords="183,56,356,80"/>
<area href="classvoro_1_1c__loop__order.html" title="Class for looping over all of the particles specified in a pre-assembled particle_order class..." alt="voro::c_loop_order" shape="rect" coords="366,56,539,80"/>
<area href="classvoro_1_1c__loop__order__periodic.html" title="Class for looping over all of the particles specified in a pre-assembled particle_order class..." alt="voro::c_loop_order_periodic" shape="rect" coords="549,56,722,80"/>
<area href="classvoro_1_1c__loop__subset.html" title="Class for looping over a subset of particles in a container." alt="voro::c_loop_subset" shape="rect" coords="732,56,905,80"/>
<div class="textblock"><p>This class forms the base of all classes that can loop over a subset of particles in a contaner in some order. When initialized, it stores constants about the corresponding container geometry. It also contains a number of routines for interrogating which particle currently being considered by the loop, which are common between all of the derived classes. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00078">78</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<p>The constructor copies several necessary constants from the base container class. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">con</td><td>the container class to use. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00124">124</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>Returns the ID of the particle currently being considered by the loop. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00158">158</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>Returns the position vector of the particle currently being considered by the loop. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">(x,y,z)</td><td>the position vector of the particle. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00130">130</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<tr><td class="paramdir">[out]</td><td class="paramname">(x,y,z)</td><td>the position vector of the particle. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">r</td><td>the radius of the particle. If no radius information is available the default radius value is returned. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00141">141</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>Returns the x position of the particle currently being considered by the loop. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00149">149</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>Returns the y position of the particle currently being considered by the loop. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00152">152</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>Returns the z position of the particle currently being considered by the loop. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00155">155</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>A pointer to the particle counts in the associated container data structure. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00104">104</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>The current x-index of the block under consideration by the loop. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00107">107</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>A pointer to the particle ID information in the associated container data structure. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00101">101</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>The current index of the block under consideration by the loop. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00116">116</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>The current y-index of the block under consideration by the loop. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00110">110</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>The current z-index of the block under consideration by the loop. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00113">113</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<td class="memname">const int voro::c_loop_base::nx</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of blocks in the x direction. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00081">81</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<td class="memname">const int voro::c_loop_base::nxy</td>
</tr>
</table>
</div><div class="memdoc">
<p>A constant, set to the value of nx multiplied by ny, which is used in the routines that step through blocks in sequence. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00089">89</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<td class="memname">const int voro::c_loop_base::nxyz</td>
</tr>
</table>
</div><div class="memdoc">
<p>A constant, set to the value of nx*ny*nz, which is used in the routines that step through blocks in sequence. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00092">92</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<td class="memname">const int voro::c_loop_base::ny</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of blocks in the y direction. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00083">83</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<td class="memname">const int voro::c_loop_base::nz</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of blocks in the z direction. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00085">85</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>A pointer to the particle position information in the associated container data structure. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00098">98</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<td class="memname">const int voro::c_loop_base::ps</td>
</tr>
</table>
</div><div class="memdoc">
<p>The number of floating point numbers per particle in the associated container data structure. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00095">95</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>The index of the particle under consideration within the current block. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00119">119</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>