<ahref="#pub-methods">Public Member Functions</a>|
<ahref="#friends">Friends</a></div>
<divclass="headertitle">
<divclass="title">voro::container_periodic Class Reference</div></div>
</div><!--header-->
<divclass="contents">
<p>Extension of the <aclass="el"href="classvoro_1_1container__periodic__base.html"title="Class for representing a particle system in a 3D periodic non-orthogonal periodic domain...">container_periodic_base</a> class for computing regular Voronoi tessellations.
<areahref="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="97,56,281,80"/>
<areahref="classvoro_1_1radius__mono.html"title="Class containing all of the routines that are specific to computing the regular Voronoi tessellation..."alt="voro::radius_mono"shape="rect"coords="291,56,475,80"/>
<areahref="classvoro_1_1unitcell.html"title="Class for computation of the unit Voronoi cell associated with a 3D non-rectangular periodic domain..."alt="voro::unitcell"shape="rect"coords="0,0,184,24"/>
<areahref="classvoro_1_1voro__base.html"title="Class containing data structures common across all particle container classes."alt="voro::voro_base"shape="rect"coords="194,0,378,24"/>
<trclass="memitem:afa9abf680a0dc08650ada11a2eff0be6"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic.html#afa9abf680a0dc08650ada11a2eff0be6">put</a> (int n, double x, double y, double z)</td></tr>
<trclass="memitem:a354f707360a7e51a56de2eafc10cb43f"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic.html#a354f707360a7e51a56de2eafc10cb43f">put</a> (int n, double x, double y, double z, int &ai, int &aj, int &ak)</td></tr>
<trclass="memitem:ad3987d5710d793bdd604f12eeaa326f0"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic.html#ad3987d5710d793bdd604f12eeaa326f0">put</a> (<aclass="el"href="classvoro_1_1particle__order.html">particle_order</a>&vo, int n, double x, double y, double z)</td></tr>
<trclass="memitem:a5ed9e19316148b6af242887ccc8ccf60"><tdclass="memTemplItemLeft"align="right"valign="top">bool </td><tdclass="memTemplItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic.html#a5ed9e19316148b6af242887ccc8ccf60">compute_cell</a> (v_cell &c, int ijk, int q)</td></tr>
<trclass="inherit_header pub_methods_classvoro_1_1container__periodic__base"><tdcolspan="2"onclick="javascript:toggleInherit('pub_methods_classvoro_1_1container__periodic__base')"><imgsrc="closed.png"alt="-"/> Public Member Functions inherited from <aclass="el"href="classvoro_1_1container__periodic__base.html">voro::container_periodic_base</a></td></tr>
<trclass="memitem:a5319c976a873f9b10f80f9038f3460bd inherit pub_methods_classvoro_1_1container__periodic__base"><tdclass="memItemLeft"align="right"valign="top"> </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic__base.html#a5319c976a873f9b10f80f9038f3460bd">container_periodic_base</a> (double bx_, double bxy_, double by_, double bxz_, double byz_, double bz_, int nx_, int ny_, int nz_, int init_mem_, int <aclass="el"href="classvoro_1_1container__periodic__base.html#a5213538964cf869c9751a27bccaf323e">ps</a>)</td></tr>
<trclass="memitem:ae540389dc8845562c5f8cd45cec71edd"><tdclass="memTemplItemLeft"align="right"valign="top">bool </td><tdclass="memTemplItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic__base.html#ae540389dc8845562c5f8cd45cec71edd">initialize_voronoicell</a> (v_cell &c, int ijk, int q, int ci, int cj, int ck, int &i, int &j, int &k, double &x, double &y, double &z, int &disp)</td></tr>
<trclass="memitem:a812ed5572fcfece48b73517fcf913ec0 inherit pub_methods_classvoro_1_1container__periodic__base"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic__base.html#a812ed5572fcfece48b73517fcf913ec0">initialize_search</a> (int ci, int cj, int ck, int ijk, int &i, int &j, int &k, int &disp)</td></tr>
<trclass="memitem:aa0cd2a5bf51968b7af3334f4bbb8df8e inherit pub_methods_classvoro_1_1container__periodic__base"><tdclass="memItemLeft"align="right"valign="top">int </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic__base.html#aa0cd2a5bf51968b7af3334f4bbb8df8e">region_index</a> (int ci, int cj, int ck, int ei, int ej, int ek, double &qx, double &qy, double &qz, int &disp)</td></tr>
<trclass="inherit_header pub_methods_classvoro_1_1unitcell"><tdcolspan="2"onclick="javascript:toggleInherit('pub_methods_classvoro_1_1unitcell')"><imgsrc="closed.png"alt="-"/> Public Member Functions inherited from <aclass="el"href="classvoro_1_1unitcell.html">voro::unitcell</a></td></tr>
<trclass="memitem:a15d4e5b0f906bba383b27d38497ec68d inherit pub_methods_classvoro_1_1unitcell"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1unitcell.html#a15d4e5b0f906bba383b27d38497ec68d">images</a> (std::vector< int >&vi, std::vector< double >&vd)</td></tr>
<trclass="inherit_header pub_methods_classvoro_1_1voro__base"><tdcolspan="2"onclick="javascript:toggleInherit('pub_methods_classvoro_1_1voro__base')"><imgsrc="closed.png"alt="-"/> Public Member Functions inherited from <aclass="el"href="classvoro_1_1voro__base.html">voro::voro_base</a></td></tr>
<trclass="inherit_header pro_methods_classvoro_1_1container__periodic__base"><tdcolspan="2"onclick="javascript:toggleInherit('pro_methods_classvoro_1_1container__periodic__base')"><imgsrc="closed.png"alt="-"/> Protected Member Functions inherited from <aclass="el"href="classvoro_1_1container__periodic__base.html">voro::container_periodic_base</a></td></tr>
<trclass="memitem:a8d0c8a32a6e31cdd8eecb335f5f68d22 inherit pro_methods_classvoro_1_1container__periodic__base"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic__base.html#a8d0c8a32a6e31cdd8eecb335f5f68d22">put_locate_block</a> (int &ijk, double &x, double &y, double &z, int &ai, int &aj, int &ak)</td></tr>
<trclass="memitem:a11b7428673e4791fe651036ecda0cd12 inherit pro_methods_classvoro_1_1container__periodic__base"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic__base.html#a11b7428673e4791fe651036ecda0cd12">create_periodic_image</a> (int di, int dj, int dk)</td></tr>
<trclass="memitem:aa16ea029bbf80a1fdec3e6bba675e704 inherit pro_methods_classvoro_1_1container__periodic__base"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic__base.html#aa16ea029bbf80a1fdec3e6bba675e704">create_side_image</a> (int di, int dj, int dk)</td></tr>
<trclass="memitem:a8d3545b219d91aee864b224829b6a644 inherit pro_methods_classvoro_1_1container__periodic__base"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic__base.html#a8d3545b219d91aee864b224829b6a644">create_vertical_image</a> (int di, int dj, int dk)</td></tr>
<trclass="memitem:a72efe37cb7876149cac5f5ead579b353 inherit pro_methods_classvoro_1_1container__periodic__base"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic__base.html#a72efe37cb7876149cac5f5ead579b353">put_image</a> (int reg, int fijk, int l, double dx, double dy, double dz)</td></tr>
<trclass="memitem:ac5b0b78cf8fe46f7e3c7124dbf4e0729 inherit pro_methods_classvoro_1_1container__periodic__base"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1container__periodic__base.html#ac5b0b78cf8fe46f7e3c7124dbf4e0729">remap</a> (int &ai, int &aj, int &ak, int &ci, int &cj, int &ck, double &x, double &y, double &z, int &ijk)</td></tr>
<trclass="inherit_header pro_methods_classvoro_1_1voro__base"><tdcolspan="2"onclick="javascript:toggleInherit('pro_methods_classvoro_1_1voro__base')"><imgsrc="closed.png"alt="-"/> Protected Member Functions inherited from <aclass="el"href="classvoro_1_1voro__base.html">voro::voro_base</a></td></tr>
<trclass="memitem:ab432b8bee0def0666ac39a132c721135 inherit pro_methods_classvoro_1_1voro__base"><tdclass="memItemLeft"align="right"valign="top">int </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1voro__base.html#ab432b8bee0def0666ac39a132c721135">step_mod</a> (int a, int b)</td></tr>
<trclass="memitem:a59a281a5e25e13f681c4f6a2c8bd1ca7 inherit pro_methods_classvoro_1_1voro__base"><tdclass="memItemLeft"align="right"valign="top">int </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1voro__base.html#a59a281a5e25e13f681c4f6a2c8bd1ca7">step_div</a> (int a, int b)</td></tr>
<trclass="inherit_header pro_methods_classvoro_1_1radius__mono"><tdcolspan="2"onclick="javascript:toggleInherit('pro_methods_classvoro_1_1radius__mono')"><imgsrc="closed.png"alt="-"/> Protected Member Functions inherited from <aclass="el"href="classvoro_1_1radius__mono.html">voro::radius_mono</a></td></tr>
<trclass="memitem:ab17c87e1f434718bec74e93387480be9 inherit pro_methods_classvoro_1_1radius__mono"><tdclass="memItemLeft"align="right"valign="top">void </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1radius__mono.html#ab17c87e1f434718bec74e93387480be9">r_init</a> (int ijk, int s)</td></tr>
<trclass="memitem:ae390a53c70f0295592d02fc9dd0a9086 inherit pro_methods_classvoro_1_1radius__mono"><tdclass="memItemLeft"align="right"valign="top">double </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1radius__mono.html#ae390a53c70f0295592d02fc9dd0a9086">r_current_sub</a> (double rs, int ijk, int q)</td></tr>
<trclass="memitem:a4aa8de703ecce74dc1625aea73149720 inherit pro_methods_classvoro_1_1radius__mono"><tdclass="memItemLeft"align="right"valign="top">double </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1radius__mono.html#a4aa8de703ecce74dc1625aea73149720">r_scale</a> (double rs, int ijk, int q)</td></tr>
<trclass="memitem:aaadf553614ec9390a37349bc7d7a7557 inherit pro_methods_classvoro_1_1radius__mono"><tdclass="memItemLeft"align="right"valign="top">bool </td><tdclass="memItemRight"valign="bottom"><aclass="el"href="classvoro_1_1radius__mono.html#aaadf553614ec9390a37349bc7d7a7557">r_scale_check</a> (double &rs, double mrs, int ijk, int q)</td></tr>
<divclass="textblock"><p>This class is an extension of the <aclass="el"href="classvoro_1_1container__periodic__base.html"title="Class for representing a particle system in a 3D periodic non-orthogonal periodic domain...">container_periodic_base</a> that has routines specifically for computing the regular Voronoi tessellation with no dependence on particle radii. </p>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00212">212</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<p>The class constructor sets up the geometry of container. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(bx_)</td><td>The x coordinate of the first unit vector. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(bxy_,by_)</td><td>The x and y coordinates of the second unit vector. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(bxz_,byz_,bz_)</td><td>The x, y, and z coordinates of the third unit vector. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(nx_,ny_,nz_)</td><td>the number of grid blocks in each of the three coordinate directions. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">init_mem_</td><td>the initial memory allocation for each block. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00072">72</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00448">448</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
<p>Computes all of the Voronoi cells in the container, but does nothing with the output. It is useful for measuring the pure computation time of the Voronoi algorithm, without any additional calculations such as volume evaluation or cell output. </p>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00499">499</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
<p>Computes the Voronoi cell for a particle currently being referenced by a loop class. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">c</td><td>a Voronoi cell class in which to store the computed cell. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">vl</td><td>the loop class to use. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns:</dt><dd>True if the cell was computed. If the cell cannot be computed because it was removed entirely for some reason, then the routine returns false. </dd></dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00388">388</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Computes the Voronoi cell for given particle. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">c</td><td>a Voronoi cell class in which to store the computed cell. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">ijk</td><td>the block that the particle is within. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">q</td><td>the index of the particle within the block. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns:</dt><dd>True if the cell was computed. If the cell cannot be computed because it was removed entirely for some reason, then the routine returns false. </dd></dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00400">400</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Computes Voronoi cells and saves the output in gnuplot format. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">vl</td><td>the loop class to use. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>a file handle to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00304">304</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Computes all Voronoi cells and saves the output in gnuplot format. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>a file handle to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00314">314</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Compute all Voronoi cells and saves the output in gnuplot format. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">filename</td><td>the name of the file to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00321">321</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Computes Voronoi cells and saves the output in POV-Ray format. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">vl</td><td>the loop class to use. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>a file handle to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00331">331</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Computes all Voronoi cells and saves the output in POV-Ray format. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>a file handle to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00342">342</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Computes all Voronoi cells and saves the output in POV-Ray format. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">filename</td><td>the name of the file to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00349">349</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Dumps particle IDs and positions to a file. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">vl</td><td>the loop class to use. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>a file handle to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00254">254</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Dumps all of the particle IDs and positions to a file. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>a file handle to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00263">263</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Dumps all of the particle IDs and positions to a file. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">filename</td><td>the name of the file to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00269">269</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Dumps particle positions in POV-Ray format. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">vl</td><td>the loop class to use. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>a file handle to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00278">278</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Dumps all particle positions in POV-Ray format. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>a file handle to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00288">288</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Dumps all particle positions in POV-Ray format. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">filename</td><td>the name of the file to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00294">294</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Takes a vector and finds the particle whose Voronoi cell contains that vector. This is equivalent to finding the particle which is nearest to the vector. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(x,y,z)</td><td>the vector to test. </td></tr>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">(rx,ry,rz)</td><td>the position of the particle whose Voronoi cell contains the vector. This may point to a particle in a periodic image of the primary domain. </td></tr>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">pid</td><td>the ID of the particle. </td></tr>
</table>
</dd>
</dl>
<dlclass="section return"><dt>Returns:</dt><dd>True if a particle was found. If the container has no particles, then the search will not find a Voronoi cell and false is returned. </dd></dl>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00297">297</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
<p>Import a list of particles from an open file stream into the container. Entries of four numbers (Particle ID, x position, y position, z position) are searched for. If the file cannot be successfully read, then the routine causes a fatal error. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>the file handle to read from. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00394">394</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
<p>Import a list of particles from an open file stream, also storing the order of that the particles are read. Entries of four numbers (Particle ID, x position, y position, z position) are searched for. If the file cannot be successfully read, then the routine causes a fatal error. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in,out]</td><tdclass="paramname">vo</td><td>a reference to an ordering class to use. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>the file handle to read from. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00407">407</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
<p>Imports a list of particles from an open file stream into the container. Entries of four numbers (Particle ID, x position, y position, z position) are searched for. If the file cannot be successfully read, then the routine causes a fatal error. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">filename</td><td>the name of the file to open and read from. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00229">229</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Imports a list of particles from an open file stream into the container. Entries of four numbers (Particle ID, x position, y position, z position) are searched for. In addition, the order in which particles are read is saved into an ordering class. If the file cannot be successfully read, then the routine causes a fatal error. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in,out]</td><tdclass="paramname">vo</td><td>the ordering class to use. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">filename</td><td>the name of the file to open and read from. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00243">243</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Computes the Voronoi cells and saves customized information about them. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">vl</td><td>the loop class to use. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">format</td><td>the custom output string to use. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>a file handle to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8hh_source.html#l00360">360</a> of file <aclass="el"href="container__prd_8hh_source.html">container_prd.hh</a>.</p>
<p>Computes all the Voronoi cells and saves customized information about them. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">format</td><td>the custom output string to use. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">fp</td><td>a file handle to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00462">462</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
<p>Computes all the Voronoi cells and saves customized information about them. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">format</td><td>the custom output string to use. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">filename</td><td>the name of the file to write to. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00479">479</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
<p>Put a particle into the correct region of the container. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">n</td><td>the numerical ID of the inserted particle. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(x,y,z)</td><td>the position vector of the inserted particle. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00093">93</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
<p>Put a particle into the correct region of the container. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">n</td><td>the numerical ID of the inserted particle. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(x,y,z)</td><td>the position vector of the inserted particle. </td></tr>
<tr><tdclass="paramdir">[out]</td><tdclass="paramname">(ai,aj,ak)</td><td>the periodic image displacement that the particle is in, with (0,0,0) corresponding to the primary domain. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00120">120</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
<p>Put a particle into the correct region of the container, also recording into which region it was stored. </p>
<dlclass="params"><dt>Parameters:</dt><dd>
<tableclass="params">
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">vo</td><td>the ordering class in which to record the region. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">n</td><td>the numerical ID of the inserted particle. </td></tr>
<tr><tdclass="paramdir">[in]</td><tdclass="paramname">(x,y,z)</td><td>the position vector of the inserted particle. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00149">149</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
<p>Calculates all of the Voronoi cells and sums their volumes. In most cases without walls, the sum of the Voronoi cell volumes should equal the volume of the container to numerical precision. </p>
<dlclass="section return"><dt>Returns:</dt><dd>The sum of all of the computed Voronoi volumes. </dd></dl>
<p>Definition at line <aclass="el"href="container__prd_8cc_source.html#l00520">520</a> of file <aclass="el"href="container__prd_8cc_source.html">container_prd.cc</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>