Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
ModuleBuildInfo.h
1// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
2//-----------------------------------------------------------------------------
3// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
4// See the top-level COPYRIGHT file for details.
5// SPDX-License-Identifier: Apache-2.0
6//-----------------------------------------------------------------------------
7/*---------------------------------------------------------------------------*/
8/* ModuleBuildInfo.h (C) 2000-2025 */
9/* */
10/* Parameters for building a module. */
11/*---------------------------------------------------------------------------*/
12#ifndef ARCANE_CORE_MODULEBUILDINFO_H
13#define ARCANE_CORE_MODULEBUILDINFO_H
14/*---------------------------------------------------------------------------*/
15/*---------------------------------------------------------------------------*/
16
17#include "arcane/utils/String.h"
18#include "arcane/core/MeshHandle.h"
19
20/*---------------------------------------------------------------------------*/
21/*---------------------------------------------------------------------------*/
22
23namespace Arcane
24{
25
26/*---------------------------------------------------------------------------*/
27/*---------------------------------------------------------------------------*/
28
38class ARCANE_CORE_EXPORT ModuleBuildInfo
39{
40 public:
41
48 ARCANE_DEPRECATED_REASON("Y2022: use overload with meshHandle() instead of mesh")
50
51 public:
52
54 ModuleBuildInfo(ISubDomain* sd, const MeshHandle& mesh_handle, const String& name);
55
62
64 virtual ~ModuleBuildInfo() {}
65
66 public:
67
69 ISubDomain* subDomain() const { return m_sub_domain; }
70
72 const MeshHandle& meshHandle() const { return m_mesh_handle; }
73
75 const String& name() const { return m_name; }
76
77 public:
78
87 IMesh* mesh() const { return m_mesh_handle.mesh(); }
88
89 private:
90
93
96
99};
100
101/*---------------------------------------------------------------------------*/
102/*---------------------------------------------------------------------------*/
103
104} // End namespace Arcane
105
106/*---------------------------------------------------------------------------*/
107/*---------------------------------------------------------------------------*/
108
109#endif
Interface of the subdomain manager.
Definition ISubDomain.h:75
Handle on a mesh.
Definition MeshHandle.h:48
const String & name() const
Name of the implementation sought.
String m_name
Name of the implementation sought.
virtual ~ModuleBuildInfo()
Destructor.
ISubDomain * m_sub_domain
Associated subdomain.
IMesh * mesh() const
Access to the associated mesh.
ISubDomain * subDomain() const
Access to the associated subdomain.
MeshHandle m_mesh_handle
Associated mesh.
ModuleBuildInfo(ISubDomain *sd, IMesh *mesh, const String &name)
Constructor from a subdomain, a mesh, and a module implementation name.
const MeshHandle & meshHandle() const
Access to the associated mesh.
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --