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

Internal structure of Space object. More...

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.

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 name(), and size().

◆ 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 size().

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().

◆ 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().

Referenced by field(), and field().

◆ 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.

◆ 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.

Referenced by Internal().

◆ 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.

◆ 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.

◆ 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.

Referenced by Internal(), and Internal().


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