<area href="classvoro_1_1c__loop__base.html" title="Base class for looping over particles in a container." alt="voro::c_loop_base" shape="rect" coords="0,0,125,24"/>
<tr class="memitem:a688ef02340f6a9bc64c77c2de4c4ae3d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classvoro_1_1c__loop__subset.html#a688ef02340f6a9bc64c77c2de4c4ae3d">setup_intbox</a> (int ai_, int bi_, int aj_, int bj_, int ak_, int bk_)</td></tr>
<div class="textblock"><p>This class can loop over a subset of particles in a certain geometrical region within the container. The class can be set up to loop over a rectangular box or sphere. It can also rectangular group of internal computational blocks. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00218">218</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#l00228">228</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<dl class="section return"><dt>Returns:</dt><dd>True if there is another particle, false if no more particles are available. </dd></dl>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00238">238</a> of file <a class="el" href="c__loops_8hh_source.html">c_loops.hh</a>.</p>
<p>Initializes the class to loop over all particles in a rectangular box. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">(xmin,xmax)</td><td>the minimum and maximum x coordinates of the box. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">(ymin,ymax)</td><td>the minimum and maximum y coordinates of the box. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">(zmin,zmax)</td><td>the minimum and maximum z coordinates of the box. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bounds_test</td><td>whether to do detailed bounds checking. If this is false then the class will loop over all particles in blocks that overlap the given box. If it is true, the particle will only loop over the particles which actually lie within the box. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>True if there is any valid point to loop over, false otherwise. </dd></dl>
<p>Definition at line <a class="el" href="c__loops_8cc_source.html#l00098">98</a> of file <a class="el" href="c__loops_8cc_source.html">c_loops.cc</a>.</p>
<p>Initializes the class to loop over all particles in a rectangular subgrid of blocks. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">(ai_,bi_)</td><td>the subgrid range in the x-direction, inclusive of both ends. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">(aj_,bj_)</td><td>the subgrid range in the y-direction, inclusive of both ends. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">(ak_,bk_)</td><td>the subgrid range in the z-direction, inclusive of both ends. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>True if there is any valid point to loop over, false otherwise. </dd></dl>
<p>Definition at line <a class="el" href="c__loops_8cc_source.html#l00044">44</a> of file <a class="el" href="c__loops_8cc_source.html">c_loops.cc</a>.</p>
<p>Initializes a <a class="el" href="classvoro_1_1c__loop__subset.html" title="Class for looping over a subset of particles in a container.">c_loop_subset</a> object to scan over all particles within a given sphere. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">(vx,vy,vz)</td><td>the position vector of the center of the sphere. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">r</td><td>the radius of the sphere. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bounds_test</td><td>whether to do detailed bounds checking. If this is false then the class will loop over all particles in blocks that overlap the given sphere. If it is true, the particle will only loop over the particles which actually lie within the sphere. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>True if there is any valid point to loop over, false otherwise. </dd></dl>
<p>Definition at line <a class="el" href="c__loops_8cc_source.html#l00024">24</a> of file <a class="el" href="c__loops_8cc_source.html">c_loops.cc</a>.</p>
<p>Starts the loop by finding the first particle within the container to consider. </p>
<dl class="section return"><dt>Returns:</dt><dd>True if there is any particle to consider, false otherwise. </dd></dl>
<p>Definition at line <a class="el" href="c__loops_8cc_source.html#l00079">79</a> of file <a class="el" href="c__loops_8cc_source.html">c_loops.cc</a>.</p>
<p>The current mode of operation, determining whether tests should be applied to particles to ensure they are within a certain geometrical object. </p>
<p>Definition at line <a class="el" href="c__loops_8hh_source.html#l00223">223</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 files:<ul>