voro::radius_mono Class Reference

Class containing all of the routines that are specific to computing the regular Voronoi tessellation. More...

#include <rad_option.hh>

Inheritance diagram for voro::radius_mono:

Classes
struct	radius_info

Protected Member Functions
void	r_init (int ijk, int s, radius_info &radius_out) const
void	r_prime (double rv, radius_info &radius_out) const
bool	r_ctest (double crs, double mrs, const radius_info &rad_info) const
double	r_cutoff (double lrs, const radius_info &rad_info) const
double	r_max_add (double rs) const
double	r_current_sub (double rs, int ijk, int q) const
double	r_scale (double rs, int ijk, int q, const radius_info &rad_info) const
bool	r_scale_check (double &rs, double mrs, int ijk, int q, const radius_info &rad_info) const

Detailed Description

Class containing all of the routines that are specific to computing the regular Voronoi tessellation.

The container and container_periodic classes are derived from this class, and during the Voronoi cell computation, these routines are used to create the regular Voronoi tessellation.

Member Function Documentation

r_ctest()

bool voro::radius_mono::r_ctest ( double  crs, double  mrs, const radius_info &  rad_info  ) const

inlineprotected

Carries out a radius bounds check.

Parameters

[in]	crs	the radius squared to be tested.
[in]	mrs	the current maximum distance to a Voronoi vertex multiplied by two.

Returns

True if particles at this radius could not possibly cut the cell, false otherwise.

r_current_sub()

double voro::radius_mono::r_current_sub ( double  rs, int  ijk, int  q  ) const

inlineprotected

Subtracts the radius squared of a particle from a given value.

Parameters

[in]	rs	the value to consider.
[in]	ijk	the block that the particle is within.
[in]	q	the index of the particle within the block.

Returns

The value with the radius squared subtracted.

r_cutoff()

double voro::radius_mono::r_cutoff ( double  lrs, const radius_info &  rad_info  ) const

inlineprotected

Scales a plane displacement during a plane bounds check.

Parameters

[in]

lrs

the plane displacement.

Returns

The scaled value.

r_init()

void voro::radius_mono::r_init ( int  ijk, int  s, radius_info &  radius_out  ) const

inlineprotected

This is called prior to computing a Voronoi cell for a given particle to initialize any required constants.

Parameters

[in]	ijk	the block that the particle is within.
[in]	s	the index of the particle within the block.

r_max_add()

double voro::radius_mono::r_max_add ( double  rs ) const

inlineprotected

Adds the maximum radius squared to a given value.

Parameters

[in]

rs

the value to consider.

Returns

The value with the radius squared added.

r_prime()

void voro::radius_mono::r_prime ( double  rv, radius_info &  radius_out  ) const

inlineprotected

Sets a required constant to be used when carrying out a plane bounds check.

r_scale()

double voro::radius_mono::r_scale ( double  rs, int  ijk, int  q, const radius_info &  rad_info  ) const

inlineprotected

Scales a plane displacement prior to use in the plane cutting algorithm.

Parameters

[in]	rs	the initial plane displacement.
[in]	ijk	the block that the particle is within.
[in]	q	the index of the particle within the block.

Returns

The scaled plane displacement.

r_scale_check()

bool voro::radius_mono::r_scale_check ( double &  rs, double  mrs, int  ijk, int  q, const radius_info &  rad_info  ) const

inlineprotected

Scales a plane displacement prior to use in the plane cutting algorithm, and also checks if it could possibly cut the cell.

Parameters

[in,out]	rs	the plane displacement to be scaled.
[in]	mrs	the current maximum distance to a Voronoi vertex multiplied by two.
[in]	ijk	the block that the particle is within.
[in]	q	the index of the particle within the block.

Returns

True if the cell could possibly cut the cell, false otherwise.

---

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

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