esys::lsm::ConstRadiusGen< TmplParticle > Class Template Reference

#include <PackerGenerators.h>

Public Types
typedef TmplParticle	Particle

Public Member Functions
	ConstRadiusGen (double radius)
const double &	getParticleRadius () const
const double &	getMinFitRadius () const
const double &	getMaxFitRadius () const
Particle	getParticle (const Vec3 &posn) const
Particle	getParticle (const Vec3 &posn, const double &maxRadius) const
bool	isValidFitRadius (const double &fitRadius) const

Private Attributes
double	m_radius

Detailed Description

template<typename TmplParticle>
class esys::lsm::ConstRadiusGen< TmplParticle >

Generates particles of a specified constant radius.

Member Typedef Documentation

Particle

template<typename TmplParticle >

typedef TmplParticle esys::lsm::ConstRadiusGen< TmplParticle >::Particle

Constructor & Destructor Documentation

ConstRadiusGen()

template<typename TmplParticle >

esys::lsm::ConstRadiusGen< TmplParticle >::ConstRadiusGen

(

double

radius

)

Member Function Documentation

getMaxFitRadius()

template<typename TmplParticle >

const double & esys::lsm::ConstRadiusGen< TmplParticle >::getMaxFitRadius

Returns the radius of particles generated by the getParticle method.

getMinFitRadius()

template<typename TmplParticle >

const double & esys::lsm::ConstRadiusGen< TmplParticle >::getMinFitRadius

Returns the radius of particles generated by the getParticle method.

getParticle() [1/2]

template<typename TmplParticle >

ConstRadiusGen< TmplParticle >::Particle esys::lsm::ConstRadiusGen< TmplParticle >::getParticle

(

const Vec3 &

posn

)

const

Returns a particle of radius this->getParticleRadius().

Parameters

posn	The position of the returned particle.

getParticle() [2/2]

template<typename TmplParticle >

ConstRadiusGen< TmplParticle >::Particle esys::lsm::ConstRadiusGen< TmplParticle >::getParticle	(	const Vec3 &	posn,
		const double &	maxRadius
	)		const

Returns a particle of radius this->getParticleRadius().

Parameters

posn	The position of the returned particle.
maxRadius	The suggested particle radius, ignored.

getParticleRadius()

template<typename TmplParticle >

const double & esys::lsm::ConstRadiusGen< TmplParticle >::getParticleRadius

Returns the radius of particles generated by the getParticle method.

isValidFitRadius()

template<typename TmplParticle >

bool esys::lsm::ConstRadiusGen< TmplParticle >::isValidFitRadius

(

const double &

fitRadius

)

const

Returns whether fitRadius == this->getRadius()

Member Data Documentation

m_radius

template<typename TmplParticle >

double esys::lsm::ConstRadiusGen< TmplParticle >::m_radius

private

---

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

• Geometry/PackerGenerators.h
• Geometry/PackerGenerators.hpp