DoFFamily.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* DoFFamily.h                                                 (C) 2000-2024 */
/*                                                                           */
/* Degree of Freedom Family (DoF)                                            */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_MESH_DOFFAMILY_H
#define ARCANE_MESH_DOFFAMILY_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ItemTypes.h"
#include "arcane/core/IMesh.h"
#include "arcane/core/IParallelMng.h"
#include "arcane/core/IDoFFamily.h"
 
#include "arcane/mesh/ItemFamily.h"
 
// can be removed, used only for ENUMERATE_ITEM_INTERNAL_MAP_DATA macro...
#include "arcane/mesh/DynamicMeshIncrementalBuilder.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::mesh
{
class DynamicMesh;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ARCANE_MESH_EXPORT DoFUids
{
 public:
 
  // item with one dof
  static Int64 uid(Int64 connected_item_uid) { return connected_item_uid; } // Trivial.
 
  // item with several dof
  static Int64 uid(Int64 max_dof_family_uid,
                   Int64 max_connected_item_family_uid,
                   Int64 connected_item_uid,
                   Int32 dof_index_in_item)
  {
    return connected_item_uid + (max_connected_item_family_uid + 1) * dof_index_in_item + max_dof_family_uid + 1;
  } // very temporary solution...
 
  // utilities
  static Int64 getMaxItemUid(IItemFamily* family);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ARCANE_MESH_EXPORT DoFFamily
: public ItemFamily
, public IItemFamilyModifier
, public IDoFFamily
{
 private:

  DoFFamily(IMesh* mesh, const String& name);
 
 public:
 
  // Implementation of IDoFFamily
  String name() const override { return ItemFamily::name(); }
  String fullName() const override { return ItemFamily::fullName(); }
  Integer nbItem() const override { return ItemFamily::nbItem(); }
  ItemGroup allItems() const override { return ItemFamily::allItems(); }
  void endUpdate() override { return ItemFamily::endUpdate(); }
  IItemFamily* itemFamily() override { return this; }
 
 public:
 
  Item allocOne(Int64 uid, ItemTypeId, MeshInfos&) override
  {
    return _allocDoF(uid);
  }
 
  ItemInternal* allocOne(Int64 uid)
  {
    return _allocDoF(uid);
  }
 
  // IItemFamilyModifier interface
  Item findOrAllocOne(Int64 uid, ItemTypeId, MeshInfos&, bool& is_alloc) override
  {
    auto dof = _findOrAllocDoF(uid, is_alloc);
    return dof;
  }
 
  ItemInternal* findOrAllocOne(Int64 uid, bool& is_alloc)
  {
    return _findOrAllocDoF(uid, is_alloc);
  }
 
  // IItemFamilyModifier interface
  IItemFamily* family() override { return this; }
 
  IDoFFamily* toDoFFamily() override { return this; }

  DoFVectorView addDoFs(Int64ConstArrayView dof_uids, Int32ArrayView dof_lids) override;

  DoFVectorView addGhostDoFs(Int64ConstArrayView dof_uids, Int32ArrayView dof_lids, Int32ConstArrayView owners) override;

  void computeSynchronizeInfos() override;
 
  DoFGroup allDoFs() { return ItemFamily::allItems(); }
  DoFGroup ownDoFs() { return ItemFamily::allItems().own(); }
  DoFGroup ghostDoFs() { return ItemFamily::allItems().ghost(); }
 
  void removeDoFs(Int32ConstArrayView items_local_id) override;
 
 private:
 
  void build() override; 
  void _addItems(Int64ConstArrayView unique_ids, Int32ArrayView items);
  void addGhostItems(Int64ConstArrayView unique_ids, Int32ArrayView items, Int32ConstArrayView owners) override;
  void _removeItems(Int32ConstArrayView local_ids, bool keep_ghost = false) { internalRemoveItems(local_ids, keep_ghost); };
  void internalRemoveItems(Int32ConstArrayView local_ids, bool keep_ghost = false) override;
  //  void compactItems(bool do_sort) {m_need_prepare_dump = false;} //! Overrides ItemFamily::compactItems because there is no compaction for DoFs for now.
 
  // FOR DEBUG
  void _printInfos(Integer nb_added);
 
 private:
 
  void preAllocate(Integer nb_item);
  ItemInternal* _allocDoF(const Int64 uid);
  ItemInternal* _allocDoFGhost(const Int64 uid, const Int32 owner);
  ItemInternal* _findOrAllocDoF(const Int64 uid, bool& is_alloc);
 
  ItemSharedInfoWithType* m_shared_info;
 
  friend class DynamicMesh;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane::mesh
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif