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) const
template<class v_cell >
bool	cut_cell_base (v_cell &c, double x, double y, double z) const
bool	cut_cell (voronoicell &c, double x, double y, double z) const
bool	cut_cell (voronoicell_neighbor &c, double x, double y, double z) const
Public Member Functions inherited from voro::wall
virtual	~wall ()

Detailed Description

A class representing a spherical wall object.

This class represents a spherical wall object.

Constructor & Destructor Documentation

wall_sphere()

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.

Member Function Documentation

cut_cell() [1/2]

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

inlinevirtual

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

Implements voro::wall.

cut_cell() [2/2]

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

inlinevirtual

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

Implements voro::wall.

cut_cell_base()

template<class v_cell >

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

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]	c	the 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.

point_inside()

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

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.

---

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

• Engine/Source/Runtime/Experimental/Voronoi/Private/voro++/src/wall.hh
• Engine/Source/Runtime/Experimental/Voronoi/Private/voro++/src/wall.cc