File: PackerGenerators.h

package info (click to toggle)
esys-particle 2.1-4
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 7,284 kB
  • sloc: cpp: 77,304; python: 5,647; makefile: 1,176; sh: 10
file content (180 lines) | stat: -rw-r--r-- 4,963 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
/////////////////////////////////////////////////////////////
//                                                         //
// Copyright (c) 2003-2011 by The University of Queensland //
// Earth Systems Science Computational Centre (ESSCC)      //
// http://www.uq.edu.au/esscc                              //
//                                                         //
// 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
  {
    /**
     * Generates particles of a specified constant radius.
     */
    template <typename TmplParticle>
    class ConstRadiusGen
    {
    public:
      typedef TmplParticle Particle;

      ConstRadiusGen(double radius);

      /**
       * Returns the radius of particles generated by the
       * getParticle method.
       */
      const double &getParticleRadius() const;

      /**
       * Returns the radius of particles generated by the
       * getParticle method.
       */
      const double &getMinFitRadius() const;

      /**
       * Returns the radius of particles generated by the
       * getParticle method.
       */
      const double &getMaxFitRadius() const;

      /**
       * Returns a particle of radius this->getParticleRadius().
       *
       * @param posn The position of the returned particle.
       */
      Particle getParticle(const Vec3 &posn) const;

      /**
       * Returns a particle of radius this->getParticleRadius().
       *
       * @param posn      The position of the returned particle.
       * @param maxRadius The suggested particle radius, ignored.
       */
      Particle getParticle(const Vec3 &posn, const double &maxRadius) const;

      /**
       * Returns whether fitRadius == this->getRadius()
       */
      bool isValidFitRadius(const double &fitRadius) const;

    private:
      double m_radius;
    };

    /**
     * Base class for generators which generate particles
     * whose radius ranges between a specified minimum and maximum.
     */
    template <typename TmplParticle>
    class RangeRadiusGen
    {
    public:
      typedef TmplParticle Particle;

      RangeRadiusGen(double minFitRadius, double maxFitRadius);

      virtual ~RangeRadiusGen();
      
      /**
       * Returns the radius of particles generated by the
       * getParticle method.
       */
      const double &getMinFitRadius() const;

      /**
       * Returns the radius of particles generated by the
       * getParticle method.
       */
      const double &getMaxFitRadius() const;

      /**
       * Returns whether fitRadius == this->getRadius()
       */
      bool isValidFitRadius(const double &fitRadius) const;

    private:
      double m_minFitRadius;
      double m_maxFitRadius;
    };

    /**
     * Class for generators which generate particles
     * whose radius is from a uniform random distribution.
     */
    template <typename TmplParticle>
    class RndRadiusGen : public RangeRadiusGen<TmplParticle>
    {
    public:
      typedef RangeRadiusGen<TmplParticle> Inherited;
      typedef typename Inherited::Particle Particle;

      RndRadiusGen(
        double minFitRadius,
        double maxFitRadius
      );

      /**
       * Returns a randomly generated radius value.
       */
      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