Ifpack_OverlapGraph Class Reference

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

#include <Ifpack_OverlapGraph.h>

Inheritance diagram for Ifpack_OverlapGraph:

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_
	Ifpack_OverlapGraph (const Teuchos::RefCountPtr< const Epetra_CrsGraph > &UserMatrixGraph_in, int OverlapLevel_in)
	Constructor using Epetra_CrsGraph. More...
	Ifpack_OverlapGraph (const Teuchos::RefCountPtr< const Epetra_RowMatrix > &UserMatrix_in, int OverlapLevel_in)
	Constructor using Epetra_RowMatrix. More...
	Ifpack_OverlapGraph (const Ifpack_OverlapGraph &Source)
	Copy constructor. More...
virtual	~Ifpack_OverlapGraph ()
	Ifpack_CrsIlut Destructor. More...
int	SetParameters (const Teuchos::ParameterList &parameterlist, bool cerr_warning_if_unused=false)
	Set parameters using a Teuchos::ParameterList object. More...
const Epetra_CrsGraph &	OverlapGraph () const
	Returns the overlap graph object. More...
const Epetra_BlockMap &	OverlapRowMap () const
	Returns the RowMap associated with the overlap graph. More...
const Epetra_Import &	OverlapImporter () const
	Returns the overlap graph object. More...
int	OverlapLevel () const
	Returns the level of overlap used to create this graph. More...
void	Print (std::ostream &os) const

Detailed Description

Ifpack_OverlapGraph: Constructs a graph for use with Ifpack preconditioners.

Definition at line 68 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 53 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 64 of file Ifpack_OverlapGraph.cpp.

Ifpack_OverlapGraph::Ifpack_OverlapGraph

(

const Ifpack_OverlapGraph &

Source

)

Copy constructor.

Definition at line 74 of file Ifpack_OverlapGraph.cpp.

virtual Ifpack_OverlapGraph::~Ifpack_OverlapGraph ( )

inlinevirtual

Ifpack_CrsIlut Destructor.

Definition at line 91 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 90 of file Ifpack_OverlapGraph.cpp.

const Epetra_CrsGraph& Ifpack_OverlapGraph::OverlapGraph ( ) const

inline

Returns the overlap graph object.

Definition at line 106 of file Ifpack_OverlapGraph.h.

const Epetra_BlockMap& Ifpack_OverlapGraph::OverlapRowMap ( ) const

inline

Returns the RowMap associated with the overlap graph.

Definition at line 109 of file Ifpack_OverlapGraph.h.

const Epetra_Import& Ifpack_OverlapGraph::OverlapImporter ( ) const

inline

Returns the overlap graph object.

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

void Ifpack_OverlapGraph::Print ( std::ostream &  os ) const

inline

Definition at line 125 of file Ifpack_OverlapGraph.h.

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

protected

Definition at line 103 of file Ifpack_OverlapGraph.cpp.

Member Data Documentation

Teuchos::RefCountPtr<Epetra_CrsGraph> Ifpack_OverlapGraph::OverlapGraph_

protected

Definition at line 143 of file Ifpack_OverlapGraph.h.

Teuchos::RefCountPtr<const Epetra_CrsGraph> Ifpack_OverlapGraph::UserMatrixGraph_

protected

Definition at line 144 of file Ifpack_OverlapGraph.h.

Teuchos::RefCountPtr<const Epetra_RowMatrix> Ifpack_OverlapGraph::UserMatrix_

protected

Definition at line 145 of file Ifpack_OverlapGraph.h.

Teuchos::RefCountPtr<Epetra_BlockMap> Ifpack_OverlapGraph::OverlapRowMap_

protected

Definition at line 146 of file Ifpack_OverlapGraph.h.

Teuchos::RefCountPtr<Epetra_Import> Ifpack_OverlapGraph::OverlapImporter_

protected

Definition at line 147 of file Ifpack_OverlapGraph.h.

int Ifpack_OverlapGraph::OverlapLevel_

protected

Definition at line 148 of file Ifpack_OverlapGraph.h.

bool Ifpack_OverlapGraph::IsOverlapped_

protected

Definition at line 149 of file Ifpack_OverlapGraph.h.

---

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

• Ifpack_OverlapGraph.h
• Ifpack_OverlapGraph.cpp