Ifpack_OverlapGraph Class Reference

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

#include <Ifpack_OverlapGraph.h>

Inheritance diagram for Ifpack_OverlapGraph:

[legend]
List of all members.

Constructors/Destructor

 Ifpack_OverlapGraph (const Epetra_CrsGraph *UserMatrixGraph, int OverlapLevel)
 Constructor using Epetra_CrsGraph.
 Ifpack_OverlapGraph (const Epetra_RowMatrix *UserMatrix, int OverlapLevel)
 Constructor using Epetra_RowMatrix.
 Ifpack_OverlapGraph (const Ifpack_OverlapGraph &Source)
 Copy constructor.
virtual ~Ifpack_OverlapGraph ()
 Ifpack_CrsIlut Destructor.

Atribute access methods.

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.

Epetra_Object print method (allows use of << operator with this class).

void Print (ostream &os) const

Protected Member Functions

int ConstructOverlapGraph (const Epetra_CrsGraph *UserMatrixGraph)

Protected Attributes

Epetra_CrsGraphOverlapGraph_
const Epetra_CrsGraphUserMatrixGraph_
const Epetra_RowMatrixUserMatrix_
Epetra_BlockMapOverlapRowMap_
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 Epetra_CrsGraph UserMatrixGraph,
int  OverlapLevel
 

Constructor using Epetra_CrsGraph.

Creates an Ifpack_OverlapGraph object from the user graph.

Parameters:
In UserMatrixGraph - Graph from user matrix.

Definition at line 43 of file Ifpack_OverlapGraph.cpp.

Ifpack_OverlapGraph::Ifpack_OverlapGraph const Epetra_RowMatrix UserMatrix,
int  OverlapLevel
 

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 57 of file Ifpack_OverlapGraph.cpp.

Ifpack_OverlapGraph::Ifpack_OverlapGraph const Ifpack_OverlapGraph Source  ) 
 

Copy constructor.

Definition at line 70 of file Ifpack_OverlapGraph.cpp.

Ifpack_OverlapGraph::~Ifpack_OverlapGraph  )  [virtual]
 

Ifpack_CrsIlut Destructor.

Definition at line 85 of file Ifpack_OverlapGraph.cpp.


Member Function Documentation

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

Returns the overlap graph object.

Definition at line 89 of file Ifpack_OverlapGraph.h.

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

Returns the RowMap associated with the overlap graph.

Definition at line 92 of file Ifpack_OverlapGraph.h.

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

Returns the overlap graph object.

Definition at line 95 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 103 of file Ifpack_OverlapGraph.h.

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

Reimplemented from Epetra_Object.

Definition at line 108 of file Ifpack_OverlapGraph.h.

int Ifpack_OverlapGraph::ConstructOverlapGraph const Epetra_CrsGraph UserMatrixGraph  )  [protected]
 

Definition at line 109 of file Ifpack_OverlapGraph.cpp.


Member Data Documentation

Epetra_CrsGraph* Ifpack_OverlapGraph::OverlapGraph_ [protected]
 

Definition at line 125 of file Ifpack_OverlapGraph.h.

const Epetra_CrsGraph* Ifpack_OverlapGraph::UserMatrixGraph_ [protected]
 

Definition at line 126 of file Ifpack_OverlapGraph.h.

const Epetra_RowMatrix* Ifpack_OverlapGraph::UserMatrix_ [protected]
 

Definition at line 127 of file Ifpack_OverlapGraph.h.

Epetra_BlockMap* Ifpack_OverlapGraph::OverlapRowMap_ [protected]
 

Definition at line 128 of file Ifpack_OverlapGraph.h.

Epetra_Import* Ifpack_OverlapGraph::OverlapImporter_ [protected]
 

Definition at line 129 of file Ifpack_OverlapGraph.h.

int Ifpack_OverlapGraph::OverlapLevel_ [protected]
 

Definition at line 130 of file Ifpack_OverlapGraph.h.

bool Ifpack_OverlapGraph::IsOverlapped_ [protected]
 

Definition at line 131 of file Ifpack_OverlapGraph.h.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:37:31 2008 for Ifpack Package Browser (Single Doxygen Collection) by doxygen 1.3.9.1