Interface class for a storage class holding the degrees of freedom of a discrete function. Mehr ...
#include <interfaces.hh>
Öffentliche Typen | |
|
typedef DofVectorInterface < Traits > | ThisType |
| this interface class type | |
| typedef Traits::Type | DofVectorType |
| type of the actual Dof vector implementation | |
| typedef Traits::FieldType | FieldType |
Underlying field type stored by the Dof vector, this is usually a double. | |
| typedef Traits::RealStorageType | RealStorageType |
| the acutal storage type used by this Dof vector, like std::vector e.g. | |
Öffentliche Methoden | |
| FieldType & | operator[] (unsigned int index) |
| Dof vector access. | |
| const FieldType & | operator[] (unsigned int index) const |
| constant Dof vector access | |
| DofVectorType & | operator= (const DofVectorType &other) |
| assignment operator for Dof vectors | |
| DofVectorType & | operator*= (FieldType scalar) |
| multiplies each component with a scalar value | |
| DofVectorType & | operator+= (const DofVectorType &addend) |
| adds to each component of the Dof vector the component of another Dof vector | |
| RealStorageType & | getRealStorage () |
| returns the actual storage type for use in a linear algebra solver e.g. | |
Ausführliche Beschreibung
template<class Traits>
class DofVectorInterface< Traits >
Interface class for a storage class holding the degrees of freedom of a discrete function.
- Template Parameters:
-
Traits A Traits class defining the public types exported by this interface
Dokumentation der Elementfunktionen
| RealStorageType& DofVectorInterface< Traits >::getRealStorage | ( | ) | [inline] |
returns the actual storage type for use in a linear algebra solver e.g.
- Rückgabe:
- a reference to the actual storage type
| DofVectorType& DofVectorInterface< Traits >::operator*= | ( | FieldType | scalar | ) | [inline] |
multiplies each component with a scalar value
- Parameter:
-
scalar the scalar each component is multiplied with
- Rückgabe:
- a reference to the dereferenced this pointer
Erneute Implementation in DefaultDofVector< Traits >.
| DofVectorType& DofVectorInterface< Traits >::operator+= | ( | const DofVectorType & | addend | ) | [inline] |
adds to each component of the Dof vector the component of another Dof vector
- Parameter:
-
addend the Dof vector that shall be added to the current one.
- Rückgabe:
- a reference to the dereferenced this pointer
Erneute Implementation in DefaultDofVector< Traits >.
| DofVectorType& DofVectorInterface< Traits >::operator= | ( | const DofVectorType & | other | ) | [inline] |
assignment operator for Dof vectors
A Dof vector need to overload the assignment operator
- Parameter:
-
other The other Dof vector
- Rückgabe:
- a reference to the dereferenced this pointer
Erneute Implementation in DefaultDofVector< Traits >.
| FieldType& DofVectorInterface< Traits >::operator[] | ( | unsigned int | index | ) | [inline] |
Dof vector access.
This function accesses a Dof vector component
- Parameter:
-
index index of the Dof vector component that shall be accessed
- Rückgabe:
- a reference to the Dof vector component
Erneute Implementation in DefaultDofVector< Traits >.
| const FieldType& DofVectorInterface< Traits >::operator[] | ( | unsigned int | index | ) | const [inline] |
constant Dof vector access
This function accesses a Dof vector component
- Parameter:
-
index index of the Dof vector component that shall be accessed
- Rückgabe:
- a const reference to the Dof vector component
Erneute Implementation in DefaultDofVector< Traits >.
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:
- interfaces.hh
