ItemFamilyNetwork.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ItemFamilyNetwork.h                                         (C) 2000-2024 */
/*                                                                           */
/* ItemFamily relations through their connectivities.                        */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_MESH_ITEMFAMILYNETWORK_H
#define ARCANE_MESH_ITEMFAMILYNETWORK_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include <map>
#include <set>
 
#include "arcane/utils/ArcaneGlobal.h"
#include "arcane/utils/ITraceMng.h"
#include "arcane/utils/DirectedGraphT.h"
#include "arcane/utils/DirectedAcyclicGraphT.h"
#include "arcane/utils/List.h"
#include "arcane/core/IItemFamily.h"
#include "arcane/core/IIncrementalItemConnectivity.h"
#include "arcane/mesh/MeshGlobal.h"
 
#include "arcane/core/IGraph2.h"
#include "arcane/core/IGraphModifier2.h"
#include "arcane/core/IItemFamilyNetwork.h"
#include "arcane/utils/NotImplementedException.h" //tmp !
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane::mesh
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ARCANE_MESH_EXPORT ItemFamilyNetwork
: public IItemFamilyNetwork
{
 public:

  ItemFamilyNetwork(ITraceMng* trace_mng)
  : m_relation_graph(trace_mng)
  , m_dependency_graph(trace_mng)
  {}

  virtual ~ItemFamilyNetwork()
  {
    for (auto connectivity : m_connectivity_list) {
      delete connectivity;
    }
  }
 
 public:
 
  bool isActivated() const override
  {
    return m_is_activated;
  }

  void addDependency(IItemFamily* master_family, IItemFamily* slave_family, IIncrementalItemConnectivity* master_to_slave_connectivity, bool is_deep_connectivity) override;

  void addRelation(IItemFamily* source_family, IItemFamily* target_family, IIncrementalItemConnectivity* source_to_target_connectivity) override;
 
  IIncrementalItemConnectivity* getDependency(IItemFamily* source_family, IItemFamily* target_family) override;
  IIncrementalItemConnectivity* getRelation(IItemFamily* source_family, IItemFamily* target_family) override;

  IIncrementalItemConnectivity* getConnectivity(IItemFamily* source_family, IItemFamily* target_family, const String& name) override;
  IIncrementalItemConnectivity* getConnectivity(IItemFamily* source_family, IItemFamily* target_family, const String& name, bool& is_dependency) override;

  IIncrementalItemConnectivity* getStoredConnectivity(IItemFamily* source_family, IItemFamily* target_family, const String& name) override;
  IIncrementalItemConnectivity* getStoredConnectivity(IItemFamily* source_family, IItemFamily* target_family, const String& name, bool& is_dependency) override;

  List<IIncrementalItemConnectivity*> getConnectivities() override;

  SharedArray<IIncrementalItemConnectivity*> getChildConnectivities(IItemFamily* source_family) override;
  SharedArray<IIncrementalItemConnectivity*> getParentConnectivities(IItemFamily* target_family) override;

  SharedArray<IIncrementalItemConnectivity*> getChildDependencies(IItemFamily* source_family) override;
  SharedArray<IIncrementalItemConnectivity*> getParentDependencies(IItemFamily* target_family) override;

  SharedArray<IIncrementalItemConnectivity*> getChildRelations(IItemFamily* source_family) override;
  SharedArray<IIncrementalItemConnectivity*> getParentRelations(IItemFamily* target_family) override;

  const std::set<IItemFamily*>& getFamilies() const override { return m_families; }
 
  SharedArray<IItemFamily*> getFamilies(eSchedulingOrder order) const override;

  void schedule(IItemFamilyNetworkTask task, eSchedulingOrder order = TopologicalOrder) override;

  void setIsStored(IIncrementalItemConnectivity* connectivity) override;

  bool isStored(IIncrementalItemConnectivity* connectivity) override;
 
  bool isDeep(IIncrementalItemConnectivity* connectivity) override;
 
  Integer registerConnectedGraph(IGraph2* graph) override;
 
  void releaseConnectedGraph(Integer graph_id) override;
 
  void removeConnectedDoFsFromCells(Int32ConstArrayView local_ids) override;
 
 private:
 
  bool m_is_activated = false;
  using ConnectivityGraph = GraphBaseT<IItemFamily*, IIncrementalItemConnectivity*>;
  mutable DirectedGraphT<IItemFamily*, IIncrementalItemConnectivity*> m_relation_graph;
  mutable DirectedAcyclicGraphT<IItemFamily*, IIncrementalItemConnectivity*> m_dependency_graph;
 
  // NOTE GG: It would be necessary to use List<Ref<IIncrementalItemConnectivity>>
  // but this changes the interface of this class because of the method
  // getConnectivities(). To check with Stéphane regarding the modification
  List<IIncrementalItemConnectivity*> m_connectivity_list;
 
  std::map<IIncrementalItemConnectivity*, std::pair<bool, bool>> m_connectivity_status; // bool = is_stored
  std::set<IItemFamily*> m_families;
 
  UniqueArray<IGraph2*> m_registred_graphs;
 
 private:
 
  void _checkConnectivityName(IIncrementalItemConnectivity* connectivity, const String& name);
  std::pair<IIncrementalItemConnectivity* const, std::pair<bool, bool>>& _getConnectivityStatus(IIncrementalItemConnectivity* connectivity);
  SharedArray<IIncrementalItemConnectivity*> _getConnectivitiesFromGraph(const ConnectivityGraph::ConnectedEdgeSet& connectivity_edges);
  SharedArray<IIncrementalItemConnectivity*> _getConnectivitiesFromGraph(const ConnectivityGraph::ConnectedEdgeSet& connectivity_edges1, const ConnectivityGraph::ConnectedEdgeSet& connectivity_edges2);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane::mesh
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif