IItemFamily.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IItemFamily.h                                               (C) 2000-2025 */
/*                                                                           */
/* Interface of an entity family.                                            */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IITEMFAMILY_H
#define ARCANE_CORE_IITEMFAMILY_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/core/ItemTypes.h"
#include "arcane/core/VariableTypedef.h"
#include "arcane/core/Parallel.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IItemFamily
{
  friend mesh::DynamicMesh;
  friend mesh::ItemFamily;
 
 public:
 
  virtual ~IItemFamily() {} //<! Frees resources
 
 public:
 
  virtual void build() = 0;
 
 public:

  virtual String name() const = 0;

  virtual String fullName() const = 0;

  virtual eItemKind itemKind() const = 0;

  virtual Integer nbItem() const = 0;

  virtual Int32 maxLocalId() const = 0;
 
 public:
 
  // TODO: to be removed. Use itemInfoListView instead
  virtual ItemInternalArrayView itemsInternal() = 0;
 
 public:

  virtual ItemInfoListView itemInfoListView() = 0;

  virtual IItemFamily* parentFamily() const = 0;

  virtual void setParentFamily(IItemFamily* parent) = 0;

  virtual Integer parentFamilyDepth() const = 0;

  virtual void addChildFamily(IItemFamily* family) = 0;

  virtual IItemFamilyCollection childFamilies() = 0;

  virtual VariableItemInt32& itemsNewOwner() = 0;

  virtual void checkValid() = 0;

  virtual void checkValidConnectivity() = 0;

  virtual void checkUniqueIds(Int64ConstArrayView unique_ids) = 0;
 
 public:

  virtual ItemVectorView view(Int32ConstArrayView local_ids) = 0;

  virtual ItemVectorView view() = 0;

  virtual void removeItems2(mesh::ItemDataList& item_data_list) = 0;

  virtual void removeNeedRemoveMarkedItems() = 0;

  ARCANE_DEPRECATED_REASON("Use MeshUtils::findOneItem() instead")
  virtual ItemInternal* findOneItem(Int64 unique_id) = 0;

  virtual void endUpdate() = 0;

  virtual void partialEndUpdate() = 0;

  virtual void partialEndUpdateGroup(const ItemGroup& group) = 0;

  virtual void partialEndUpdateVariable(IVariable* variable) = 0;

  virtual void notifyItemsOwnerChanged() = 0;

  virtual void notifyItemsUniqueIdChanged() = 0;
 
 public:

  virtual IItemConnectivityInfo* localConnectivityInfos() const = 0;

  virtual IItemConnectivityInfo* globalConnectivityInfos() const = 0;
 
 public:

  virtual void setHasUniqueIdMap(bool v) = 0;

  virtual bool hasUniqueIdMap() const = 0;
 
 public:

  virtual void itemsUniqueIdToLocalId(Int32ArrayView local_ids,
                                      Int64ConstArrayView unique_ids,
                                      bool do_fatal = true) const = 0;

  virtual void itemsUniqueIdToLocalId(Int32ArrayView local_ids,
                                      ConstArrayView<ItemUniqueId> unique_ids,
                                      bool do_fatal = true) const = 0;
 
 public:

  virtual void setItemSortFunction(IItemInternalSortFunction* sort_function) = 0;

  virtual IItemInternalSortFunction* itemSortFunction() const = 0;
 
 public:

  ARCCORE_DEPRECATED_2020("Do not use this method. Try to get 'ISubDomain' from another way")
  virtual ISubDomain* subDomain() const = 0;

  virtual ITraceMng* traceMng() const = 0;

  virtual IMesh* mesh() const = 0;

  virtual IParallelMng* parallelMng() const = 0;
 
 public:

  virtual ItemGroup allItems() const = 0;

  virtual ItemGroupCollection groups() const = 0;
 
 public:



  virtual ItemGroup findGroup(const String& name) const = 0;

  virtual ItemGroup findGroup(const String& name, bool create_if_needed) = 0;

  virtual ItemGroup createGroup(const String& name, Int32ConstArrayView local_ids, bool do_override = false) = 0;

  virtual ItemGroup createGroup(const String& name) = 0;

  virtual void destroyGroups() = 0;

  virtual ItemGroup createGroup(const String& name, const ItemGroup& parent, bool do_override = false) = 0;


  virtual IVariable* findVariable(const String& name, bool throw_exception = false) = 0;

  virtual void usedVariables(VariableCollection collection) = 0;
 
 public:

  virtual void prepareForDump() = 0;

  virtual void readFromDump() = 0;

  virtual void copyItemsValues(Int32ConstArrayView source, Int32ConstArrayView destination) = 0;

  virtual void copyItemsMeanValues(Int32ConstArrayView first_source,
                                   Int32ConstArrayView second_source,
                                   Int32ConstArrayView destination) = 0;

  virtual void clearItems() = 0;

  virtual void compactItems(bool do_sort) = 0;
 
 public:

  virtual void computeSynchronizeInfos() = 0;

  virtual void getCommunicatingSubDomains(Int32Array& sub_domains) const = 0;



  virtual IVariableSynchronizer* allItemsSynchronizer() = 0;

  virtual void synchronize(VariableCollection variables) = 0;
 
  // TODO: make pure virtual (December 2024)
  virtual void synchronize(VariableCollection variables, Int32ConstArrayView local_ids);

  virtual void reduceFromGhostItems(IVariable* v, IDataOperation* operation) = 0;
  virtual void reduceFromGhostItems(IVariable* v, Parallel::eReduceType operation) = 0;

  ARCANE_DEPRECATED_REASON("Y2024: use findAdjacency() instead")
  virtual ItemPairGroup findAdjencyItems(const ItemGroup& group,
                                         const ItemGroup& sub_group,
                                         eItemKind link_kind,
                                         Integer nb_layer) = 0;
  virtual ItemPairGroup findAdjacencyItems(const ItemGroup& group,
                                           const ItemGroup& sub_group,
                                           eItemKind link_kind,
                                           Integer nb_layer);

  virtual IParticleFamily* toParticleFamily() = 0;

  virtual IDoFFamily* toDoFFamily() { return nullptr; }

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

  virtual void addSourceConnectivity(IItemConnectivity* connectivity) = 0;
  virtual void addTargetConnectivity(IItemConnectivity* connectivity) = 0;
  virtual void removeSourceConnectivity(IItemConnectivity* connectivity) = 0;
  virtual void removeTargetConnectivity(IItemConnectivity* connectivity) = 0;
  virtual void setConnectivityMng(IItemConnectivityMng* connectivity_mng) = 0;

  virtual void addGhostItems(Int64ConstArrayView unique_ids, Int32ArrayView items,
                             Int32ConstArrayView owners) = 0;
 
 public:

  virtual IItemFamilyPolicyMng* policyMng() = 0;

  virtual Properties* properties() = 0;
 
 public:

  virtual EventObservableView<const ItemFamilyItemListChangedEventArgs&> itemListChangedEvent() = 0;
 
 public:

  virtual void experimentalChangeUniqueId(ItemLocalId local_id, ItemUniqueId unique_id) = 0;
 
 public:

  virtual void resizeVariables(bool force_resize) = 0;
 
 public:

  virtual IItemFamilyTopologyModifier* _topologyModifier() = 0;
 
 public:

  virtual IItemFamilyInternal* _internalApi() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif