ItemConnectedEnumerator.h

Go to the documentation of this file.

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ItemConnectedEnumerator.h                                   (C) 2000-2023 */
/*                                                                           */
/* Enumerators for connected entities of the mesh.                           */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_ITEMCONNECTEDENUMERATOR_H
#define ARCANE_ITEMCONNECTEDENUMERATOR_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/Item.h"
#include "arcane/core/ItemConnectedEnumeratorBase.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ItemConnectedEnumerator
: public ItemConnectedEnumeratorBaseT<Item>
{
  friend class ItemGroup;
  friend class ItemVector;
  friend class ItemVectorView;
  friend class ItemPairEnumerator;
  template <int Extent> friend class ItemConnectedListView;
  // NOTE: Normally, it would suffice to do this:
  //   template<class T> friend class ItemConnectedEnumeratorBase;
  // but this does not work with GCC 8. So we do the specialization
  // manually
  friend class ItemConnectedEnumeratorBaseT<Item>;
  friend class ItemConnectedEnumeratorBaseT<Node>;
  friend class ItemConnectedEnumeratorBaseT<ItemWithNodes>;
  friend class ItemConnectedEnumeratorBaseT<Edge>;
  friend class ItemConnectedEnumeratorBaseT<Face>;
  friend class ItemConnectedEnumeratorBaseT<Cell>;
  friend class ItemConnectedEnumeratorBaseT<Particle>;
  friend class ItemConnectedEnumeratorBaseT<DoF>;
 
 public:
 
  using BaseClass = ItemConnectedEnumeratorBaseT<Item>;
 
 public:
 
  ItemConnectedEnumerator() = default;
 
 public:
 
  ItemConnectedEnumerator(const impl::ItemIndexedListView<DynExtent>& rhs)
  : BaseClass(rhs)
  {}
 
  template <int E> ItemConnectedEnumerator(const ItemConnectedListView<E>& rhs)
  : BaseClass(ItemConnectedListViewT<Item, E>(rhs))
  {}
 
 protected:
 
  ItemConnectedEnumerator(ItemSharedInfo* s, const Int32ConstArrayView& local_ids)
  : BaseClass(s, local_ids)
  {}
 
 private:
 
  ItemConnectedEnumerator(const Int32* local_ids, Int32 index, Int32 n, Item item_base)
  : BaseClass(local_ids, index, n, item_base)
  {}
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <typename ItemType>
class ItemConnectedEnumeratorT
: public ItemConnectedEnumeratorBaseT<ItemType>
{
  using BaseClass = ItemConnectedEnumeratorBaseT<ItemType>;
 
 public:
 
  ItemConnectedEnumeratorT() = default;
  template <int E> ItemConnectedEnumeratorT(const ItemConnectedListView<E>& rhs)
  : BaseClass(rhs)
  {}
  ItemConnectedEnumeratorT(const ItemConnectedListViewT<ItemType>& rhs)
  : BaseClass(rhs)
  {}
 
 private:
 
  ItemConnectedEnumeratorT(ItemSharedInfo* s, const Int32ConstArrayView& local_ids)
  : BaseClass(s, local_ids)
  {}
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

#ifdef ARCANE_USE_SPECIFIC_ITEMCONNECTED
 
#define ENUMERATE_CONNECTED_(type, iterator_name, item, connectivity_func) \
  for (::Arcane::ItemConnectedEnumeratorT<type> iterator_name((item).connectivity_func); iterator_name.hasNext(); ++iterator_name)
 
#else
 
#define ENUMERATE_CONNECTED_(type, iterator_name, item, connectivity_func) \
  for (::Arcane::ItemEnumeratorT<type> iterator_name((item).connectivity_func); iterator_name.hasNext(); ++iterator_name)
 
#endif
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif