particle_iterator.h

// ---------------------------------------------------------------------
//
// Copyright (C) 2017 - 2018 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------

#ifndef dealii_particles_particle_iterator_h
#define dealii_particles_particle_iterator_h

#include <deal.II/base/config.h>
#include <deal.II/particles/particle_accessor.h>

DEAL_II_NAMESPACE_OPEN

namespace Particles
{
  template <int, int> class ParticleHandler;

  template<int dim, int spacedim=dim>
  class ParticleIterator
  {
  public:
    ParticleIterator () = default;

    ParticleIterator (const std::multimap<internal::LevelInd, Particle<dim,spacedim> > &map,
                      const typename std::multimap<internal::LevelInd, Particle<dim,spacedim> >::iterator &particle);

    const ParticleAccessor<dim,spacedim> &operator * () const;

    ParticleAccessor<dim,spacedim> &operator * ();

    ParticleIterator &operator = (const ParticleIterator &);

    const ParticleAccessor<dim,spacedim> *operator -> () const;

    ParticleAccessor<dim,spacedim> *operator -> ();

    bool operator == (const ParticleIterator<dim,spacedim> &) const;

    bool operator != (const ParticleIterator<dim,spacedim> &) const;

    ParticleIterator &operator ++ ();

    ParticleIterator operator ++ (int);

    ParticleIterator &operator -- ();

    ParticleIterator operator -- (int);

    typedef std::bidirectional_iterator_tag iterator_category;
    typedef ParticleAccessor<dim,spacedim>  value_type;
    typedef std::ptrdiff_t                  difference_type;
    typedef ParticleAccessor<dim,spacedim> *pointer;
    typedef ParticleAccessor<dim,spacedim> &reference;

  private:
    ParticleAccessor<dim,spacedim> accessor;
  };
}

DEAL_II_NAMESPACE_CLOSE

#endif