voro::wall_cone Struct Reference

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

#include <wall.hh>

Inheritance diagram for voro::wall_cone:

Public Member Functions
	wall_cone (double xc_, double yc_, double zc_, double xa_, double ya_, double za_, double ang, 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 conical wall object.

This class represents a cone wall object.

Constructor & Destructor Documentation

wall_cone()

voro::wall_cone::wall_cone ( double  xc_, double  yc_, double  zc_, double  xa_, double  ya_, double  za_, double  ang, int  w_id_ = -99  )

inline

Constructs a cone wall object.

Parameters

[in]	(xc_,yc_,zc_)	the apex of the cone.
[in]	(xa_,ya_,za_)	a vector pointing along the axis of the cone.
[in]	ang	the angle (in radians) of the cone, measured from the axis.
[in]	w_id_	an ID number to associate with the wall for neighbor tracking.

Member Function Documentation

cut_cell() [1/2]

bool voro::wall_cone::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_cone::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_cone::cut_cell_base	(	v_cell &	c,
		double	x,
		double	y,
		double	z
	)		const

Cuts a cell by the cone wall object. The conical wall is approximated by a single plane applied at the point on the cone 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_cone::point_inside ( double  x, double  y, double  z  ) const

virtual

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

Parameters

[in]

(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