MeshHandle.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* MeshHandle.h                                                (C) 2000-2025 */
/*                                                                           */
/* Handle on a mesh.                                                         */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_MESHHANDLE_H
#define ARCANE_CORE_MESHHANDLE_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arccore/base/ReferenceCounterImpl.h"
#include "arccore/base/StringView.h"
#include "arccore/base/String.h"
 
#include "arcane/utils/UtilsTypes.h"
#include "arcane/core/ArcaneTypes.h"
 
#include <atomic>
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT MeshHandle
{
 private:
 
  // Temporary: to access the constructor that uses ISubDomain.
  friend class MeshMng;
 
 private:
 
  class MeshHandleRef
  : public Arccore::ReferenceCounterImpl
  {
   public:
 
    MeshHandleRef()
    : m_is_null(true)
    {}
    MeshHandleRef(ISubDomain* sd, const String& name);
    ~MeshHandleRef();
 
   public:
 
    const String& meshName() const { return m_mesh_name; }
    bool isNull() const { return m_is_null; }
    IMesh* mesh() const { return m_mesh_ptr; }
    IMeshBase* meshBase() const { return m_mesh_base_ptr; }
    ISubDomain* subDomain() const { return m_sub_domain; }
    IMeshMng* meshMng() const { return m_mesh_mng; }
    ITraceMng* traceMng() const { return m_trace_mng; }
    IVariableMng* variableMng() const { return m_variable_mng; }
    IUserDataList* userDataList() const { return m_user_data_list; }
    Observable* onDestroyObservable() const { return m_on_destroy_observable; }
    bool isDoFatalInMeshMethod() const { return m_do_fatal_in_mesh_method; }
 
   public:
 
    void _destroyMesh();
    void _setMesh(IMesh* mesh);
 
   private:
 
    String m_mesh_name;
    IMesh* m_mesh_ptr = nullptr;
    IMeshBase* m_mesh_base_ptr = nullptr;
    // For now we need it, but it should be removed
    ISubDomain* m_sub_domain = nullptr;
    IUserDataList* m_user_data_list = nullptr;
    IMeshMng* m_mesh_mng = nullptr;
    ITraceMng* m_trace_mng = nullptr;
    IVariableMng* m_variable_mng = nullptr;
    Observable* m_on_destroy_observable = nullptr;
    bool m_is_null = true;
    bool m_do_fatal_in_mesh_method = false;
  };
 
 public:
 
  MeshHandle();
 
 private:
 
  // TODO make accessible only to classes implementing IMeshMng.
  MeshHandle(ISubDomain* sd, const String& name);
 
 public:

  IMesh* mesh() const;

  bool hasMesh() const;

  IMesh* meshOrNull() const;
 
 public:

  ARCCORE_DEPRECATED_2020("Do not use this method. Try to get ISubDomain from another way")
  ISubDomain* subDomain() const { return m_ref->subDomain(); }
 
 public:

  IMeshMng* meshMng() const;

  ITraceMng* traceMng() const;

  IVariableMng* variableMng() const;

  IApplication* application() const;

  IUserDataList* meshUserDataList() const { return m_ref->userDataList(); }
 
  const String& meshName() const { return m_ref->meshName(); }

  bool isNull() const { return m_ref->isNull(); }

  IObservable* onDestroyObservable() const;

  const void* reference() const { return m_ref.get(); }
 
 public:

  void _setMesh(IMesh* mesh) { m_ref->_setMesh(mesh); }

  void _destroyMesh() { m_ref->_destroyMesh(); }

  IMesh* _internalMeshOrNull() const { return m_ref->mesh(); }
 
 private:
 
  Arccore::ReferenceCounter<MeshHandleRef> m_ref;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT MeshHandleOrMesh
{
 public:
 
  // NOTE: The constructors must not be explicit
  // to allow conversions

  MeshHandleOrMesh(const MeshHandle& handle);

  MeshHandleOrMesh(IMesh* mesh);

  IMesh* mesh() const { return m_handle.meshOrNull(); }

  operator IMesh*() const { return mesh(); }

  const MeshHandle& handle() const { return m_handle; }
 
 private:
 
  MeshHandle m_handle;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif