<areahref="classvoro_1_1pre__container.html"title="A class for storing an arbitrary number of particles without radius information, prior to setting up ..."alt="voro::pre_container"shape="rect"coords="0,56,157,80"/>
<areahref="classvoro_1_1pre__container__poly.html"title="A class for storing an arbitrary number of particles with radius information, prior to setting up a c..."alt="voro::pre_container_poly"shape="rect"coords="167,56,324,80"/>
<trclass="memitem:a8e1fcadbeedc63f205a36c2fa9333ab6"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1pre__container__base.html#a8e1fcadbeedc63f205a36c2fa9333ab6">guess_optimal</a> (int &nx, int &ny, int &nz)</td></tr>
<divclass="textblock"><p>The <aclass="el"href="classvoro_1_1pre__container__base.html"title="A class for storing an arbitrary number of particles, prior to setting up a container geometry...">pre_container_base</a> class can dynamically import and store an arbitrary number of particles. Once the particles have been read in, an appropriate container class can be set up with the optimal grid size, and the particles can be transferred.</p>
<p>The <aclass="el"href="classvoro_1_1pre__container__base.html"title="A class for storing an arbitrary number of particles, prior to setting up a container geometry...">pre_container_base</a> class is not intended for direct use, but forms the base of the <aclass="el"href="classvoro_1_1pre__container.html"title="A class for storing an arbitrary number of particles without radius information, prior to setting up ...">pre_container</a> and <aclass="el"href="classvoro_1_1pre__container__poly.html"title="A class for storing an arbitrary number of particles with radius information, prior to setting up a c...">pre_container_poly</a> classes, that add routines depending on whether particle radii need to be tracked or not. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00031">31</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<p>The class constructor sets up the geometry of container, initializing the minimum and maximum coordinates in each direction. It allocates an initial chunk into which to store particle information. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(ax_,bx_)</td><td>the minimum and maximum x coordinates. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(ay_,by_)</td><td>the minimum and maximum y coordinates. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(az_,bz_)</td><td>the minimum and maximum z coordinates. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(xperiodic_,yperiodic_,zperiodic_</td><td>) flags setting whether the container is periodic in each coordinate direction. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">ps_</td><td>the number of floating point entries to store for each particle. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="pre__container_8cc_source.html#l00029">29</a> of file <aclass="el"href="pre__container_8cc_source.html">pre_container.cc</a>.</p>
<p>The destructor frees the dynamically allocated memory. </p>
<p>Definition at line <aclass="el"href="pre__container_8cc_source.html#l00041">41</a> of file <aclass="el"href="pre__container_8cc_source.html">pre_container.cc</a>.</p>
<p>Definition at line <aclass="el"href="pre__container_8cc_source.html#l00219">219</a> of file <aclass="el"href="pre__container_8cc_source.html">pre_container.cc</a>.</p>
<p>Makes a guess at the optimal grid of blocks to use, computing in a way that </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">(nx,ny,nz)</td><td>the number of blocks to use. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="pre__container_8cc_source.html#l00057">57</a> of file <aclass="el"href="pre__container_8cc_source.html">pre_container.cc</a>.</p>
<p>Allocates a new chunk of memory for storing particles. </p>
<p>Definition at line <aclass="el"href="pre__container_8cc_source.html#l00210">210</a> of file <aclass="el"href="pre__container_8cc_source.html">pre_container.cc</a>.</p>
<p>Calculates and returns the total number of particles stored within the class. </p>
<dlclass="section return"><dt>Returns:</dt><dd>The number of particles. </dd></dl>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00060">60</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>The minimum x coordinate of the container. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00034">34</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>The minimum y coordinate of the container. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00038">38</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>The minimum z coordinate of the container. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00042">42</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>The maximum x coordinate of the container. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00036">36</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>The maximum y coordinate of the container. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00040">40</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>The maximum z coordinate of the container. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00044">44</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>A pointer to the next available slot on the current particle ID chunk. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00082">82</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>A pointer to the next available slot on the current floating point chunk. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00093">93</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>A pointer to the end of the current integer chunk. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00084">84</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>A pointer to the last allocated integer ID chunk. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00076">76</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>A pointer to the last allocated chunk of floating point information. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00090">90</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00071">71</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>A pointer to the end of the integer ID chunk index, used to determine when the chunk index is full. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00079">79</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>A pointer to the chunk index to store the integer particle IDs. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00074">74</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>A pointer to the chunk index to store the floating point information associated with particles. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00087">87</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>The number of doubles associated with a single particle (three for the standard container, four when radius information is stored). </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00067">67</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>A boolean value that determines if the x coordinate in periodic or not. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00047">47</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>A boolean value that determines if the y coordinate in periodic or not. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00050">50</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
<p>A boolean value that determines if the z coordinate in periodic or not. </p>
<p>Definition at line <aclass="el"href="pre__container_8hh_source.html#l00053">53</a> of file <aclass="el"href="pre__container_8hh_source.html">pre_container.hh</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>