wall_sphere Struct Reference

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

#include <wall.hh>

Inheritance diagram for wall_sphere:

Public Member Functions
	wall_sphere (fpoint ixc, fpoint iyc, fpoint izc, fpoint irc, int iw_id=-99)
bool	point_inside (fpoint x, fpoint y, fpoint z)
template<class n_option >
bool	cut_cell_base (voronoicell_base< n_option > &c, fpoint x, fpoint y, fpoint z)
bool	cut_cell (voronoicell_base< neighbor_none > &c, fpoint x, fpoint y, fpoint z)
bool	cut_cell (voronoicell_base< neighbor_track > &c, fpoint x, fpoint y, fpoint z)

---

Detailed Description

A class representing a spherical wall object.

This class represents a spherical wall object.

Definition at line 16 of file wall.hh.

---

Constructor & Destructor Documentation

wall_sphere::wall_sphere	(	fpoint	ixc,
		fpoint	iyc,
		fpoint	izc,
		fpoint	irc,
		int	iw_id = -99
	)			[inline]

Constructs a spherical wall object.

Parameters:

[in]	iw_id	an ID number to associate with the wall for neighbor tracking.
[in]	(ixc,iyc,izc)	a position vector for the sphere's center.
[in]	irc	the radius of the sphere.

Definition at line 24 of file wall.hh.

---

Member Function Documentation

bool wall_sphere::cut_cell	(	voronoicell_base< neighbor_track > &	c,
		fpoint	x,
		fpoint	y,
		fpoint	z
	)			[inline, virtual]

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

Implements wall.

Definition at line 30 of file wall.hh.

bool wall_sphere::cut_cell	(	voronoicell_base< neighbor_none > &	c,
		fpoint	x,
		fpoint	y,
		fpoint	z
	)			[inline, virtual]

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

Implements wall.

Definition at line 29 of file wall.hh.

template<class n_option >

bool wall_sphere::cut_cell_base	(	voronoicell_base< n_option > &	c,
		fpoint	x,
		fpoint	y,
		fpoint	z
	)			[inline]

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.

Definition at line 27 of file wall.cc.

bool wall_sphere::point_inside	(	fpoint	x,
		fpoint	y,
		fpoint	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 wall.

Definition at line 15 of file wall.cc.

---

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

• wall.hh
• wall.cc