CellFamily.h

// -*- 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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* CellFamily.h                                                (C) 2000-2024 */
/*                                                                           */
/* Cell Family.                                                              */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_MESH_CELLFAMILY_H
#define ARCANE_MESH_CELLFAMILY_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/IItemFamilyModifier.h"
 
#include "arcane/mesh/ItemFamily.h"
#include "arcane/mesh/ItemInternalConnectivityIndex.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::mesh
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class NodeFamily;
class EdgeFamily;
class FaceFamily;
class CellFamily;
class HParentCellCompactIncrementalItemConnectivity;
class HChildCellCompactIncrementalItemConnectivity;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_MESH_EXPORT CellFamily
: public ItemFamily
, public IItemFamilyModifier
{
  class TopologyModifier;
  typedef ItemConnectivitySelectorT<NodeInternalConnectivityIndex, IncrementalItemConnectivity> NodeConnectivity;
  typedef ItemConnectivitySelectorT<EdgeInternalConnectivityIndex, IncrementalItemConnectivity> EdgeConnectivity;
  typedef ItemConnectivitySelectorT<FaceInternalConnectivityIndex, IncrementalItemConnectivity> FaceConnectivity;
  typedef ItemConnectivitySelectorT<HParentInternalConnectivityIndex, IncrementalItemConnectivity> HParentConnectivity;
  typedef ItemConnectivitySelectorT<HChildInternalConnectivityIndex, IncrementalItemConnectivity> HChildConnectivity;
 
 public:
 
  CellFamily(IMesh* mesh, const String& name);
  virtual ~CellFamily(); //<! Releases resources
 
 public:
 
  virtual void build() override;
  virtual void preAllocate(Integer nb_item);
 
 public:
 
  // IItemFamilyModifier interface
  Item allocOne(Int64 uid, ItemTypeId type_id, MeshInfos& mesh_info) override;
  Item findOrAllocOne(Int64 uid, ItemTypeId type_id, MeshInfos& mesh_info, bool& is_alloc) override;
  IItemFamily* family() override { return this; }
 
  Cell allocOne(Int64 uid, ItemTypeId type);
  Cell findOrAllocOne(Int64 uid, ItemTypeId type_id, bool& is_alloc);

  void removeCell(Cell cell);

  void removeCells(ConstArrayView<Int32> cells_local_id);

  void detachCell(Cell cell);

  void detachCells2(Int32ConstArrayView cell_local_ids);

  void removeDetachedCell(Cell cell);

  virtual void internalRemoveItems(Int32ConstArrayView local_ids, bool keep_ghost = false) override;


  void setConnectivity(const Integer c);
 
 public:
 
  // TODO: make these methods private to enforce the use of IItemFamilyTopologyModifier.
  void replaceNode(ItemLocalId cell, Integer index, ItemLocalId node);
  void replaceEdge(ItemLocalId cell, Integer index, ItemLocalId edge);
  void replaceFace(ItemLocalId cell, Integer index, ItemLocalId face);
  void replaceHChild(ItemLocalId cell, Integer index, ItemLocalId child_cell);
  void replaceHParent(ItemLocalId cell, Integer index, ItemLocalId parent_cell);
 
 public:

  void _addParentCellToCell(Cell cell, Cell parent_cell);
  void _addChildCellToCell(Cell parent_cell, Integer rank, Cell child_cell);
  void _addChildCellToCell2(Cell parent_cell, Cell child_cell);
  void _addChildrenCellsToCell(Cell parent_cell, Int32ConstArrayView children_cells_lid);
  void _removeParentCellToCell(Cell cell);
  void _removeChildCellToCell(Cell parent_cell, Cell cell);
  void _removeChildrenCellsToCell(Cell parent_cell);
 
 public:
 
  virtual void computeSynchronizeInfos() override;
 
 public:
 
  ARCANE_DEPRECATED_REASON("Y2022: Use allocOne(Int64 uid,ItemTypeId type) instead")
  ItemInternal* allocOne(Int64 uid, ItemTypeInfo* type);
 
  ARCANE_DEPRECATED_REASON("Y2022: Use findOrAllocOne(Int64 uid,ItemTypeId type_id,bool& is_alloc) instead")
  ItemInternal* findOrAllocOne(Int64 uid, ItemTypeInfo* type, bool& is_alloc);
 
 protected:
 private:
 
  Integer m_node_prealloc;
  Integer m_edge_prealloc;
  Integer m_face_prealloc;
  Integer m_mesh_connectivity;
 
  NodeFamily* m_node_family;
  EdgeFamily* m_edge_family;
  FaceFamily* m_face_family;
 
  NodeConnectivity* m_node_connectivity;
  EdgeConnectivity* m_edge_connectivity;
  FaceConnectivity* m_face_connectivity;
  HParentConnectivity* m_hparent_connectivity;
  HChildConnectivity* m_hchild_connectivity;
 
 private:

  void _removeSubItems(Cell cell);
 
  void _removeNotConnectedSubItems(Cell cell);
  inline void _createOne(ItemInternal* item, Int64 uid, ItemTypeInfo* type);
  inline void _createOne(ItemInternal* item, Int64 uid, ItemTypeId type_id);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane::mesh
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif