PackerGenerators.h

Go to the documentation of this file.

//                                                         //
// Copyright (c) 2003-2014 by The University of Queensland //
// Centre for Geoscience Computing                         //
// http://earth.uq.edu.au/centre-geoscience-computing      //
//                                                         //
// Primary Business: Brisbane, Queensland, Australia       //
// Licensed under the Open Software License version 3.0    //
// http://www.opensource.org/licenses/osl-3.0.php          //
//                                                         //


#ifndef ESYS_LSMPACKERGENERATORS_H
#define ESYS_LSMPACKERGENERATORS_H

#include "Foundation/vec3.h"

namespace esys
{
  namespace lsm
  {
    template <typename TmplParticle>
    class ConstRadiusGen
    {
    public:
      typedef TmplParticle Particle;

      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:
      double m_radius;
    };

    template <typename TmplParticle>
    class RangeRadiusGen
    {
    public:
      typedef TmplParticle Particle;

      RangeRadiusGen(double minFitRadius, double maxFitRadius);

      virtual ~RangeRadiusGen();
      
      const double &getMinFitRadius() const;

      const double &getMaxFitRadius() const;

      bool isValidFitRadius(const double &fitRadius) const;

    private:
      double m_minFitRadius;
      double m_maxFitRadius;
    };

    template <typename TmplParticle>
    class RndRadiusGen : public RangeRadiusGen<TmplParticle>
    {
    public:
      typedef RangeRadiusGen<TmplParticle> Inherited;
      typedef typename Inherited::Particle Particle;

      RndRadiusGen(
        double minFitRadius,
        double maxFitRadius
      );

      double getRandomRadius() const;

      Particle getParticle(const Vec3 &posn) const;

      Particle getParticle(const Vec3 &posn, double suggestedRadius) const;

    private:
    };

    template <typename TmplGrain>
    class GrainRndRadiusGen : public RndRadiusGen<typename TmplGrain::Particle>
    {
    public:
      typedef RndRadiusGen<typename TmplGrain::Particle> Inherited;
      typedef TmplGrain                                  Grain;
      typedef typename Grain::Particle                   Particle;

      GrainRndRadiusGen(double minGrainRadius, double maxGrainRadius);

      virtual ~GrainRndRadiusGen();

      const double &getMinGrainRadius() const;

      const double &getMaxGrainRadius() const;

      virtual Grain getGrain(const Particle &p) = 0;
    };

    template <typename TmplGrain>
    class SingleParticleGrainGen : public GrainRndRadiusGen<TmplGrain>
    {
    public:
      typedef GrainRndRadiusGen<TmplGrain> Inherited;
      typedef typename Inherited::Grain    Grain;
      typedef typename Grain::Particle     Particle;

      SingleParticleGrainGen(double minGrainRadius, double maxGrainRadius);

      const double &getMinParticleRadius() const;

      const double &getMaxParticleRadius() const;

      virtual Grain getGrain(const Particle &p);
    };
  }
}

#include "Geometry/PackerGenerators.hpp"

#endif