Voro++
Public Member Functions | Friends
voro::voronoicell Class Reference

Extension of the voronoicell_base class to represent a Voronoi cell without neighbor information. More...

#include <cell.hh>

Inheritance diagram for voro::voronoicell:

Public Member Functions

void operator= (voronoicell &c)
bool nplane (double x, double y, double z, double rsq, int p_id)
bool nplane (double x, double y, double z, int p_id)
bool plane (double x, double y, double z, double rsq)
bool plane (double x, double y, double z)
void init (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)
void init_octahedron (double l)
void init_tetrahedron (double x0, double y0, double z0, double x1, double y1, double z1, double x2, double y2, double z2, double x3, double y3, double z3)

Friends

class voronoicell_base

Detailed Description

This class is an extension of the voronoicell_base class, in cases when is not necessary to track the IDs of neighboring particles associated with each face of the Voronoi cell.

Definition at line 307 of file cell.hh.


Member Function Documentation

void voro::voronoicell::init ( double  xmin,
double  xmax,
double  ymin,
double  ymax,
double  zmin,
double  zmax 
) [inline]

Initializes the Voronoi cell to be rectangular box with the given dimensions.

Parameters:
[in](xmin,xmax)the minimum and maximum x coordinates.
[in](ymin,ymax)the minimum and maximum y coordinates.
[in](zmin,zmax)the minimum and maximum z coordinates.

Definition at line 362 of file cell.hh.

void voro::voronoicell::init_octahedron ( double  l) [inline]

Initializes the cell to be an octahedron with vertices at (l,0,0), (-l,0,0), (0,l,0), (0,-l,0), (0,0,l), and (0,0,-l).

Parameters:
[in]la parameter setting the size of the octahedron.

Definition at line 369 of file cell.hh.

void voro::voronoicell::init_tetrahedron ( double  x0,
double  y0,
double  z0,
double  x1,
double  y1,
double  z1,
double  x2,
double  y2,
double  z2,
double  x3,
double  y3,
double  z3 
) [inline]

Initializes the cell to be a tetrahedron.

Parameters:
[in](x0,y0,z0)the coordinates of the first vertex.
[in](x1,y1,z1)the coordinates of the second vertex.
[in](x2,y2,z2)the coordinates of the third vertex.
[in](x3,y3,z3)the coordinates of the fourth vertex.

Definition at line 378 of file cell.hh.

bool voro::voronoicell::nplane ( double  x,
double  y,
double  z,
double  rsq,
int  p_id 
) [inline]

Cuts a Voronoi cell using by the plane corresponding to the perpendicular bisector of a particle.

Parameters:
[in](x,y,z)the position of the particle.
[in]rsqthe modulus squared of the vector.
[in]p_idthe plane ID, ignored for this case where no neighbor tracking is enabled.
Returns:
False if the plane cut deleted the cell entirely, true otherwise.

Definition at line 325 of file cell.hh.

bool voro::voronoicell::nplane ( double  x,
double  y,
double  z,
int  p_id 
) [inline]

Cuts a Voronoi cell using by the plane corresponding to the perpendicular bisector of a particle.

Parameters:
[in](x,y,z)the position of the particle.
[in]p_idthe plane ID, ignored for this case where no neighbor tracking is enabled.
Returns:
False if the plane cut deleted the cell entirely, true otherwise.

Definition at line 335 of file cell.hh.

void voro::voronoicell::operator= ( voronoicell c) [inline]

Copies the information from another voronoicell class into this class, extending memory allocation if necessary.

Parameters:
[in]cthe class to copy.

Definition at line 313 of file cell.hh.

bool voro::voronoicell::plane ( double  x,
double  y,
double  z 
) [inline]

Cuts a Voronoi cell using by the plane corresponding to the perpendicular bisector of a particle.

Parameters:
[in](x,y,z)the position of the particle.
Returns:
False if the plane cut deleted the cell entirely, true otherwise.

Definition at line 353 of file cell.hh.

bool voro::voronoicell::plane ( double  x,
double  y,
double  z,
double  rsq 
) [inline]

Cuts a Voronoi cell using by the plane corresponding to the perpendicular bisector of a particle.

Parameters:
[in](x,y,z)the position of the particle.
[in]rsqthe modulus squared of the vector.
Returns:
False if the plane cut deleted the cell entirely, true otherwise.

Definition at line 345 of file cell.hh.


The documentation for this class was generated from the following file: