IMeshModifier.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IMeshModifier.h                                             (C) 2000-2025 */
/*                                                                           */
/* Mesh modification interface.                                              */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IMESHMODIFIER_H
#define ARCANE_CORE_IMESHMODIFIER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/core/Item.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IMesh;
class IExtraGhostCellsBuilder;
class IExtraGhostParticlesBuilder;
class IAMRTransportFunctor;
class IMeshModifierInternal;
class IMeshModifier;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class MeshModifierAddCellsArgs
{
 public:
 
  MeshModifierAddCellsArgs(Integer nb_cell, Int64ConstArrayView cell_infos)
  : m_nb_cell(nb_cell)
  , m_cell_infos(cell_infos)
  {}
 
  MeshModifierAddCellsArgs(Integer nb_cell, Int64ConstArrayView cell_infos,
                           Int32ArrayView cell_lids)
  : MeshModifierAddCellsArgs(nb_cell, cell_infos)
  {
    m_cell_lids = cell_lids;
  }
 
 public:
 
  Int32 nbCell() const { return m_nb_cell; }
  Int64ConstArrayView cellInfos() const { return m_cell_infos; }
  Int32ArrayView cellLocalIds() const { return m_cell_lids; }

  void setAllowBuildFaces(bool v) { m_is_allow_build_faces = v; }
  bool isAllowBuildFaces() const { return m_is_allow_build_faces; }
 
 private:
 
  Int32 m_nb_cell = 0;
  Int64ConstArrayView m_cell_infos;
  Int32ArrayView m_cell_lids;
  bool m_is_allow_build_faces = true;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class MeshModifierAddFacesArgs
{
 public:
 
  MeshModifierAddFacesArgs(Int32 nb_face, Int64ConstArrayView face_infos)
  : m_nb_face(nb_face)
  , m_face_infos(face_infos)
  {}
 
  MeshModifierAddFacesArgs(Int32 nb_face, Int64ConstArrayView face_infos,
                           Int32ArrayView face_lids)
  : MeshModifierAddFacesArgs(nb_face, face_infos)
  {
    m_face_lids = face_lids;
  }
 
 public:
 
  Int32 nbFace() const { return m_nb_face; }
  Int64ConstArrayView faceInfos() const { return m_face_infos; }
  Int32ArrayView faceLocalIds() const { return m_face_lids; }
 
 private:
 
  Int32 m_nb_face = 0;
  Int64ConstArrayView m_face_infos;
  Int32ArrayView m_face_lids;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IMeshModifier
{
 public:
 
  virtual ~IMeshModifier() {} //<! Releases resources
 
 public:
 
  virtual void build() = 0;
 
 public:

  virtual IMesh* mesh() = 0;
 
 public:

  virtual void setDynamic(bool v) = 0;

  virtual void addCells(Integer nb_cell, Int64ConstArrayView cell_infos,
                        Int32ArrayView cells_lid = Int32ArrayView()) = 0;

  virtual void addCells(const MeshModifierAddCellsArgs& args);

  virtual void addFaces(Integer nb_face, Int64ConstArrayView face_infos,
                        Int32ArrayView face_lids = Int32ArrayView()) = 0;

  virtual void addFaces(const MeshModifierAddFacesArgs& args);

  virtual void addEdges(Integer nb_edge, Int64ConstArrayView edge_infos,
                        Int32ArrayView edge_lids = Int32ArrayView()) = 0;

  virtual void addNodes(Int64ConstArrayView nodes_uid,
                        Int32ArrayView nodes_lid = Int32ArrayView()) = 0;

  virtual void removeCells(Int32ConstArrayView cells_local_id) = 0;
 
  virtual void removeCells(Int32ConstArrayView cells_local_id, bool update_ghost) = 0;

  virtual void detachCells(Int32ConstArrayView cells_local_id) = 0;

  virtual void removeDetachedCells(Int32ConstArrayView cells_local_id) = 0;

  virtual void flagCellToRefine(Int32ConstArrayView cells_lids) = 0;
  virtual void flagCellToCoarsen(Int32ConstArrayView cells_lids) = 0;
  virtual void refineItems() = 0;
  virtual void coarsenItems() = 0;
  virtual void coarsenItemsV2(bool update_parent_flag) = 0;
  virtual bool adapt() = 0;
  virtual void registerCallBack(IAMRTransportFunctor* f) = 0;
  virtual void unRegisterCallBack(IAMRTransportFunctor* f) = 0;
  virtual void addHChildrenCells(Cell parent_cell, Integer nb_cell,
                                 Int64ConstArrayView cells_infos, Int32ArrayView cells_lid = Int32ArrayView()) = 0;
 
  virtual void addParentCellToCell(Cell child, Cell parent) = 0;
  virtual void addChildCellToCell(Cell parent, Cell child) = 0;
 
  virtual void addParentFaceToFace(Face child, Face parent) = 0;
  virtual void addChildFaceToFace(Face parent, Face child) = 0;
 
  virtual void addParentNodeToNode(Node child, Node parent) = 0;
  virtual void addChildNodeToNode(Node parent, Node child) = 0;

  virtual void clearItems() = 0;

  ARCANE_DEPRECATED_240 virtual void addCells(ISerializer* buffer) = 0;

  ARCANE_DEPRECATED_240 virtual void addCells(ISerializer* buffer, Int32Array& cells_local_id) = 0;

  virtual void endUpdate() = 0;
 
  virtual void endUpdate(bool update_ghost_layer, bool remove_old_ghost) = 0; // SDC: this signature is needed @IFPEN.
 
 public:

  virtual void updateGhostLayers() = 0;

  virtual void updateGhostLayerFromParent(Array<Int64>& ghost_cell_to_refine,
                                          Array<Int64>& ghost_cell_to_coarsen,
                                          bool remove_old_ghost) = 0;

  virtual void addExtraGhostCellsBuilder(IExtraGhostCellsBuilder* builder) = 0;

  virtual void removeExtraGhostCellsBuilder(IExtraGhostCellsBuilder* builder) = 0;

  virtual void addExtraGhostParticlesBuilder(IExtraGhostParticlesBuilder* builder) = 0;

  virtual void removeExtraGhostParticlesBuilder(IExtraGhostParticlesBuilder* builder) = 0;
 
 public:

  virtual void mergeMeshes(ConstArrayView<IMesh*> meshes) = 0;
 
 public:

  virtual IMeshModifierInternal* _modifierInternalApi() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif