<area href="classvoro_1_1container__base.html" title="Class for representing a particle system in a three-dimensional rectangular box." alt="voro::container_base" shape="rect" coords="97,56,281,80"/>
<area href="classvoro_1_1container__periodic__base.html" title="Class for representing a particle system in a 3D periodic non-orthogonal periodic domain..." alt="voro::container_periodic_base" shape="rect" coords="485,56,669,80"/>
<area href="classvoro_1_1container.html" title="Extension of the container_base class for computing regular Voronoi tessellations." alt="voro::container" shape="rect" coords="0,112,184,136"/>
<area href="classvoro_1_1container__poly.html" title="Extension of the container_base class for computing radical Voronoi tessellations." alt="voro::container_poly" shape="rect" coords="194,112,378,136"/>
<area href="classvoro_1_1container__periodic.html" title="Extension of the container_periodic_base class for computing regular Voronoi tessellations." alt="voro::container_periodic" shape="rect" coords="388,112,572,136"/>
<area href="classvoro_1_1container__periodic__poly.html" title="Extension of the container_periodic_base class for computing radical Voronoi tessellations." alt="voro::container_periodic_poly" shape="rect" coords="582,112,766,136"/>
<div class="textblock"><p>This class contains constants and data structures that are common across all particle container classes. It contains constants setting the size of the underlying subgrid of blocks that forms the basis of the Voronoi cell computations. It also constructs bound tables that are used in the Voronoi cell computation, and contains a number of routines that are common across all container classes. </p>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00025">25</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<p>This function is called during container construction. The routine scans all of the worklists in the wl[] array. For a given worklist of blocks labeled <img class="formulaInl" alt="$w_1$" src="form_1.png"/> to <img class="formulaInl" alt="$w_n$" src="form_2.png"/>, it computes a sequence <img class="formulaInl" alt="$r_0$" src="form_3.png"/> to <img class="formulaInl" alt="$r_n$" src="form_4.png"/> so that $r_i$ is the minimum distance to all the blocks <img class="formulaInl" alt="$w_{j}$" src="form_5.png"/> where <img class="formulaInl" alt="$j>i$" src="form_6.png"/> and all blocks outside the worklist. The values of <img class="formulaInl" alt="$r_n$" src="form_4.png"/> is calculated first, as the minimum distance to any block in the shell surrounding the worklist. The <img class="formulaInl" alt="$r_i$" src="form_7.png"/> are then computed in reverse order by considering the distance to <img class="formulaInl" alt="$w_{i+1}$" src="form_8.png"/>. </p>
<p>Definition at line <a class="el" href="v__base_8cc_source.html#l00023">23</a> of file <a class="el" href="v__base_8cc_source.html">v_base.cc</a>.</p>
<p>Checks to see whether "%n" appears in a format sequence to determine whether neighbor information is required or not. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>the format string to check. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>True if a "%n" is found, false otherwise. </dd></dl>
<p>Definition at line <a class="el" href="v__base_8cc_source.html#l00100">100</a> of file <a class="el" href="v__base_8cc_source.html">v_base.cc</a>.</p>
<p>A custom integer division function that returns consistent stepping for negative numbers. For example, (-2,-1,0,1,2) step_div 2 is (-1,-1,0,0,1). </p>
<dl class="section return"><dt>Returns:</dt><dd>The value of a div b, consistent for negative numbers. </dd></dl>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00081">81</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<p>A custom int function that returns consistent stepping for negative numbers, so that (-1.5, -0.5, 0.5, 1.5) maps to (-2,-1,0,1). </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">a</td><td>the number to consider. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>The value of the custom int operation. </dd></dl>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00067">67</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<dl class="section return"><dt>Returns:</dt><dd>The value of a modulo b, consistent for negative numbers. </dd></dl>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00074">74</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<p>The size of a computational block in the x direction. </p>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00041">41</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<p>The size of a computational block in the y direction. </p>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00043">43</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<p>The size of a computational block in the z direction. </p>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00045">45</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<p>An array to hold the minimum distances associated with the worklists. This array is initialized during container construction, by the initialize_radii() routine. </p>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00055">55</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<td class="memname">const int voro::voro_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="v__base_8hh_source.html#l00028">28</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<td class="memname">const int voro::voro_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="v__base_8hh_source.html#l00036">36</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<td class="memname">const int voro::voro_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="v__base_8hh_source.html#l00039">39</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<td class="memname">const int voro::voro_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="v__base_8hh_source.html#l00030">30</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<td class="memname">const int voro::voro_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="v__base_8hh_source.html#l00032">32</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00057">57</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<p>The inverse box length in the x direction. </p>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00047">47</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<p>The inverse box length in the y direction. </p>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00049">49</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
<p>The inverse box length in the z direction. </p>
<p>Definition at line <a class="el" href="v__base_8hh_source.html#l00051">51</a> of file <a class="el" href="v__base_8hh_source.html">v_base.hh</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>