Ifpack Package Browser (Single Doxygen Collection)
Development
|
Ifpack_Partitioner: A class to decompose local Ifpack_Graph's. More...
#include <Ifpack_Partitioner.h>
Public Member Functions | |
virtual | ~Ifpack_Partitioner () |
Destructor. More... | |
virtual int | NumLocalParts () const =0 |
Returns the number of computed local partitions. More... | |
virtual int | OverlappingLevel () const =0 |
Returns the overlapping level. More... | |
virtual int | operator() (int MyRow) const =0 |
Returns the local non-overlapping partition ID of the specified row. More... | |
virtual int | operator() (int i, int j) const =0 |
Returns the local overlapping partition ID of the j-th node in partition i. More... | |
virtual int | NumRowsInPart (const int Part) const =0 |
Returns the number of rows contained in specified partition. More... | |
virtual int | RowsInPart (const int Part, int *List) const =0 |
Copies into List the rows in the (overlapping) partition Part. More... | |
virtual const int * | NonOverlappingPartition () const =0 |
Returns a pointer to the integer vector containing the non-overlapping partition ID of each local row. More... | |
virtual int | SetParameters (Teuchos::ParameterList &List)=0 |
Sets all the parameters for the partitioner. More... | |
virtual int | Compute ()=0 |
Computes the partitions. Returns 0 if successful. More... | |
virtual bool | IsComputed ()=0 |
Returns true if partitions have been computed successfully. More... | |
virtual std::ostream & | Print (std::ostream &os) const =0 |
Prints basic information about the partitioning object. More... | |
Ifpack_Partitioner: A class to decompose local Ifpack_Graph's.
Class Ifpack_Partitioner enables the decomposition of a local Ifpack_Graph's. It is supposed that the graph refers to a localized matrix (that is, a matrix that has been filtered through Ifpack_LocalFilter).
The overloaded operator (int i) can be used to extract the local partition ID of local row i.
The partitions created by Ifpack_Partitioner derived clased are non-overlapping in graph sense. This means that each row (or, more approriately, vertex) of G
is assigned to exactly one partition.
Partitioner can be extended using the functionalities of class Ifpack_OverlappingPartitioner (itself derived from Ifpack_Partitioner. This class extends the non-overlapping partitions by the required amount of overlap, considering local nodes only (that is, this overlap do not modify the overlap among the processes).
Ifpack_Partitioner is a pure virtual class. Concrete implementations are:
NumPDEEqns
parts (where NumPDEEqns
is the number of equations in the linear system). It is supposed that all the equations referring to the same grid node are ordered consecutively. Besides, the number of equations per node must be constant in the domain.Generically, a constructor requires an Ifpack_Graph object. Ifpack_Graph is a pure virtual class. Concrete implentations are:
An example of use is an Ifpack_Partitioner derived class is as follows:
When overlapping partitiones are created, the user can get the row ID contained in each partition as follows:
Ifpack_Partitioner is used to create the subblocks in Ifpack_BlockJacobi, Ifpack_BlockGaussSeidel, and Ifpack_BlockSymGaussSeidel.
Definition at line 162 of file Ifpack_Partitioner.h.
|
inlinevirtual |
Destructor.
Definition at line 167 of file Ifpack_Partitioner.h.
|
pure virtual |
Returns the number of computed local partitions.
Implemented in Ifpack_OverlappingPartitioner.
|
pure virtual |
Returns the overlapping level.
Implemented in Ifpack_OverlappingPartitioner.
|
pure virtual |
Returns the local non-overlapping partition ID of the specified row.
Returns the non-overlapping partition ID of the specified row.
MyRow | - (In) local row numbe |
Implemented in Ifpack_OverlappingPartitioner.
|
pure virtual |
Returns the local overlapping partition ID of the j-th node in partition i.
Implemented in Ifpack_OverlappingPartitioner.
|
pure virtual |
Returns the number of rows contained in specified partition.
Implemented in Ifpack_OverlappingPartitioner.
|
pure virtual |
Copies into List the rows in the (overlapping) partition Part.
Implemented in Ifpack_OverlappingPartitioner.
|
pure virtual |
Returns a pointer to the integer vector containing the non-overlapping partition ID of each local row.
Implemented in Ifpack_OverlappingPartitioner.
|
pure virtual |
Sets all the parameters for the partitioner.
Implemented in Ifpack_OverlappingPartitioner.
|
pure virtual |
Computes the partitions. Returns 0 if successful.
Implemented in Ifpack_OverlappingPartitioner.
|
pure virtual |
Returns true if partitions have been computed successfully.
Implemented in Ifpack_OverlappingPartitioner.
|
pure virtual |
Prints basic information about the partitioning object.
Implemented in Ifpack_OverlappingPartitioner.