ESyS-Particle  2.3.2
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

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

Constructor & Destructor Documentation

template<typename TmplParticle >
esys::lsm::ConstRadiusGen< TmplParticle >::ConstRadiusGen ( double  radius)

Member Function Documentation

template<typename TmplParticle >
const double & esys::lsm::ConstRadiusGen< TmplParticle >::getMaxFitRadius ( ) const

Returns the radius of particles generated by the getParticle method.

template<typename TmplParticle >
const double & esys::lsm::ConstRadiusGen< TmplParticle >::getMinFitRadius ( ) const

Returns the radius of particles generated by the getParticle method.

template<typename TmplParticle >
ConstRadiusGen< TmplParticle >::Particle esys::lsm::ConstRadiusGen< TmplParticle >::getParticle ( const Vec3 posn) const

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

Parameters
posnThe position of the returned particle.
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
posnThe position of the returned particle.
maxRadiusThe suggested particle radius, ignored.
template<typename TmplParticle >
const double & esys::lsm::ConstRadiusGen< TmplParticle >::getParticleRadius ( ) const

Returns the radius of particles generated by the getParticle method.

template<typename TmplParticle >
bool esys::lsm::ConstRadiusGen< TmplParticle >::isValidFitRadius ( const double &  fitRadius) const

Returns whether fitRadius == this->getRadius()

Member Data Documentation

template<typename TmplParticle>
double esys::lsm::ConstRadiusGen< TmplParticle >::m_radius
private

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