radius_mono Class Reference

A class encapsulating all routines specifically needed in the standard Voronoi tessellation. More...

#include <container.hh>

Public Member Functions

 radius_mono (container_base< radius_mono > *icc)
void import (istream &is)
void store_radius (int i, int j, fpoint r)
void clear_max ()
void init (int s, int i)
fpoint volume (int ijk, int s)
fpoint cutoff (fpoint lrs)
fpoint scale (fpoint rs, int t, int q)
void print (ostream &os, int ijk, int q, bool later=true)
void rad (ostream &os, int l, int c)

Data Fields

const int mem_size

Detailed Description

A class encapsulating all routines specifically needed in the standard Voronoi tessellation.

This class encapsulates all the routines that are required for carrying out a standard Voronoi tessellation that would be appropriate for a monodisperse system. When the container class is instantiated using this class, all information about particle radii is switched off. Since all these functions are declared inline, there should be no loss of speed.

Definition at line 237 of file container.hh.


Constructor & Destructor Documentation

radius_mono::radius_mono ( container_base< radius_mono > *  icc  )  [inline]

This constructor sets a pointer back to the container class that created it, and initializes the mem_size constant to 3.

Parameters:
[in] icc a pointer the container class that created this class.

Definition at line 247 of file container.hh.


Member Function Documentation

void radius_mono::clear_max (  )  [inline]

This is a blank placeholder function that does nothing.

Definition at line 252 of file container.hh.

fpoint radius_mono::cutoff ( fpoint  lrs  )  [inline]

This routine is called when deciding when to terminate the computation of a Voronoi cell. For the monodisperse case, this routine just returns the same value that is passed to it.

Parameters:
[in] lrs a cutoff radius for the cell computation.
Returns:
The same value passed to it.

Definition at line 1556 of file container.cc.

void radius_mono::import ( istream &  is  )  [inline]

Imports a list of particles from an input stream for the monodisperse case where no radius information is expected.

Parameters:
[in] is an input stream to read from.

Definition at line 1509 of file container.cc.

void radius_mono::init ( int  s,
int  i 
) [inline]

This is a blank placeholder function that does nothing.

Definition at line 254 of file container.hh.

void radius_mono::print ( ostream &  os,
int  ijk,
int  q,
bool  later = true 
) [inline]

This is a blank placeholder function that does nothing.

Definition at line 259 of file container.hh.

void radius_mono::rad ( ostream &  os,
int  l,
int  c 
) [inline]

Prints the radius of particle, by just supplying a generic value of "s".

Parameters:
[in] os the output stream to write to.
[in] l the region to consider.
[in] c the number of the particle within the region.

Definition at line 1564 of file container.cc.

fpoint radius_mono::scale ( fpoint  rs,
int  t,
int  q 
) [inline]

Applies a blank scaling to the position of a cutting plane.

Parameters:
[in] rs the distance between the Voronoi cell and the cutting plane.
[in] t the region to consider
[in] q the number of the particle within the region.
Returns:
The scaled position, which for this case, is equal to rs.

Definition at line 1610 of file container.cc.

void radius_mono::store_radius ( int  i,
int  j,
fpoint  r 
) [inline]

This is a blank placeholder function that does nothing.

Definition at line 250 of file container.hh.

fpoint radius_mono::volume ( int  ijk,
int  s 
) [inline]

Returns the scaled volume of a particle, which is always set to 0.125 for the monodisperse case where particles are taken to have unit diameter.

Parameters:
[in] ijk the region to consider.
[in] s the number of the particle within the region.
Returns:
The cube of the radius of the particle, which is 0.125 in this case.

Definition at line 1582 of file container.cc.


Field Documentation

The number of floating point numbers allocated for each particle in the container, set to 3 for this case for the x, y, and z positions.

Definition at line 242 of file container.hh.


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

Generated on Tue Sep 29 11:46:27 2009 for Voro++ by  doxygen 1.6.1