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
23
namespace
Arcane
24
{
25
26
/*---------------------------------------------------------------------------*/
27
/*---------------------------------------------------------------------------*/
28
38
class
ARCANE_CORE_EXPORT
ModuleBuildInfo
39
{
40
public
:
41
48
ARCANE_DEPRECATED_REASON(
"Y2022: use overload with meshHandle() instead of mesh"
)
49
ModuleBuildInfo
(
ISubDomain
* sd,
IMesh
*
mesh
,
const
String
&
name
);
50
51
public
:
52
54
ModuleBuildInfo
(
ISubDomain
* sd,
const
MeshHandle
& mesh_handle,
const
String
&
name
);
55
61
ModuleBuildInfo
(
ISubDomain
* sd,
const
String
&
name
);
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
92
ISubDomain
*
m_sub_domain
;
93
95
MeshHandle
m_mesh_handle
;
96
98
String
m_name
;
99
};
100
101
/*---------------------------------------------------------------------------*/
102
/*---------------------------------------------------------------------------*/
103
104
}
// End namespace Arcane
105
106
/*---------------------------------------------------------------------------*/
107
/*---------------------------------------------------------------------------*/
108
109
#endif
Arcane::IMesh
Definition
IMesh.h:60
Arcane::ISubDomain
Interface of the subdomain manager.
Definition
ISubDomain.h:75
Arcane::MeshHandle
Handle on a mesh.
Definition
MeshHandle.h:48
Arcane::ModuleBuildInfo::name
const String & name() const
Name of the implementation sought.
Definition
ModuleBuildInfo.h:75
Arcane::ModuleBuildInfo::m_name
String m_name
Name of the implementation sought.
Definition
ModuleBuildInfo.h:98
Arcane::ModuleBuildInfo::~ModuleBuildInfo
virtual ~ModuleBuildInfo()
Destructor.
Definition
ModuleBuildInfo.h:64
Arcane::ModuleBuildInfo::m_sub_domain
ISubDomain * m_sub_domain
Associated subdomain.
Definition
ModuleBuildInfo.h:92
Arcane::ModuleBuildInfo::mesh
IMesh * mesh() const
Access to the associated mesh.
Definition
ModuleBuildInfo.h:87
Arcane::ModuleBuildInfo::subDomain
ISubDomain * subDomain() const
Access to the associated subdomain.
Definition
ModuleBuildInfo.h:69
Arcane::ModuleBuildInfo::m_mesh_handle
MeshHandle m_mesh_handle
Associated mesh.
Definition
ModuleBuildInfo.h:95
Arcane::ModuleBuildInfo::ModuleBuildInfo
ModuleBuildInfo(ISubDomain *sd, IMesh *mesh, const String &name)
Constructor from a subdomain, a mesh, and a module implementation name.
Definition
ModuleBuildInfo.cc:30
Arcane::ModuleBuildInfo::meshHandle
const MeshHandle & meshHandle() const
Access to the associated mesh.
Definition
ModuleBuildInfo.h:72
Arcane::String
Unicode character string.
Definition
arccore/src/base/arccore/base/String.h:70
Arcane
-- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature --
Definition
arcane/src/arcane/accelerator/AcceleratorGlobal.h:37
arcane
core
ModuleBuildInfo.h
Generated on
for Arcane by
1.16.1