Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::SubDomainBuildInfo Class Reference

Parameters necessary for building a subdomain. More...

#include <arcane/core/SubDomainBuildInfo.h>

Collaboration diagram for Arcane::SubDomainBuildInfo:

Public Member Functions

 SubDomainBuildInfo (Ref< IParallelMng > pm, Int32 index)
 SubDomainBuildInfo (Ref< IParallelMng > pm, Int32 index, Ref< IParallelMng > all_replica_pm)
Ref< IParallelMng > parallelMng () const
String caseFileName () const
void setCaseFileName (const String &filename)
ByteConstArrayView caseBytes () const
ByteConstSpan caseContent () const
void setCaseBytes (ByteConstArrayView bytes)
void setCaseContent (ByteConstSpan content)
Integer index () const
Ref< IParallelMng > allReplicaParallelMng () const

Private Attributes

Ref< IParallelMng > m_parallel_mng
String m_case_file_name
 Name of the file containing the data set.
UniqueArray< std::byte > m_case_content
 Data set content.
Int32 m_index
Ref< IParallelMng > m_all_replica_parallel_mng
 Parallelism manager containing all replicas of m_parallel_mng.

Detailed Description

Parameters necessary for building a subdomain.

Info to create a subdomain associated with the parallelism manager parallelMng(), using the data set name caseFileName() and content caseBytes. index() is the index in the list of subdomains for this subdomain's session.

The file name is purely informative, and only the content caseBytes() is used. If caseBytes() is not empty, it must contain a valid XML document.

In domain replication, the instance must be constructed by specifying the IParallelMng corresponding to the set of subdomains and replicas, which is allReplicaParallelMng(). Without replication, this corresponds to the standard parallel manager.

Definition at line 53 of file SubDomainBuildInfo.h.

Constructor & Destructor Documentation

◆ SubDomainBuildInfo() [1/2]

Arcane::SubDomainBuildInfo::SubDomainBuildInfo ( Ref< IParallelMng > pm,
Int32 index )

Definition at line 26 of file SubDomainBuildInfo.cc.

◆ SubDomainBuildInfo() [2/2]

Arcane::SubDomainBuildInfo::SubDomainBuildInfo ( Ref< IParallelMng > pm,
Int32 index,
Ref< IParallelMng > all_replica_pm )

Definition at line 37 of file SubDomainBuildInfo.cc.

Member Function Documentation

◆ allReplicaParallelMng()

Ref< IParallelMng > Arcane::SubDomainBuildInfo::allReplicaParallelMng ( ) const
inline

Definition at line 82 of file SubDomainBuildInfo.h.

◆ caseBytes()

ByteConstArrayView Arcane::SubDomainBuildInfo::caseBytes ( ) const

Definition at line 48 of file SubDomainBuildInfo.cc.

◆ caseContent()

ByteConstSpan Arcane::SubDomainBuildInfo::caseContent ( ) const

Definition at line 65 of file SubDomainBuildInfo.cc.

◆ caseFileName()

String Arcane::SubDomainBuildInfo::caseFileName ( ) const
inline

Definition at line 67 of file SubDomainBuildInfo.h.

◆ index()

Integer Arcane::SubDomainBuildInfo::index ( ) const
inline

Definition at line 80 of file SubDomainBuildInfo.h.

◆ parallelMng()

Ref< IParallelMng > Arcane::SubDomainBuildInfo::parallelMng ( ) const
inline

Definition at line 62 of file SubDomainBuildInfo.h.

◆ setCaseBytes()

void Arcane::SubDomainBuildInfo::setCaseBytes ( ByteConstArrayView bytes)

Definition at line 55 of file SubDomainBuildInfo.cc.

◆ setCaseContent()

void Arcane::SubDomainBuildInfo::setCaseContent ( ByteConstSpan content)

Definition at line 71 of file SubDomainBuildInfo.cc.

◆ setCaseFileName()

void Arcane::SubDomainBuildInfo::setCaseFileName ( const String & filename)
inline

Definition at line 69 of file SubDomainBuildInfo.h.

Member Data Documentation

◆ m_all_replica_parallel_mng

Ref<IParallelMng> Arcane::SubDomainBuildInfo::m_all_replica_parallel_mng
private

Parallelism manager containing all replicas of m_parallel_mng.

Definition at line 94 of file SubDomainBuildInfo.h.

◆ m_case_content

UniqueArray<std::byte> Arcane::SubDomainBuildInfo::m_case_content
private

Data set content.

Definition at line 91 of file SubDomainBuildInfo.h.

◆ m_case_file_name

String Arcane::SubDomainBuildInfo::m_case_file_name
private

Name of the file containing the data set.

Definition at line 90 of file SubDomainBuildInfo.h.

◆ m_index

Int32 Arcane::SubDomainBuildInfo::m_index
private

Subdomain number in the session

Definition at line 92 of file SubDomainBuildInfo.h.

◆ m_parallel_mng

Ref<IParallelMng> Arcane::SubDomainBuildInfo::m_parallel_mng
private

Definition at line 89 of file SubDomainBuildInfo.h.

The documentation for this class was generated from the following files: