particle_iterator.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2017 - 2019 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.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------

#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
{
  // Forward declaration
#ifndef DOXYGEN
  template <int, int>
  class ParticleHandler;
#endif

  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*();

    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);

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

  private:
    ParticleAccessor<dim, spacedim> accessor;
  };
} // namespace Particles

DEAL_II_NAMESPACE_CLOSE

#endif