Voro++
Public Member Functions
voro::wall_sphere Struct Reference

A class representing a spherical wall object. More...

#include <wall.hh>

+ Inheritance diagram for voro::wall_sphere:

Public Member Functions

 wall_sphere (double xc_, double yc_, double zc_, double rc_, int w_id_=-99)
 
bool point_inside (double x, double y, double z)
 
template<class v_cell >
bool cut_cell_base (v_cell &c, double x, double y, double z)
 
bool cut_cell (voronoicell &c, double x, double y, double z)
 
bool cut_cell (voronoicell_neighbor &c, double x, double y, double z)
 

Detailed Description

This class represents a spherical wall object.

Definition at line 21 of file wall.hh.

Constructor & Destructor Documentation

voro::wall_sphere::wall_sphere ( double  xc_,
double  yc_,
double  zc_,
double  rc_,
int  w_id_ = -99 
)
inline

Constructs a spherical wall object.

Parameters
[in]w_id_an ID number to associate with the wall for neighbor tracking.
[in](xc_,yc_,zc_)a position vector for the sphere's center.
[in]rc_the radius of the sphere.

Definition at line 29 of file wall.hh.

Member Function Documentation

bool voro::wall_sphere::cut_cell ( voronoicell c,
double  x,
double  y,
double  z 
)
inlinevirtual

A pure virtual function for cutting a cell without neighbor-tracking with a wall.

Implements voro::wall.

Definition at line 34 of file wall.hh.

bool voro::wall_sphere::cut_cell ( voronoicell_neighbor c,
double  x,
double  y,
double  z 
)
inlinevirtual

A pure virtual function for cutting a cell with neighbor-tracking enabled with a wall.

Implements voro::wall.

Definition at line 35 of file wall.hh.

template<class v_cell >
template bool voro::wall_sphere::cut_cell_base ( v_cell &  c,
double  x,
double  y,
double  z 
)

Cuts a cell by the sphere wall object. The spherical wall is approximated by a single plane applied at the point on the sphere which is closest to the center of the cell. This works well for particle arrangements that are packed against the wall, but loses accuracy for sparse particle distributions.

Parameters
[in,out]cthe Voronoi cell to be cut.
[in](x,y,z)the location of the Voronoi cell.
Returns
True if the cell still exists, false if the cell is deleted.

Definition at line 29 of file wall.cc.

bool voro::wall_sphere::point_inside ( double  x,
double  y,
double  z 
)
virtual

Tests to see whether a point is inside the sphere wall object.

Parameters
[in,out](x,y,z)the vector to test.
Returns
True if the point is inside, false if the point is outside.

Implements voro::wall.

Definition at line 17 of file wall.cc.


The documentation for this struct was generated from the following files: