Ifpack_OverlapGraph Class Reference

Ifpack_OverlapGraph: Constructs a graph for use with Ifpack preconditioners. More...

#include <Ifpack_OverlapGraph.h>

Inheritance diagram for Ifpack_OverlapGraph:

Inheritance graph
[legend]
List of all members.
 Ifpack_OverlapGraph (const Teuchos::RefCountPtr< const Epetra_CrsGraph > &UserMatrixGraph_in, int OverlapLevel_in)
 Constructor using Epetra_CrsGraph.
 Ifpack_OverlapGraph (const Teuchos::RefCountPtr< const Epetra_RowMatrix > &UserMatrix_in, int OverlapLevel_in)
 Constructor using Epetra_RowMatrix.
 Ifpack_OverlapGraph (const Ifpack_OverlapGraph &Source)
 Copy constructor.
virtual ~Ifpack_OverlapGraph ()
 Ifpack_CrsIlut Destructor.
int SetParameters (const Teuchos::ParameterList &parameterlist, bool cerr_warning_if_unused=false)
 Set parameters using a Teuchos::ParameterList object.
const Epetra_CrsGraphOverlapGraph () const
 Returns the overlap graph object.
const Epetra_BlockMapOverlapRowMap () const
 Returns the RowMap associated with the overlap graph.
const Epetra_ImportOverlapImporter () const
 Returns the overlap graph object.
int OverlapLevel () const
 Returns the level of overlap used to create this graph.
void Print (ostream &os) const

Protected Member Functions

int ConstructOverlapGraph (const Teuchos::RefCountPtr< const Epetra_CrsGraph > &UserMatrixGraph)

Protected Attributes

Teuchos::RefCountPtr< Epetra_CrsGraphOverlapGraph_
Teuchos::RefCountPtr< const
Epetra_CrsGraph
UserMatrixGraph_
Teuchos::RefCountPtr< const
Epetra_RowMatrix
UserMatrix_
Teuchos::RefCountPtr< Epetra_BlockMapOverlapRowMap_
Teuchos::RefCountPtr< Epetra_ImportOverlapImporter_
int OverlapLevel_
bool IsOverlapped_

Detailed Description

Ifpack_OverlapGraph: Constructs a graph for use with Ifpack preconditioners.

Definition at line 49 of file Ifpack_OverlapGraph.h.


Constructor & Destructor Documentation

Ifpack_OverlapGraph::Ifpack_OverlapGraph ( const Teuchos::RefCountPtr< const Epetra_CrsGraph > &  UserMatrixGraph_in,
int  OverlapLevel_in 
)

Constructor using Epetra_CrsGraph.

Creates an Ifpack_OverlapGraph object from the user graph.

Parameters:
In UserMatrixGraph_in - Graph from user matrix.

Definition at line 40 of file Ifpack_OverlapGraph.cpp.

Ifpack_OverlapGraph::Ifpack_OverlapGraph ( const Teuchos::RefCountPtr< const Epetra_RowMatrix > &  UserMatrix_in,
int  OverlapLevel_in 
)

Constructor using Epetra_RowMatrix.

Creates an Ifpack_OverlapGraph object from the user graph implicitly defined by the Epetra_RowMatrix interface.

Parameters:
In RowMatrix - An object that has implemented the Epetra_RowMatrix interface.

Definition at line 51 of file Ifpack_OverlapGraph.cpp.

Ifpack_OverlapGraph::Ifpack_OverlapGraph ( const Ifpack_OverlapGraph Source  ) 

Copy constructor.

Definition at line 61 of file Ifpack_OverlapGraph.cpp.

virtual Ifpack_OverlapGraph::~Ifpack_OverlapGraph (  )  [inline, virtual]

Ifpack_CrsIlut Destructor.

Definition at line 72 of file Ifpack_OverlapGraph.h.


Member Function Documentation

int Ifpack_OverlapGraph::SetParameters ( const Teuchos::ParameterList &  parameterlist,
bool  cerr_warning_if_unused = false 
)

Set parameters using a Teuchos::ParameterList object.

Definition at line 77 of file Ifpack_OverlapGraph.cpp.

const Epetra_CrsGraph& Ifpack_OverlapGraph::OverlapGraph (  )  const [inline]

Returns the overlap graph object.

Definition at line 87 of file Ifpack_OverlapGraph.h.

const Epetra_BlockMap& Ifpack_OverlapGraph::OverlapRowMap (  )  const [inline]

Returns the RowMap associated with the overlap graph.

Definition at line 90 of file Ifpack_OverlapGraph.h.

const Epetra_Import& Ifpack_OverlapGraph::OverlapImporter (  )  const [inline]

Returns the overlap graph object.

Definition at line 93 of file Ifpack_OverlapGraph.h.

int Ifpack_OverlapGraph::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.

Definition at line 101 of file Ifpack_OverlapGraph.h.

void Ifpack_OverlapGraph::Print ( ostream &  os  )  const [inline, virtual]

Reimplemented from Epetra_Object.

Definition at line 106 of file Ifpack_OverlapGraph.h.

int Ifpack_OverlapGraph::ConstructOverlapGraph ( const Teuchos::RefCountPtr< const Epetra_CrsGraph > &  UserMatrixGraph  )  [protected]

Definition at line 90 of file Ifpack_OverlapGraph.cpp.


Member Data Documentation

Teuchos::RefCountPtr<Epetra_CrsGraph> Ifpack_OverlapGraph::OverlapGraph_ [protected]

Definition at line 122 of file Ifpack_OverlapGraph.h.

Teuchos::RefCountPtr<const Epetra_CrsGraph> Ifpack_OverlapGraph::UserMatrixGraph_ [protected]

Definition at line 123 of file Ifpack_OverlapGraph.h.

Teuchos::RefCountPtr<const Epetra_RowMatrix> Ifpack_OverlapGraph::UserMatrix_ [protected]

Definition at line 124 of file Ifpack_OverlapGraph.h.

Teuchos::RefCountPtr<Epetra_BlockMap> Ifpack_OverlapGraph::OverlapRowMap_ [protected]

Definition at line 125 of file Ifpack_OverlapGraph.h.

Teuchos::RefCountPtr<Epetra_Import> Ifpack_OverlapGraph::OverlapImporter_ [protected]

Definition at line 126 of file Ifpack_OverlapGraph.h.

int Ifpack_OverlapGraph::OverlapLevel_ [protected]

Definition at line 127 of file Ifpack_OverlapGraph.h.

bool Ifpack_OverlapGraph::IsOverlapped_ [protected]

Definition at line 128 of file Ifpack_OverlapGraph.h.


The documentation for this class was generated from the following files:
Generated on Tue Jul 13 09:27:26 2010 for Ifpack Package Browser (Single Doxygen Collection) by  doxygen 1.4.7