Ifpack2 Templated Preconditioning Package Version 1.0
Ifpack2::OverlapGraph< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Ifpack2::OverlapGraph constructs an overlapped graph. More...

#include <Ifpack2_OverlapGraph.hpp>

Inheritance diagram for Ifpack2::OverlapGraph< LocalOrdinal, GlobalOrdinal, Node >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 OverlapGraph (const Teuchos::RCP< const Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > &UserMatrixGraph_in, int OverlapLevel_in)
 Constructor using Tpetra::CrsGraph.
 OverlapGraph (const OverlapGraph< LocalOrdinal, GlobalOrdinal, Node > &Source)
 Constructor using Tpetra_RowMatrix.
virtual ~OverlapGraph ()
 Destructor.
int SetParameters (const Teuchos::ParameterList &parameterlist, bool cerr_warning_if_unused=false)
 Set parameters using a Teuchos::ParameterList object.
const Tpetra::CrsGraph
< LocalOrdinal, GlobalOrdinal,
Node > & 
getOverlapGraph () const
 Returns the overlap graph object.
const Tpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > & 
getOverlapRowMap () const
 Returns the RowMap associated with the overlap graph.
const Tpetra::Import
< LocalOrdinal, GlobalOrdinal,
Node > & 
getOverlapImporter () const
 Returns the overlap graph object.
int OverlapLevel () const
 Returns the level of overlap used to create this graph.

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
class Ifpack2::OverlapGraph< LocalOrdinal, GlobalOrdinal, Node >

Ifpack2::OverlapGraph constructs an overlapped graph.


Constructor & Destructor Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Ifpack2::OverlapGraph< LocalOrdinal, GlobalOrdinal, Node >::OverlapGraph ( const Teuchos::RCP< const Tpetra::CrsGraph< LocalOrdinal, GlobalOrdinal, Node > > &  UserMatrixGraph_in,
int  OverlapLevel_in 
)

Constructor using Tpetra::CrsGraph.

Creates an Ifpack2::OverlapGraph object from the user graph.

Parameters:
InUserMatrixGraph_in - Graph from user matrix.
template<class LocalOrdinal , class GlobalOrdinal , class Node >
Ifpack2::OverlapGraph< LocalOrdinal, GlobalOrdinal, Node >::OverlapGraph ( const OverlapGraph< LocalOrdinal, GlobalOrdinal, Node > &  Source)

Constructor using Tpetra_RowMatrix.

Creates an Ifpack2_OverlapGraph object from the user graph implicitly defined by the Tpetra_RowMatrix interface.

Parameters:
InRowMatrix - An object that has implemented the Tpetra_RowMatrix interface. Copy constructor.
template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual Ifpack2::OverlapGraph< LocalOrdinal, GlobalOrdinal, Node >::~OverlapGraph ( ) [inline, virtual]

Destructor.


Member Function Documentation

template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
int Ifpack2::OverlapGraph< LocalOrdinal, GlobalOrdinal, Node >::SetParameters ( const Teuchos::ParameterList parameterlist,
bool  cerr_warning_if_unused = false 
)

Set parameters using a Teuchos::ParameterList object.

template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
const Tpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node>& Ifpack2::OverlapGraph< LocalOrdinal, GlobalOrdinal, Node >::getOverlapGraph ( ) const [inline]

Returns the overlap graph object.

template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node>& Ifpack2::OverlapGraph< LocalOrdinal, GlobalOrdinal, Node >::getOverlapRowMap ( ) const [inline]

Returns the RowMap associated with the overlap graph.

template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
const Tpetra::Import<LocalOrdinal,GlobalOrdinal,Node>& Ifpack2::OverlapGraph< LocalOrdinal, GlobalOrdinal, Node >::getOverlapImporter ( ) const [inline]

Returns the overlap graph object.

template<class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
int Ifpack2::OverlapGraph< LocalOrdinal, GlobalOrdinal, Node >::OverlapLevel ( ) const [inline]

Returns the level of overlap used to create this graph.

The graph created by this class uses a recursive definition 0f overlap. Level one overlap is created by copying all off-processor rows that are reached to be at least one column of the rows that are on processor. Level two overlap is the same process used on the level one graph.


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