src/arcane/cartesianmesh/ICartesianMesh.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2024 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ICartesianMesh.h                                            (C) 2000-2024 */
/*                                                                           */
/* Interface d'un maillage cartésien.                                        */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CARTESIANMESH_ICARTESIANMESH_H
#define ARCANE_CARTESIANMESH_ICARTESIANMESH_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/core/MeshHandle.h"
 
#include "arcane/cartesianmesh/CartesianMeshGlobal.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*!
 * \ingroup ArcaneCartesianMesh
 * \brief Interface d'un maillage cartésien.
 */
class ARCANE_CARTESIANMESH_EXPORT ICartesianMesh
{
 public:
 
  virtual ~ICartesianMesh() {} //<! Libère les ressources
 
  /*!
   * \brief Récupère ou créé la référence associée à \a mesh.
   *
   * Si aucun gestionnaire de matériau n'est associé à \a mesh, il
   * sera créé lors de l'appel à cette méthode si \a create vaut \a true.
   * Si \a create vaut \a false est qu'aucune gestionnaire n'est associé
   * au maillage, un pointeur nul est retourné.
   * L'instance retournée reste valide tant que le maillage \a mesh existe.
   */
  static ICartesianMesh* getReference(const MeshHandleOrMesh& mesh, bool create = true);
 
 public:
 
  virtual void build() = 0;
 
 public:
 
  //! Maillage associé à ce maillage cartésien
  virtual IMesh* mesh() const = 0;
 
  //! Gestionnaire de trace associé.
  virtual ITraceMng* traceMng() const = 0;
 
  //! Liste des mailles dans la direction \a dir
  virtual CellDirectionMng cellDirection(eMeshDirection dir) = 0;
 
  //! Liste des mailles dans la direction \a dir (0, 1 ou 2)
  virtual CellDirectionMng cellDirection(Integer idir) = 0;
 
  //! Liste des faces dans la direction \a dir
  virtual FaceDirectionMng faceDirection(eMeshDirection dir) = 0;
 
  //! Liste des faces dans la direction \a dir (0, 1 ou 2)
  virtual FaceDirectionMng faceDirection(Integer idir) = 0;
 
  //! Liste des noeuds dans la direction \a dir
  virtual NodeDirectionMng nodeDirection(eMeshDirection dir) = 0;
 
  //! Liste des noeuds dans la direction \a dir (0, 1 ou 2)
  virtual NodeDirectionMng nodeDirection(Integer idir) = 0;
 
  /*!
   * \brief Calcule les infos pour les accès par direction.
   *
   * Actuellement, les restrictions suivantes existent:
   * - calcule uniquement les infos sur les entités mailles.
   * - suppose que la maille 0 est dans un coin (ne fonctionne que
   * pour le meshgenerator).
   * - les informations de direction sont invalidées si le maillage évolue.
   */
  virtual void computeDirections() = 0;
 
  /*!
   * \brief Recalcule les informations de cartésiennes après une reprise.
   *
   * Cette méthode doit être appelée à la place de computeDirections()
   * lors d'une reprise.
   */
  virtual void recreateFromDump() = 0;
 
  //! Informations sur la connectivité
  virtual CartesianConnectivity connectivity() = 0;
 
  /*!
   * \brief Nombre de patchs du maillage.
   *
   * Il y a toujours au moins un patch qui représente la maillage cartésien
   */
  virtual Int32 nbPatch() const = 0;
 
  /*!
   * \brief Retourne le \a index-ième patch du maillage.
   *
   * Si le maillage est cartésien, il n'y a qu'un seul patch.
   *
   * L'instance retournée reste valide tant que cette instance n'est pas détruite.
   */
  virtual ICartesianMeshPatch* patch(Int32 index) const = 0;
 
  /*!
   * \brief Retourne le \a index-ième patch du maillage.
   *
   * Si le maillage est cartésien, il n'y a qu'un seul patch.
   *
   * L'instance retournée reste valide tant que cette instance n'est pas détruite.
   */
  virtual CartesianPatch amrPatch(Int32 index) const = 0;
 
  /*!
   * \brief Vue sur la liste des patchs.
   */
  virtual CartesianMeshPatchListView patches() const = 0;
 
  /*!
   * \brief Raffine en 2D un bloc du maillage cartésien.
   *
   * Cette méthode ne peut être appelée que si le maillage est un maillage
   * AMR (IMesh::isAmrActivated()==true).
   *
   * Les mailles dont les positions des centres sont comprises entre
   * \a position et \a (position+length) sont raffinées et les informations
   * de connectivité correspondantes sont mises à jour.
   *
   * Cette opération est collective.
   */
  virtual void refinePatch2D(Real2 position, Real2 length) = 0;
 
  /*!
   * \brief Raffine en 3D un bloc du maillage cartésien.
   *
   * Cette méthode ne peut être appelée que si le maillage est un maillage
   * AMR (IMesh::isAmrActivated()==true).
   *
   * Les mailles dont les positions des centres sont comprises entre
   * \a position et \a (position+length) sont raffinées et les informations
   * de connectivité correspondantes sont mises à jour.
   *
   * Cette opération est collective.
   */
  virtual void refinePatch3D(Real3 position, Real3 length) = 0;
 
  /*!
   * \brief Dé-raffine en 2D un bloc du maillage cartésien.
   *
   * Cette méthode ne peut être appelée que si le maillage est un maillage
   * AMR (IMesh::isAmrActivated()==true).
   *
   * Les mailles dont les positions des centres sont comprises entre
   * \a position et \a (position+length) sont dé-raffinées et les informations
   * de connectivité correspondantes sont mises à jour.
   *
   * Toutes les mailles dans la zone de dé-raffinement doivent être du même
   * niveau.
   *
   * Les patchs ne contenant plus de mailles après l'appel à cette méthode
   * seront supprimés.
   *
   * Cette opération est collective.
   */
  virtual void coarseZone2D(Real2 position, Real2 length) = 0;
 
  /*!
   * \brief Dé-raffine en 3D un bloc du maillage cartésien.
   *
   * Cette méthode ne peut être appelée que si le maillage est un maillage
   * AMR (IMesh::isAmrActivated()==true).
   *
   * Les mailles dont les positions des centres sont comprises entre
   * \a position et \a (position+length) sont dé-raffinées et les informations
   * de connectivité correspondantes sont mises à jour.
   *
   * Toutes les mailles dans la zone de dé-raffinement doivent être du même
   * niveau.
   *
   * Les patchs ne contenant plus de mailles après l'appel à cette méthode
   * seront supprimés.
   *
   * Cette opération est collective.
   */
  virtual void coarseZone3D(Real3 position, Real3 length) = 0;
 
  /*!
   * \brief Méthode permettant de supprimer une ou plusieurs couches
   * de mailles fantômes sur un niveau de raffinement défini.
   *
   * Le nombre de couches de mailles fantômes souhaité peut être augmenté
   * par la méthode. Il est nécessaire de récupérer la valeur retournée
   * pour avoir le nombre de couches de mailles fantômes final.
   *
   * \param level Le niveau de raffinement concerné par la suppression
   * des mailles fantômes.
   *
   * \param target_nb_ghost_layers Le nombre de couches souhaité après
   * appel à cette méthode. ATTENTION : Il peut être ajusté par la méthode.
   *
   * \return Le nombre de couches de mailles fantômes final.
   */
  virtual Integer reduceNbGhostLayers(Integer level, Integer target_nb_ghost_layers) = 0;
 
  /*!
   * \brief Renumérote les uniqueId() des entités.
   *
   * Suivant les valeurs de \a v, on renumérote les uniqueId() des faces et/ou 
   * des entités des patches pour avoir la même numérotation
   * quel que soit le découpage.
   */
  virtual void renumberItemsUniqueId(const CartesianMeshRenumberingInfo& v) = 0;
 
  //! Effectue des vérifications sur la validité de l'instance.
  virtual void checkValid() const = 0;
 
  /*!
   * \brief Créé une instance pour gérer le déraffinement du maillage.
   * \deprecated Utiliser Arcane::CartesianMeshUtils::createCartesianMeshCoarsening2() à la place.
   */
  ARCANE_DEPRECATED_REASON("Y2024: Use Arcane::CartesianMeshUtils::createCartesianMeshCoarsening2() instead")
  virtual Ref<CartesianMeshCoarsening> createCartesianMeshCoarsening() = 0;
 
 public:
 
  //! API interne à Arcane
  virtual ICartesianMeshInternal* _internalApi() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
extern "C++" ARCANE_CARTESIANMESH_EXPORT ICartesianMesh*
arcaneCreateCartesianMesh(IMesh* mesh);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif