All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Public Types
Xpetra::VbrMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

VbrMatrix: Variable block row matrix. More...

#include <Xpetra_VbrMatrix.hpp>

List of all members.

Public Types

typedef Scalar scalar_type
typedef LocalOrdinal local_ordinal_type
typedef GlobalOrdinal global_ordinal_type
typedef Node node_type

Constructor/Destructor Methods

virtual ~VbrMatrix ()
 Destructor.

Detailed Description

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::VbrMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >

VbrMatrix: Variable block row matrix.

The VbrMatrix class has two significant 'states', distinguished by whether or not storage has been optimized (packed) or not.

When the matrix is in the non-optimized-storage state, internal data storage is in a non-contiguous data-structure that allows for convenient insertion of data.

When the matrix is in the optimized-storage state, internal data is stored in contiguous (packed) arrays. When in this state, existing entries may be updated and replaced, but no new entries (indices and/or coefficients) may be inserted. In other words, the sparsity pattern or structure of the matrix may not be changed.

Use of the matrix as an Matrix (performing matrix-vector multiplication) is only allowed when it is in the optimized-storage state.

VbrMatrix has two constructors, one which leaves the matrix in the optimized- storage state, and another which leaves the matrix in the non-optimized-storage state.

When the VbrMatrix is constructed in the non-optimized-storage state, (and then filled using methods such as setGlobalBlockEntry etc.), it can then be transformed to the optimized-storage state by calling the method fillComplete().

Once in the optimized-storage state, the VbrMatrix can not be returned to the non-optimized-storage state.

Definition at line 102 of file Xpetra_VbrMatrix.hpp.


Member Typedef Documentation

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Scalar Xpetra::VbrMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type

Definition at line 104 of file Xpetra_VbrMatrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef LocalOrdinal Xpetra::VbrMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 105 of file Xpetra_VbrMatrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef GlobalOrdinal Xpetra::VbrMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 106 of file Xpetra_VbrMatrix.hpp.

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Node Xpetra::VbrMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 107 of file Xpetra_VbrMatrix.hpp.


Constructor & Destructor Documentation

template<class Scalar = MultiVector<>::scalar_type, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Xpetra::VbrMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~VbrMatrix ( ) [virtual]

Destructor.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines