voro::pre_container Class Reference

A class for storing an arbitrary number of particles without radius information, prior to setting up a container geometry. More...

#include <pre_container.hh>

Inheritance diagram for voro::pre_container:

Public Member Functions
	pre_container (double ax_, double bx_, double ay_, double by_, double az_, double bz_, bool xperiodic_, bool yperiodic_, bool zperiodic_)
void	put (int n, double x, double y, double z)
void	setup (container &con)
void	setup (particle_order &vo, container &con)
Public Member Functions inherited from voro::pre_container_base
void	guess_optimal (int &nx, int &ny, int &nz)
	pre_container_base (double ax_, double bx_, double ay_, double by_, double az_, double bz_, bool xperiodic_, bool yperiodic_, bool zperiodic_, int ps_)
	~pre_container_base ()
PRAGMA_DISABLE_UNSAFE_TYPECAST_WARNINGS int	total_particles ()

Additional Inherited Members
Public Attributes inherited from voro::pre_container_base
const double	ax
const double	bx
const double	ay
const double	by
const double	az
const double	bz
const bool	xperiodic
const bool	yperiodic
const bool	zperiodic
Protected Member Functions inherited from voro::pre_container_base
void	new_chunk ()
void	extend_chunk_index ()
Protected Attributes inherited from voro::pre_container_base
const int	ps
int	index_sz
int **	pre_id
int **	end_id
int **	l_id
int *	ch_id
int *	e_id
double **	pre_p
double **	end_p
double *	ch_p

Detailed Description

A class for storing an arbitrary number of particles without radius information, prior to setting up a container geometry.

The pre_container class is an extension of the pre_container_base class for cases when no particle radius information is available.

Constructor & Destructor Documentation

pre_container()

voro::pre_container::pre_container ( double  ax_, double  bx_, double  ay_, double  by_, double  az_, double  bz_, bool  xperiodic_, bool  yperiodic_, bool  zperiodic_  )

inline

The class constructor sets up the geometry of container, initializing the minimum and maximum coordinates in each direction.

Parameters

[in]	(ax_,bx_)	the minimum and maximum x coordinates.
[in]	(ay_,by_)	the minimum and maximum y coordinates.
[in]	(az_,bz_)	the minimum and maximum z coordinates.
[in]	(xperiodic_,yperiodic_,zperiodic_	) flags setting whether the container is periodic in each coordinate direction.

Member Function Documentation

put()

void voro::pre_container::put	(	int	n,
		double	x,
		double	y,
		double	z
	)

Stores a particle ID and position, allocating a new memory chunk if necessary. For coordinate directions in which the container is not periodic, the routine checks to make sure that the particle is within the container bounds. If the particle is out of bounds, it is not stored.

Parameters

[in]	n	the numerical ID of the inserted particle.
[in]	(x,y,z)	the position vector of the inserted particle.

setup() [1/2]

void voro::pre_container::setup

(

container &

con

)

Transfers the particles stored within the class to a container class.

Parameters

[in]

con

the container class to transfer to.

setup() [2/2]

void voro::pre_container::setup	(	particle_order &	vo,
		container &	con
	)

Transfers the particles stored within the class to a container class, also recording the order in which particles were stored.

Parameters

[in]	vo	the ordering class to use.
[in]	con	the container class to transfer to.

---

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

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