ESyS-Particle  2.3.4
esys::lsm::RndRadiusGen< TmplParticle > Class Template Reference

#include <PackerGenerators.h>

Inheritance diagram for esys::lsm::RndRadiusGen< TmplParticle >:
Collaboration diagram for esys::lsm::RndRadiusGen< TmplParticle >:

Public Types

typedef RangeRadiusGen< TmplParticle > Inherited
 
typedef Inherited::Particle Particle
 
- Public Types inherited from esys::lsm::RangeRadiusGen< TmplParticle >
typedef TmplParticle Particle
 

Public Member Functions

 RndRadiusGen (double minFitRadius, double maxFitRadius)
 
double getRandomRadius () const
 
Particle getParticle (const Vec3 &posn) const
 
Particle getParticle (const Vec3 &posn, double suggestedRadius) const
 
- Public Member Functions inherited from esys::lsm::RangeRadiusGen< TmplParticle >
 RangeRadiusGen (double minFitRadius, double maxFitRadius)
 
virtual ~RangeRadiusGen ()
 
const double & getMinFitRadius () const
 
const double & getMaxFitRadius () const
 
bool isValidFitRadius (const double &fitRadius) const
 

Detailed Description

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

Class for generators which generate particles whose radius is from a uniform random distribution.

Member Typedef Documentation

◆ Inherited

template<typename TmplParticle >
typedef RangeRadiusGen<TmplParticle> esys::lsm::RndRadiusGen< TmplParticle >::Inherited

◆ Particle

template<typename TmplParticle >
typedef Inherited::Particle esys::lsm::RndRadiusGen< TmplParticle >::Particle

Constructor & Destructor Documentation

◆ RndRadiusGen()

template<typename TmplParticle >
esys::lsm::RndRadiusGen< TmplParticle >::RndRadiusGen ( double  minFitRadius,
double  maxFitRadius 
)

Member Function Documentation

◆ getParticle() [1/2]

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

◆ getParticle() [2/2]

template<typename TmplParticle >
RndRadiusGen< TmplParticle >::Particle esys::lsm::RndRadiusGen< TmplParticle >::getParticle ( const Vec3 posn,
double  suggestedRadius 
) const

◆ getRandomRadius()

template<typename TmplParticle >
double esys::lsm::RndRadiusGen< TmplParticle >::getRandomRadius

Returns a randomly generated radius value.


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