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

#include <PackerGenerators.h>

Inheritance diagram for esys::lsm::RangeRadiusGen< TmplParticle >:

Public Types
typedef TmplParticle	Particle

Public Member Functions
	RangeRadiusGen (double minFitRadius, double maxFitRadius)
virtual	~RangeRadiusGen ()
const double &	getMinFitRadius () const
const double &	getMaxFitRadius () const
bool	isValidFitRadius (const double &fitRadius) const

Private Attributes
double	m_minFitRadius
double	m_maxFitRadius

Detailed Description

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

Base class for generators which generate particles whose radius ranges between a specified minimum and maximum.

Member Typedef Documentation

Particle

template<typename TmplParticle >

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

Constructor & Destructor Documentation

RangeRadiusGen()

template<typename TmplParticle >

esys::lsm::RangeRadiusGen< TmplParticle >::RangeRadiusGen	(	double	minFitRadius,
		double	maxFitRadius
	)

~RangeRadiusGen()

template<typename TmplParticle >

esys::lsm::RangeRadiusGen< TmplParticle >::~RangeRadiusGen

virtual

Member Function Documentation

getMaxFitRadius()

template<typename TmplParticle >

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

Returns the radius of particles generated by the getParticle method.

getMinFitRadius()

template<typename TmplParticle >

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

Returns the radius of particles generated by the getParticle method.

isValidFitRadius()

template<typename TmplParticle >

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

(

const double &

fitRadius

)

const

Returns whether fitRadius == this->getRadius()

Member Data Documentation

m_maxFitRadius

template<typename TmplParticle >

double esys::lsm::RangeRadiusGen< TmplParticle >::m_maxFitRadius

private

m_minFitRadius

template<typename TmplParticle >

double esys::lsm::RangeRadiusGen< TmplParticle >::m_minFitRadius

private

---

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

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