particle_iterator.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2017 - 2023 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
#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:
    using particle_container =
      typename ParticleAccessor<dim, spacedim>::particle_container;
 
    ParticleIterator() = default;
 
    ParticleIterator(
      const typename particle_container::iterator particles_in_cell,
      const PropertyPool<dim, spacedim>          &property_pool,
      const unsigned int                          particle_index_within_cell);
 
    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);
 
    IteratorState::IteratorStates
    state() const;
 
    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;
  };
 
 
 
  // ------------------------------ inline functions -------------------------
 
  template <int dim, int spacedim>
  inline ParticleIterator<dim, spacedim>::ParticleIterator(
    const typename particle_container::iterator particles_in_cell,
    const PropertyPool<dim, spacedim>          &property_pool,
    const unsigned int                          particle_index_within_cell)
    : accessor(particles_in_cell, property_pool, particle_index_within_cell)
  {}
 
 
 
  template <int dim, int spacedim>
  inline ParticleAccessor<dim, spacedim> &
  ParticleIterator<dim, spacedim>::operator*()
  {
    return accessor;
  }
 
 
 
  template <int dim, int spacedim>
  inline ParticleAccessor<dim, spacedim> *
  ParticleIterator<dim, spacedim>::operator->()
  {
    return &(this->operator*());
  }
 
 
 
  template <int dim, int spacedim>
  inline const ParticleAccessor<dim, spacedim> &
  ParticleIterator<dim, spacedim>::operator*() const
  {
    return accessor;
  }
 
 
 
  template <int dim, int spacedim>
  inline const ParticleAccessor<dim, spacedim> *
  ParticleIterator<dim, spacedim>::operator->() const
  {
    return &(this->operator*());
  }
 
 
 
  template <int dim, int spacedim>
  inline bool
  ParticleIterator<dim, spacedim>::operator!=(
    const ParticleIterator<dim, spacedim> &other) const
  {
    return accessor != other.accessor;
  }
 
 
 
  template <int dim, int spacedim>
  inline bool
  ParticleIterator<dim, spacedim>::operator==(
    const ParticleIterator<dim, spacedim> &other) const
  {
    return accessor == other.accessor;
  }
 
 
 
  template <int dim, int spacedim>
  inline ParticleIterator<dim, spacedim> &
  ParticleIterator<dim, spacedim>::operator++()
  {
    accessor.next();
    return *this;
  }
 
 
 
  template <int dim, int spacedim>
  inline ParticleIterator<dim, spacedim>
  ParticleIterator<dim, spacedim>::operator++(int)
  {
    ParticleIterator tmp(*this);
    operator++();
 
    return tmp;
  }
 
 
 
  template <int dim, int spacedim>
  inline ParticleIterator<dim, spacedim> &
  ParticleIterator<dim, spacedim>::operator--()
  {
    accessor.prev();
    return *this;
  }
 
 
 
  template <int dim, int spacedim>
  inline ParticleIterator<dim, spacedim>
  ParticleIterator<dim, spacedim>::operator--(int)
  {
    ParticleIterator tmp(*this);
    operator--();
 
    return tmp;
  }
 
 
 
  template <int dim, int spacedim>
  inline IteratorState::IteratorStates
  ParticleIterator<dim, spacedim>::state() const
  {
    return accessor.state();
  }
 
} // namespace Particles
 
DEAL_II_NAMESPACE_CLOSE
 
#endif