IMesh.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IMesh.h                                                     (C) 2000-2024 */
/*                                                                           */
/* Interface of a mesh.                                                      */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IMESH_H
#define ARCANE_CORE_IMESH_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/core/VariableTypedef.h"
#include "arcane/core/IMeshBase.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IParallelMng;
class MeshItemInternalList;
class IParticleExchanger;
class XmlNode;
class IMeshUtilities;
class IMeshModifier;
class IMeshMng;
class Properties;
class IMeshPartitionConstraintMng;
class IExtraGhostCellsBuilder;
class IUserData;
class IUserDataList;
class IGhostLayerMng;
class IMeshChecker;
class IMeshCompactMng;
class MeshPartInfo;
class IItemFamilyNetwork;
class MeshHandle;
class IVariableMng;
class ItemTypeMng;
class IMeshUniqueIdMng;
class MeshEventArgs;
enum class eMeshEventType;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
//INFO: The complete documentation is in Mesh.dox
class IMesh
: public IMeshBase
{
 public:
 
  virtual ~IMesh() = default; //<! Releases resources
 
 public:
 
  virtual void build() = 0;

  virtual String factoryName() const = 0;

  virtual ItemInternalList itemsInternal(eItemKind) = 0;

  virtual SharedVariableNodeReal3 sharedNodesCoordinates() = 0;

  virtual void checkValidMesh() = 0;

  virtual void checkValidMeshFull() = 0;

  virtual void synchronizeGroupsAndVariables() = 0;
 
 public:

  virtual bool isAllocated() = 0;

  virtual Int64 timestamp() = 0;
 
 public:

  ARCANE_DEPRECATED_LONG_TERM("Y2020: Do not use this method. Try to get 'ISubDomain' from another way")
  virtual ISubDomain* subDomain() = 0;
 
 public:

  virtual IParallelMng* parallelMng() = 0;
 
 public:


  virtual VariableScalarInteger connectivity() = 0;

  virtual CellGroup allActiveCells() = 0;

  virtual CellGroup ownActiveCells() = 0;

  virtual CellGroup allLevelCells(const Integer& level) = 0;

  virtual CellGroup ownLevelCells(const Integer& level) = 0;

  virtual FaceGroup allActiveFaces() = 0;

  virtual FaceGroup ownActiveFaces() = 0;

  virtual FaceGroup innerActiveFaces() = 0;

  virtual FaceGroup outerActiveFaces() = 0;
 
 public:

  virtual ItemGroupCollection groups() = 0;

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

  virtual void destroyGroups() = 0;
 
 public:
 
  virtual MeshItemInternalList* meshItemInternalList() = 0;
 
 public:
 
  virtual void updateGhostLayers(bool remove_old_ghost) = 0;

  ARCANE_DEPRECATED_240 virtual void serializeCells(ISerializer* buffer, Int32ConstArrayView cells_local_id) = 0;

  virtual void prepareForDump() = 0;

  virtual void initializeVariables(const XmlNode& init_node) = 0;

  virtual void setCheckLevel(Integer level) = 0;

  virtual Integer checkLevel() const = 0;

  virtual bool isDynamic() const = 0;

  virtual bool isAmrActivated() const = 0;
 
 public:



  virtual void computeTiedInterfaces(const XmlNode& mesh_node) = 0;

  virtual bool hasTiedInterface() = 0;

  virtual TiedInterfaceCollection tiedInterfaces() = 0;

  virtual IMeshPartitionConstraintMng* partitionConstraintMng() = 0;
 
 public:

  virtual IMeshUtilities* utilities() = 0;

  virtual Properties* properties() = 0;
 
 public:

  virtual IMeshModifier* modifier() = 0;
 
 public:

  virtual VariableNodeReal3& nodesCoordinates() = 0;


  virtual void defineParentForBuild(IMesh* mesh, ItemGroup group) = 0;

  virtual IMesh* parentMesh() const = 0;

  virtual ItemGroup parentGroup() const = 0;

  virtual void addChildMesh(IMesh* sub_mesh) = 0;

  virtual MeshCollection childMeshes() const = 0;
 
 public:

  virtual bool isPrimaryMesh() const = 0;

  virtual IPrimaryMesh* toPrimaryMesh() = 0;
 
 public:

  virtual IUserDataList* userDataList() = 0;

  virtual const IUserDataList* userDataList() const = 0;
 
 public:

  virtual IGhostLayerMng* ghostLayerMng() const = 0;

  virtual IMeshUniqueIdMng* meshUniqueIdMng() const = 0;

  virtual IMeshChecker* checker() const = 0;

  virtual const MeshPartInfo& meshPartInfo() const = 0;

  virtual bool useMeshItemFamilyDependencies() const = 0;

  virtual IItemFamilyNetwork* itemFamilyNetwork() = 0;

  virtual IIndexedIncrementalItemConnectivityMng* indexedConnectivityMng() = 0;

  virtual const MeshKind meshKind() const = 0;
 
 public:

  virtual EventObservable<const MeshEventArgs&>& eventObservable(eMeshEventType type) = 0;
 
 public:

  virtual IMeshCompactMng* _compactMng() = 0;

  virtual InternalConnectivityPolicy _connectivityPolicy() const = 0;
 
 public:

  virtual IMeshMng* meshMng() const = 0;

  virtual IVariableMng* variableMng() const = 0;

  virtual ItemTypeMng* itemTypeMng() const = 0;
 
 public:

  virtual void computeSynchronizeInfos() = 0;
 
 public:

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