Public Member Functions | Private Types | Private Attributes | List of all members
Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_MatrixView_fwd.hpp>

Public Member Functions

void SetMaxEigenvalueEstimate (Scalar const &sigma)
 Set an maximum eigenvalue estimate for this matrix. More...
 
Scalar GetMaxEigenvalueEstimate () const
 Return the maximum eigenvalue estimate for this matrix. More...
 

Private Types

typedef Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > Map
 

Private Attributes

RCP< const Map > rowMap_
 
RCP< const Map > colMap_
 
Scalar maxEigValueEstimate_
 

Constructor/Destructor Methods

 MatrixView (const RCP< const Map > &rowMap, const RCP< const Map > &colMap)
 Constructor. More...
 
virtual ~MatrixView ()
 Destructor. More...
 

Map access methods

const RCP< const Map > & GetRowMap () const
 Returns the Map that describes the row distribution in this matrix. More...
 
const RCP< const Map > & GetColMap () const
 Returns the Map that describes the column distribution in this matrix. More...
 
void SetRowMap (const RCP< const Map > &rowMap)
 Returns the Map that describes the row distribution in this matrix. More...
 
void SetColMap (const RCP< const Map > &colMap)
 Set the Map that describes the column distribution in this matrix. More...
 

Detailed Description

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 51 of file Xpetra_MatrixView_fwd.hpp.

Member Typedef Documentation

◆ Map

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
typedef Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Map
private

Definition at line 69 of file Xpetra_MatrixView.hpp.

Constructor & Destructor Documentation

◆ MatrixView()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MatrixView ( const RCP< const Map > &  rowMap,
const RCP< const Map > &  colMap 
)
inline

Constructor.

Definition at line 77 of file Xpetra_MatrixView.hpp.

◆ ~MatrixView()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
virtual Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~MatrixView ( )
inlinevirtual

Destructor.

Definition at line 82 of file Xpetra_MatrixView.hpp.

Member Function Documentation

◆ GetRowMap()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
const RCP<const Map>& Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetRowMap ( ) const
inline

Returns the Map that describes the row distribution in this matrix.

Definition at line 89 of file Xpetra_MatrixView.hpp.

◆ GetColMap()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
const RCP<const Map>& Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetColMap ( ) const
inline

Returns the Map that describes the column distribution in this matrix.

Definition at line 92 of file Xpetra_MatrixView.hpp.

◆ SetRowMap()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
void Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetRowMap ( const RCP< const Map > &  rowMap)
inline

Returns the Map that describes the row distribution in this matrix.

Definition at line 95 of file Xpetra_MatrixView.hpp.

◆ SetColMap()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
void Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetColMap ( const RCP< const Map > &  colMap)
inline

Set the Map that describes the column distribution in this matrix.

Definition at line 98 of file Xpetra_MatrixView.hpp.

◆ SetMaxEigenvalueEstimate()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
void Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetMaxEigenvalueEstimate ( Scalar const &  sigma)
inline

Set an maximum eigenvalue estimate for this matrix.

Definition at line 102 of file Xpetra_MatrixView.hpp.

◆ GetMaxEigenvalueEstimate()

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Scalar Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetMaxEigenvalueEstimate ( ) const
inline

Return the maximum eigenvalue estimate for this matrix.

Definition at line 105 of file Xpetra_MatrixView.hpp.

Member Data Documentation

◆ rowMap_

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
RCP<const Map> Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::rowMap_
private

Definition at line 108 of file Xpetra_MatrixView.hpp.

◆ colMap_

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
RCP<const Map> Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::colMap_
private

Definition at line 109 of file Xpetra_MatrixView.hpp.

◆ maxEigValueEstimate_

template<class Scalar = double, class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Scalar Xpetra::MatrixView< Scalar, LocalOrdinal, GlobalOrdinal, Node >::maxEigValueEstimate_
private

Definition at line 111 of file Xpetra_MatrixView.hpp.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13