Packer.h

//                                                         //
// 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_LSMPACKER_H
#define ESYS_LSMPACKER_H

#include "Geometry/CircularNeighbourTable.h"
#include "Geometry/ParticleCollection.h"
#include <boost/pool/object_pool.hpp>
#include <boost/shared_ptr.hpp>

#include <set>

namespace esys
{
  namespace lsm
  {
    template <typename TmplParticleCollection>
    class Packer
    {
    public:
      typedef TmplParticleCollection                     ParticleCollection;
      typedef Packer<ParticleCollection>                 PackerBase;
      typedef boost::shared_ptr<ParticleCollection>      ParticleCollectionPtr;
      typedef typename ParticleCollection::Particle      Particle;
      typedef boost::object_pool<Particle>               ParticlePool;
      typedef boost::shared_ptr<ParticlePool>            ParticlePoolPtr;
      typedef CircularNeighbourTable<Particle>           NTable;
      typedef boost::shared_ptr<NTable>                  NTablePtr;
      typedef
        typename ParticleCollection::ParticleIterator
        ParticleIterator;
      typedef
        typename ParticleCollection::ParticleConstIterator
        ParticleConstIterator;

      Packer(NTablePtr nTablePtr);

      Packer(ParticlePoolPtr particlePoolPtr, NTablePtr nTablePtr);

      virtual ~Packer();

      virtual void generate() = 0;

      int getNumParticles() const;

      int getNextParticleId();
      
      void setNTablePtr(NTablePtr nTablePtr);
      NTable &getNTable();
      const NTable &getNTable() const;

      ParticlePoolPtr getParticlePoolPtr();
      ParticlePool &getParticlePool();
      const ParticlePool &getParticlePool() const;

      ParticleCollection &getParticleCollection();
      const ParticleCollection &getParticleCollection() const;

      Particle &constructParticle(const Particle &particle);

      ParticleIterator getParticleIterator();

      ParticleConstIterator getParticleIterator() const;

      bool contains(const Particle &particle) const;

      Particle &createAndInsertParticle(const Particle &particle);

    protected:

      typedef std::set<int> IdSet;

    private:
      NTablePtr             m_nTablePtr;
      ParticlePoolPtr       m_particlePoolPtr;
      ParticleCollectionPtr m_particleCollectionPtr;
      IdSet                 m_idSet;
    };
  };
};

#include "Geometry/Packer.hpp"

#endif