Amesos Package Browser (Single Doxygen Collection) Development
Amesos_Component Class Reference

Amesos_Component: A pure virtual class for direct solvers to be used within Amesos_Merikos to form a parallel direct solver. More...

#include <Amesos_Component.h>

List of all members.

virtual ~Amesos_Component ()
 Destructor.
virtual int PartialFactorization ()=0
 Performs partial factorization on the matrix A.
virtual int Lsolve ()=0
 Solves L X = B (or LT x = B)
virtual int Usolve ()=0
 Solves L X = B (or LT x = B)
virtual int SetRowPermutation (int *RowPermutation)=0
 SetRowPermutation.
virtual int SetColumnPermutation (int *ColumnPermutation)=0
 SetColumnPermutation.
virtual int SetSubMatrixSize (int SubMatrixSize)=0
 SetSubMatrixSize.
virtual int GetRowPermutation (int **RowPermutation)=0
 GetRowPermutation.
virtual int GetColumnPermutation (int **ColumnPermutation)=0
 GetColumnPermutation.
virtual int GetSubMatrixSize (int *SubMatrixSize)=0
 GetSubMatrixSize.
virtual int GetSchurComplement (Epetra_CrsMatrix *SchurComplement)=0
 GetSchurComplement.

Detailed Description

Amesos_Component: A pure virtual class for direct solvers to be used within Amesos_Merikos to form a parallel direct solver.

The Amesos_Component interface specifies what Amesos_Merikos needs. Any Amesos class that implements Amesos_Component can be used by Amesos_Merikos to perform partial solves on subblocks of the matrix.

Member functions added by Amesos_Component.

Usage Examples

Basic calling sequence

    Epetra_LinearProblem Problem(A,X,B);
    Amesos_SolverName Solver(Problem);
    Solver.PartialFactorization() ; 
      ... Ancestor factorization
    Solver.Lsolve() ; 
      ... Ancestor solves
    Solver.Usolve() ; 

Preconditions: An ordering Postconditions: Constructor requirements

Every Amesos_SolverName class should accept an Epetra_LinearProblem

Definition at line 112 of file Amesos_Component.h.


Constructor & Destructor Documentation

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

Destructor.

Definition at line 118 of file Amesos_Component.h.


Member Function Documentation

virtual int Amesos_Component::PartialFactorization ( ) [pure virtual]

Performs partial factorization on the matrix A.

Partial Factorization perfom

Returns:
Integer error code, set to 0 if successful.
virtual int Amesos_Component::Lsolve ( ) [pure virtual]

Solves L X = B (or LT x = B)

Returns:
Integer error code, set to 0 if successful.
virtual int Amesos_Component::Usolve ( ) [pure virtual]

Solves L X = B (or LT x = B)

Returns:
Integer error code, set to 0 if successful.
virtual int Amesos_Component::SetRowPermutation ( int *  RowPermutation) [pure virtual]

SetRowPermutation.

virtual int Amesos_Component::SetColumnPermutation ( int *  ColumnPermutation) [pure virtual]

SetColumnPermutation.

virtual int Amesos_Component::SetSubMatrixSize ( int  SubMatrixSize) [pure virtual]

SetSubMatrixSize.

virtual int Amesos_Component::GetRowPermutation ( int **  RowPermutation) [pure virtual]

GetRowPermutation.

RowPermutation reflects any row permutations performed by PartialFactorization(). Note: It is not yet clear whether this row permutation includes the RowPermuation upon input or whether it returns only the row permuations performed by the most recent call to PartialFactorization(). In other words, in the absence of pivoting, RowPermutation might be identical to that given by SetRowPermutation() or it might be the identity permutation.

virtual int Amesos_Component::GetColumnPermutation ( int **  ColumnPermutation) [pure virtual]

GetColumnPermutation.

ColumnPermutation reflects any row permutations performed by PartialFactorization(). Note: It is not yet clear whether this row permutation includes the ColumnPermuation upon input or whether it returns only the row permuations performed by the most recent call to PartialFactorization(). In other words, in the absence of pivoting, ColumnPermutation might be identical to that given by SetColumnPermutation() or it might be the identity permutation.

virtual int Amesos_Component::GetSubMatrixSize ( int *  SubMatrixSize) [pure virtual]

GetSubMatrixSize.

virtual int Amesos_Component::GetSchurComplement ( Epetra_CrsMatrix SchurComplement) [pure virtual]

GetSchurComplement.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines