wall_plane Struct Reference

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

#include <wall.hh>

Inheritance diagram for wall_plane:

Public Member Functions
	wall_plane (fpoint ixc, fpoint iyc, fpoint izc, fpoint iac, 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 plane wall object.

This class represents a single plane wall object.

Definition at line 39 of file wall.hh.

Constructs a plane wall object

Parameters:

`[in]`	(ixc,iyc,izc)	a normal vector to the plane.
`[in]`	iac	a displacement along the normal vector.
`[in]`	iw_id	an ID number to associate with the wall for neighbor tracking.

Definition at line 46 of file wall.hh.

bool wall_plane::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 52 of file wall.hh.

bool wall_plane::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 51 of file wall.hh.

template<class n_option >

Cuts a cell by the plane wall object.

Parameters:

`[in,out]`	c	the Voronoi cell to be cut.
`[in]`	(x,y,z)	the location of the Voronoi cell.

Definition at line 49 of file wall.cc.

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

Parameters:

[in] (x,y,z) the vector to test.

Implements wall.

Definition at line 40 of file wall.cc.

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