Amesos
Development
|
Amesos_Superludist: An object-oriented wrapper for Superludist. More...
#include <Amesos_Superludist.h>
Public Member Functions | |
int | SetParameters (Teuchos::ParameterList &ParameterList) |
Updates internal variables. More... | |
int | NumSymbolicFact () const |
Returns the number of symbolic factorizations performed by this object. | |
int | NumNumericFact () const |
Returns the number of numeric factorizations performed by this object. | |
int | NumSolve () const |
Returns the number of solves performed by this object. | |
void | PrintTiming () const |
Print various timig. | |
void | PrintStatus () const |
Print various information about the parameters used by Superludist. | |
void | GetTiming (Teuchos::ParameterList &TimingParameterList) const |
Extracts timing information from the current solver and places it in the parameter list. | |
Amesos_Superludist (const Epetra_LinearProblem &LinearProblem) | |
Amesos_Superludist Constructor. More... | |
~Amesos_Superludist (void) | |
Amesos_Superludist Destructor. More... | |
int | SymbolicFactorization () |
Performs SymbolicFactorization on the matrix A. More... | |
int | NumericFactorization () |
Performs NumericFactorization on the matrix A. More... | |
int | Solve () |
Solves A X = B (or AT x = B) More... | |
int | SetUseTranspose (bool UseTranspose) |
Amesos_Superludist does not support transpose at this time. More... | |
const Epetra_LinearProblem * | GetProblem () const |
Returns the Epetra_LinearProblem. More... | |
bool | MatrixShapeOK () const |
Returns true if SUPERLUDIST can handle this matrix shape. More... | |
bool | UseTranspose () const |
Always returns false. Superludist doesn't support transpose solve. | |
![]() | |
virtual | ~Amesos_BaseSolver () |
Destructor. | |
virtual void | setParameterList (Teuchos::RCP< Teuchos::ParameterList > const ¶mList) |
Redefined from Teuchos::ParameterListAcceptor (Does Not Work) | |
virtual Teuchos::RCP< Teuchos::ParameterList > | getNonconstParameterList () |
This is an empty stub. | |
virtual Teuchos::RCP< Teuchos::ParameterList > | unsetParameterList () |
This is an empty stub. | |
Amesos_Superludist: An object-oriented wrapper for Superludist.
Amesos_Superludist will solve a linear systems of equations: A X = B
using Epetra objects and the Superludist solver library, where A
is an Epetra_RowMatrix and X
and B
are Epetra_MultiVector objects.
Amesos_Superludist::Amesos_Superludist | ( | const Epetra_LinearProblem & | LinearProblem | ) |
Amesos_Superludist Constructor.
Creates an Amesos_Superludist instance, using an Epetra_LinearProblem, passing in an already-defined Epetra_LinearProblem object.
Note: The operator in LinearProblem must be an Epetra_RowMatrix.
References Amesos_Control::AddZeroToDiag_, Amesos_Status::ComputeTrueResidual_, Amesos_Status::ComputeVectorNorms_, Amesos_Status::PrintStatus_, Amesos_Status::PrintTiming_, and SetParameters().
Amesos_Superludist::~Amesos_Superludist | ( | void | ) |
Amesos_Superludist Destructor.
Completely deletes an Amesos_Superludist object.
References PrintStatus(), Amesos_Status::PrintStatus_, PrintTiming(), and Amesos_Status::PrintTiming_.
|
inlinevirtual |
Returns the Epetra_LinearProblem.
Warning! Do not call return->SetOperator(...)
to attempt to change the Epetra_Operator
object (even if the new matrix has the same structure). This new operator matrix will be ignored!
Implements Amesos_BaseSolver.
References MatrixShapeOK().
Referenced by GetTiming(), and MatrixShapeOK().
|
virtual |
Returns true if SUPERLUDIST can handle this matrix shape.
Returns true if the matrix shape is one that SUPERLUDIST can handle. SUPERLUDIST only works with square matrices.
Implements Amesos_BaseSolver.
References GetProblem().
Referenced by GetProblem(), and NumericFactorization().
|
virtual |
Performs NumericFactorization on the matrix A.
In addition to performing numeric factorization on the matrix A, the call to NumericFactorization() implies that no change will be made to the underlying matrix without a subsequent call to NumericFactorization().
<br >Preconditions:
<br >Postconditions:
Implements Amesos_BaseSolver.
References Amesos_Time::CreateTimer(), MatrixShapeOK(), and Amesos_Status::NumNumericFact_.
Referenced by Solve().
|
virtual |
Updates internal variables.
<br >Preconditions:
<br >Postconditions:
Implements Amesos_BaseSolver.
References Amesos_Time::AddTime(), Amesos_Control::AddToDiag_, Amesos_Control::AddZeroToDiag_, and Amesos_Time::ResetTimer().
Referenced by Amesos_Superludist(), and UseTranspose().
|
inlinevirtual |
Amesos_Superludist does not support transpose at this time.
returns 0 if UseTranspose is set to false, else 1 (failure)
Implements Amesos_BaseSolver.
|
virtual |
Solves A X = B (or AT x = B)
<br >Preconditions:
<br >Postconditions:
Implements Amesos_BaseSolver.
References Amesos_Time::AddTime(), Amesos_Utils::ComputeTrueResidual(), Amesos_Status::ComputeTrueResidual_, Amesos_Utils::ComputeVectorNorms(), Amesos_Status::ComputeVectorNorms_, NumericFactorization(), Amesos_Status::NumSolve_, Amesos_Time::ResetTimer(), and UseTranspose().
|
virtual |
Performs SymbolicFactorization on the matrix A.
In addition to performing symbolic factorization on the matrix A, the call to SymbolicFactorization() implies that no change will be made to the non-zero structure of the underlying matrix without a subsequent call to SymbolicFactorization().
<br >Preconditions:
<br >Postconditions:
Implements Amesos_BaseSolver.