Ifpack_OverlapGraph Class Reference

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

#include <Ifpack_OverlapGraph.h>

List of all members.

Public Member Functions

 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_CrsGraph & OverlapGraph () const
 Returns the overlap graph object.
const Epetra_BlockMap & OverlapRowMap () const
 Returns the RowMap associated with the overlap graph.
const Epetra_Import & OverlapImporter () 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_CrsGraph > 
OverlapGraph_
Teuchos::RefCountPtr< const
Epetra_CrsGraph > 
UserMatrixGraph_
Teuchos::RefCountPtr< const
Epetra_RowMatrix > 
UserMatrix_
Teuchos::RefCountPtr
< Epetra_BlockMap > 
OverlapRowMap_
Teuchos::RefCountPtr
< Epetra_Import > 
OverlapImporter_
int OverlapLevel_
bool IsOverlapped_


Detailed Description

Ifpack_OverlapGraph: Constructs a graph for use with Ifpack preconditioners.

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.

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.

Ifpack_OverlapGraph::Ifpack_OverlapGraph ( const Ifpack_OverlapGraph Source  ) 

Copy constructor.

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

Ifpack_CrsIlut Destructor.


Member Function Documentation

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

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

Returns the overlap graph object.

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

Returns the overlap graph object.

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.

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

Returns the RowMap associated with the overlap graph.

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

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

Set parameters using a Teuchos::ParameterList object.


Member Data Documentation

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

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

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

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

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


The documentation for this class was generated from the following file:

Generated on Thu Dec 17 11:06:44 2009 for IFPACK Robust Algebraic Preconditioner Package by  doxygen 1.5.9