IFPACK Development
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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]
Collaboration diagram for Ifpack_OverlapGraph:
Collaboration graph
[legend]

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_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 (std::ostream &os) const
 
- Public Member Functions inherited from Epetra_Object
 Epetra_Object (int TracebackModeIn=-1, bool set_label=true)
 
 Epetra_Object (const char *const Label, int TracebackModeIn=-1)
 
 Epetra_Object (const Epetra_Object &Object)
 
virtual void Print (std::ostream &os) const
 
virtual int ReportError (const std::string Message, int ErrorCode) const
 
 Epetra_Object (int TracebackModeIn=-1, bool set_label=true)
 
 Epetra_Object (const char *const Label, int TracebackModeIn=-1)
 
 Epetra_Object (const Epetra_Object &Object)
 
virtual void SetLabel (const char *const Label)
 
virtual const char * Label () const
 

Protected Member Functions

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

Protected Attributes

Teuchos::RefCountPtr< Epetra_CrsGraphOverlapGraph_
 
Teuchos::RefCountPtr< const Epetra_CrsGraphUserMatrixGraph_
 
Teuchos::RefCountPtr< const Epetra_RowMatrixUserMatrix_
 
Teuchos::RefCountPtr< Epetra_BlockMapOverlapRowMap_
 
Teuchos::RefCountPtr< Epetra_ImportOverlapImporter_
 
int OverlapLevel_
 
bool IsOverlapped_
 

Additional Inherited Members

- Static Public Member Functions inherited from Epetra_Object
static void SetTracebackMode (int TracebackModeValue)
 
static int GetTracebackMode ()
 
static std::ostream & GetTracebackStream ()
 

Detailed Description

Ifpack_OverlapGraph: Constructs a graph for use with Ifpack preconditioners.

Definition at line 62 of file Ifpack_OverlapGraph.h.

Constructor & Destructor Documentation

◆ Ifpack_OverlapGraph() [1/3]

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
InUserMatrixGraph_in - Graph from user matrix.

Definition at line 53 of file Ifpack_OverlapGraph.cpp.

◆ Ifpack_OverlapGraph() [2/3]

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
InRowMatrix - An object that has implemented the Epetra_RowMatrix interface.

Definition at line 64 of file Ifpack_OverlapGraph.cpp.

References Epetra_Object::ReportError().

◆ Ifpack_OverlapGraph() [3/3]

Ifpack_OverlapGraph::Ifpack_OverlapGraph ( const Ifpack_OverlapGraph Source)

Copy constructor.

Definition at line 74 of file Ifpack_OverlapGraph.cpp.

◆ ~Ifpack_OverlapGraph()

virtual Ifpack_OverlapGraph::~Ifpack_OverlapGraph ( )
inlinevirtual

Ifpack_CrsIlut Destructor.

Definition at line 85 of file Ifpack_OverlapGraph.h.

Member Function Documentation

◆ ConstructOverlapGraph()

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

Definition at line 103 of file Ifpack_OverlapGraph.cpp.

◆ OverlapGraph()

const Epetra_CrsGraph & Ifpack_OverlapGraph::OverlapGraph ( ) const
inline

Returns the overlap graph object.

Definition at line 100 of file Ifpack_OverlapGraph.h.

◆ OverlapImporter()

const Epetra_Import & Ifpack_OverlapGraph::OverlapImporter ( ) const
inline

Returns the overlap graph object.

Definition at line 106 of file Ifpack_OverlapGraph.h.

◆ OverlapLevel()

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 114 of file Ifpack_OverlapGraph.h.

◆ OverlapRowMap()

const Epetra_BlockMap & Ifpack_OverlapGraph::OverlapRowMap ( ) const
inline

Returns the RowMap associated with the overlap graph.

Definition at line 103 of file Ifpack_OverlapGraph.h.

◆ Print()

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

Reimplemented from Epetra_Object.

Definition at line 119 of file Ifpack_OverlapGraph.h.

◆ SetParameters()

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.

Member Data Documentation

◆ IsOverlapped_

bool Ifpack_OverlapGraph::IsOverlapped_
protected

Definition at line 143 of file Ifpack_OverlapGraph.h.

◆ OverlapGraph_

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

Definition at line 137 of file Ifpack_OverlapGraph.h.

◆ OverlapImporter_

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

Definition at line 141 of file Ifpack_OverlapGraph.h.

◆ OverlapLevel_

int Ifpack_OverlapGraph::OverlapLevel_
protected

Definition at line 142 of file Ifpack_OverlapGraph.h.

◆ OverlapRowMap_

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

Definition at line 140 of file Ifpack_OverlapGraph.h.

◆ UserMatrix_

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

Definition at line 139 of file Ifpack_OverlapGraph.h.

◆ UserMatrixGraph_

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

Definition at line 138 of file Ifpack_OverlapGraph.h.


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