File: ParticleCollection.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 (169 lines) | stat: -rw-r--r-- 4,606 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
/////////////////////////////////////////////////////////////
//                                                         //
// 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_LSMPARTICLECOLLECTION_H
#define ESYS_LSMPARTICLECOLLECTION_H

#include "Foundation/BoundingBox.h"
#include "Foundation/StlIterator.h"
#include "Geometry/Vec3L.h"

#include <boost/shared_ptr.hpp>
#include <boost/pool/object_pool.hpp>

#include <vector>
#include <float.h>

namespace esys
{
  namespace lsm
  {
    /**
     *
     */
    template <typename TmplParticle>
    class ParticleCollection
    {
    public:
      typedef TmplParticle Particle;
      typedef boost::object_pool<Particle>         ParticlePool;
      typedef boost::shared_ptr<ParticlePool>      ParticlePoolPtr;

    private:
      typedef std::vector<Particle *>              ParticleVector;
      typedef ForwardIterator<ParticleVector>      VectorIterator;
      typedef ForwardConstIterator<ParticleVector> VectorConstIterator;

    public:

      class ParticleIterator : public VectorIterator
      {
      public:
        typedef Particle& value_type;
        ParticleIterator(const VectorIterator &it)
         : VectorIterator(it)
        {
        }

        value_type next()
        {
          return *(VectorIterator::next());
        }

        value_type current() const
        {
          return *(VectorIterator::current());
        }
      };

      class ParticleConstIterator : public VectorConstIterator
      {
      public:
        typedef const Particle& value_type;
        ParticleConstIterator(const VectorConstIterator &it)
         : VectorConstIterator(it)
        {
        }

        ParticleConstIterator(const VectorIterator &it)
         : VectorConstIterator(it)
        {
        }

        value_type next()
        {
          return *(VectorConstIterator::next());
        }

        value_type current() const
        {
          return *(VectorConstIterator::current());
        }
      };

      ParticleCollection();

      ParticleCollection(ParticlePoolPtr particlePoolPtr);

      ParticleCollection(const ParticleCollection &p);

      ParticleCollection &operator=(const ParticleCollection &p);
      
      virtual ~ParticleCollection();

      int getNumParticles() const;

      BoundingBox getParticleBBox() const;

      ParticleIterator getParticleIterator()
      {
        return ParticleIterator(VectorIterator(m_particleVector));
      }

      ParticleConstIterator getParticleIterator() const
      {
        return ParticleConstIterator(VectorConstIterator(m_particleVector));
      }

      /**
       * Translates all particle positions by the specified mount.
       *
       * @param vec Translation increment.
       */
      void translateBy(const Vec3 &vec);

      /**
       * Rotates all particles according to the specified rotation.
       *
       * @param rotation Specifies rotation-axis and magnitude,
       *                 ie angle = rotation.norm() radians.
       * @param posn Specifies position of the rotation vector.
       */
      void rotate(const Vec3 &rotation, const Vec3 &posn);

      /**
       * Increments all particle Id's by the specifed amount.
       *
       * @param idIncr Increment.
       */
      void incrementIdBy(typename Particle::Id idIncr);

      /**
       * Adds the specifed particle reference to this collection.
       * @param p Reference to p is inserted.
       */
      void insertRef(Particle &p);

      /**
       * Creates a new particle constructed particle from p.
       * @param p Create particle copy constructed from p.
       * @return returns reference to newly constructed particle.
       */
      Particle &createParticle(const Particle &p);

    protected:
      /**
       * Adds the specifed particle reference to this collection.
       * @param p Reference to p is inserted.
       */
      void noCheckInsertRef(Particle &p);

    private:
      ParticlePoolPtr m_particlePoolPtr;
      ParticleVector  m_particleVector;
    };
  };
};

#include "Geometry/ParticleCollection.hpp"

#endif