Alien  1.3.0
Developer documentation
Loading...
Searching...
No Matches
Alien::Space::Internal Class Referencefinal

Internal structure of Space object. More...

Collaboration diagram for Alien::Space::Internal:

Public Member Functions

 Internal (Integer size, String name)
 Full constructor.
 Internal (Integer size)
 Size constructor.
Integer size () const
 Get space size.
const String & name () const
 Get space name.
void setField (String label, const UniqueArray< Arccore::Integer > &indices)
 Set label on matrix entries.
Integer nbField () const
 Get the number of fields.
const UniqueArray< Arccore::Integer > & field (String label) const
 Get the indices associated to a label.
const UniqueArray< Arccore::Integer > & field (Integer i) const
 Get indices associated to the i-th field \para[in] i The requested field.
String fieldLabel (Integer i) const
 Get the label of the i-th field.

Private Attributes

Integer m_size
 The size of the space.
String m_name
 The name of the space.
std::map< String, UniqueArray< Arccore::Integer > > m_fields
 Mapping label to indices.
UniqueArray< String > m_labels
 Direct acces for labels.

Detailed Description

Internal structure of Space object.

Definition at line 48 of file Space.cc.

Constructor & Destructor Documentation

◆ Internal() [1/2]

Alien::Space::Internal::Internal ( Integer size,
String name )
inline

Full constructor.

Parameters
[in]sizeThe size of the space
[in]nameThe name of the space

Definition at line 56 of file Space.cc.

References m_fields, m_labels, m_name, m_size, name(), and size().

Here is the call graph for this function:

◆ Internal() [2/2]

Alien::Space::Internal::Internal ( Integer size)
inline

Size constructor.

Parameters
[in]sizeThe size of the space

Definition at line 67 of file Space.cc.

References m_fields, m_labels, m_name, m_size, and size().

Here is the call graph for this function:

Member Function Documentation

◆ field() [1/2]

const UniqueArray< Arccore::Integer > & Alien::Space::Internal::field ( Integer i) const
inline

Get indices associated to the i-th field \para[in] i The requested field.

Returns
The indices associated to the field

Definition at line 123 of file Space.cc.

References field(), and m_labels.

Here is the call graph for this function:

◆ field() [2/2]

const UniqueArray< Arccore::Integer > & Alien::Space::Internal::field ( String label) const
inline

Get the indices associated to a label.

Parameters
[in]labelThe requested label
Returns
The indices associated to the field

Definition at line 110 of file Space.cc.

References field(), and m_fields.

Referenced by field(), and field().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fieldLabel()

String Alien::Space::Internal::fieldLabel ( Integer i) const
inline

Get the label of the i-th field.

Parameters
[in]iThe requested field
Returns
The associated label

Definition at line 133 of file Space.cc.

References m_labels.

◆ name()

const String & Alien::Space::Internal::name ( ) const
inline

Get space name.

Returns
The name of the space

Definition at line 84 of file Space.cc.

References m_name.

Referenced by Internal().

Here is the caller graph for this function:

◆ nbField()

Integer Alien::Space::Internal::nbField ( ) const
inline

Get the number of fields.

Returns
The number of fields (labels)

Definition at line 103 of file Space.cc.

References m_fields.

◆ setField()

void Alien::Space::Internal::setField ( String label,
const UniqueArray< Arccore::Integer > & indices )
inline

Set label on matrix entries.

Parameters
[in]labelThe name of the label
[in]indicesThe indices to which label is set

Definition at line 91 of file Space.cc.

References m_fields, and m_labels.

◆ size()

Integer Alien::Space::Internal::size ( ) const
inline

Get space size.

Returns
The size of the space

Definition at line 78 of file Space.cc.

References m_size.

Referenced by Internal(), and Internal().

Here is the caller graph for this function:

Member Data Documentation

◆ m_fields

std::map<String, UniqueArray<Arccore::Integer> > Alien::Space::Internal::m_fields
private

Mapping label to indices.

Definition at line 141 of file Space.cc.

Referenced by field(), Internal(), Internal(), nbField(), and setField().

◆ m_labels

UniqueArray<String> Alien::Space::Internal::m_labels
private

Direct acces for labels.

Definition at line 143 of file Space.cc.

Referenced by field(), fieldLabel(), Internal(), Internal(), and setField().

◆ m_name

String Alien::Space::Internal::m_name
private

The name of the space.

Definition at line 139 of file Space.cc.

Referenced by Internal(), Internal(), and name().

◆ m_size

Integer Alien::Space::Internal::m_size
private

The size of the space.

Definition at line 137 of file Space.cc.

Referenced by Internal(), Internal(), and size().


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