Extension of the voronoicell_base class to represent a Voronoi cell without neighbor information. More...

#include <cell.hh>

Inheritance diagram for voro::voronoicell:

Public Member Functions
void	operator= (voronoicell &c)

bool	nplane (double x, double y, double z, double rsq, int p_id)

bool	nplane (double x, double y, double z, int p_id)

bool	plane (double x, double y, double z, double rsq)

bool	plane (double x, double y, double z)

void	init (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)

void	init_octahedron (double l)

void	init_tetrahedron (double x0, double y0, double z0, double x1, double y1, double z1, double x2, double y2, double z2, double x3, double y3, double z3)

void	extractCellInfo (const FVector &CellPosition, TArray< FVector > &Vertices, TArray< int32 > &FaceVertexIndices)

template<class vc_class >
bool	nplane (vc_class &vc, double x, double y, double z, double rsq, int p_id)

Public Member Functions inherited from voro::voronoicell_base
	voronoicell_base ()

virtual	~voronoicell_base ()

void	init_base (double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)

void	init_octahedron_base (double l)

void	init_tetrahedron_base (double x0, double y0, double z0, double x1, double y1, double z1, double x2, double y2, double z2, double x3, double y3, double z3)

void	translate (double x, double y, double z)

double	volume ()

double	max_radius_squared ()

double	total_edge_distance ()

double	surface_area ()

void	centroid (double &cx, double &cy, double &cz)

int	number_of_faces ()

int	number_of_edges ()

void	vertex_orders (std::vector< int > &v)

void	vertices (std::vector< double > &v)

void	vertices (double x, double y, double z, std::vector< double > &v)

void	face_areas (std::vector< double > &v)

void	face_orders (std::vector< int > &v)

void	face_freq_table (std::vector< int > &v)

void	face_vertices (std::vector< int > &v)

void	face_perimeters (std::vector< double > &v)

void	normals (std::vector< double > &v)

template<class vc_class >
bool	nplane (vc_class &vc, double x, double y, double z, double rsq, int p_id)

bool	plane_intersects (double x, double y, double z, double rsq)

bool	plane_intersects_guess (double x, double y, double z, double rsq)

void	construct_relations ()

void	check_relations ()

void	check_duplicates ()

void	print_edges ()

virtual void	neighbors (std::vector< int > &v)

virtual void	print_edges_neighbors (int i)

int	cycle_up (int a, int vertexIndex)

int	cycle_down (int a, int vertexIndex)

Friends
class	voronoicell_base

Additional Inherited Members
Public Attributes inherited from voro::voronoicell_base
int	current_vertices

int	current_vertex_order

int	current_delete_size

int	current_delete2_size

int	p

int	up

int **	ed

int *	nu

double *	pts

Protected Member Functions inherited from voro::voronoicell_base
void	reset_edges ()

template<class vc_class >
void	check_memory_for_copy (vc_class &vc, voronoicell_base *vb)

void	copy (voronoicell_base *vb)

Protected Attributes inherited from voro::voronoicell_base
int *	mem

int *	mec

int **	mep

Detailed Description

Extension of the voronoicell_base class to represent a Voronoi cell without neighbor information.

This class is an extension of the voronoicell_base class, in cases when is not necessary to track the IDs of neighboring particles associated with each face of the Voronoi cell.

Member Function Documentation

◆ extractCellInfo()

void voro::voronoicell::extractCellInfo	(	const FVector &	CellPosition,
		TArray< FVector > &	Vertices,
		TArray< int32 > &	FaceVertexIndices
	)

Computes Unreal TArrays of all cell info.

◆ init()

void voro::voronoicell::init	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		double	zmin,
		double	zmax
	)

inline

Initializes the Voronoi cell to be rectangular box with the given dimensions.

Parameters

[in]	(xmin,xmax)	the minimum and maximum x coordinates.
[in]	(ymin,ymax)	the minimum and maximum y coordinates.
[in]	(zmin,zmax)	the minimum and maximum z coordinates.

◆ init_octahedron()

void voro::voronoicell::init_octahedron ( double l )

inline

Initializes the cell to be an octahedron with vertices at (l,0,0), (-l,0,0), (0,l,0), (0,-l,0), (0,0,l), and (0,0,-l).

Parameters

[in] l a parameter setting the size of the octahedron.

◆ init_tetrahedron()

void voro::voronoicell::init_tetrahedron	(	double	x0,
		double	y0,
		double	z0,
		double	x1,
		double	y1,
		double	z1,
		double	x2,
		double	y2,
		double	z2,
		double	x3,
		double	y3,
		double	z3
	)

inline

Initializes the cell to be a tetrahedron.

Parameters

[in]	(x0,y0,z0)	the coordinates of the first vertex.
[in]	(x1,y1,z1)	the coordinates of the second vertex.
[in]	(x2,y2,z2)	the coordinates of the third vertex.
[in]	(x3,y3,z3)	the coordinates of the fourth vertex.

◆ nplane() [1/3]

bool voro::voronoicell::nplane	(	double	x,
		double	y,
		double	z,
		double	rsq,
		int	p_id
	)

inline

Cuts a Voronoi cell using by the plane corresponding to the perpendicular bisector of a particle.

Parameters

[in]	(x,y,z)	the position of the particle.
[in]	rsq	the modulus squared of the vector.
[in]	p_id	the plane ID, ignored for this case where no neighbor tracking is enabled.

Returns: False if the plane cut deleted the cell entirely, true otherwise.

◆ nplane() [2/3]

bool voro::voronoicell::nplane	(	double	x,
		double	y,
		double	z,
		int	p_id
	)

inline

Cuts a Voronoi cell using by the plane corresponding to the perpendicular bisector of a particle.

Parameters

[in]	(x,y,z)	the position of the particle.
[in]	p_id	the plane ID, ignored for this case where no neighbor tracking is enabled.

Returns: False if the plane cut deleted the cell entirely, true otherwise.

◆ nplane() [3/3]

template<class vc_class >

template bool voro::voronoicell_base::nplane	(	vc_class &	vc,
		double	x,
		double	y,
		double	z,
		double	rsq,
		int	p_id
	)

Cuts the Voronoi cell by a particle whose center is at a separation of (x,y,z) from the cell center. The value of rsq should be initially set to $x^2+y^2+z^2$ .

Parameters

[in]	vc	a reference to the specialized version of the calling class.
[in]	(x,y,z)	the normal vector to the plane.
[in]	rsq	the distance along this vector of the plane.
[in]	p_id	the plane ID (for neighbor tracking only).

Returns: False if the plane cut deleted the cell entirely, true otherwise.

◆ operator=()

void voro::voronoicell::operator= ( voronoicell & c )

inline

Copies the information from another voronoicell class into this class, extending memory allocation if necessary.

Parameters

[in] c the class to copy.

◆ plane() [1/2]

bool voro::voronoicell::plane	(	double	x,
		double	y,
		double	z
	)

inline

Cuts a Voronoi cell using by the plane corresponding to the perpendicular bisector of a particle.

Parameters

[in] (x,y,z) the position of the particle.

Returns: False if the plane cut deleted the cell entirely, true otherwise.

◆ plane() [2/2]

bool voro::voronoicell::plane	(	double	x,
		double	y,
		double	z,
		double	rsq
	)

inline

Cuts a Voronoi cell using by the plane corresponding to the perpendicular bisector of a particle.

Parameters

[in]	(x,y,z)	the position of the particle.
[in]	rsq	the modulus squared of the vector.

Returns: False if the plane cut deleted the cell entirely, true otherwise.

Friends And Related Symbol Documentation

◆ voronoicell_base

friend class voronoicell_base

friend

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

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ extractCellInfo()

◆ init()

◆ init_octahedron()

◆ init_tetrahedron()

◆ nplane() [1/3]

◆ nplane() [2/3]

◆ nplane() [3/3]

◆ operator=()

◆ plane() [1/2]

◆ plane() [2/2]

Friends And Related Symbol Documentation

◆ voronoicell_base