#include <Amesos_Lapack.h>
Public Member Functions | |
Amesos_Lapack (const Epetra_LinearProblem &LinearProblem) | |
Amesos_Lapack Constructor. | |
~Amesos_Lapack (void) | |
Amesos_Lapack Destructor. | |
int | SymbolicFactorization () |
Performs SymbolicFactorization on the matrix A. | |
int | NumericFactorization () |
Performs NumericFactorization on the matrix A. | |
int | Solve () |
Solves A X = B (or AT x = B). | |
const Epetra_LinearProblem * | GetProblem () const |
Returns the Epetra_LinearProblem. | |
bool | MatrixShapeOK () const |
Returns true if the solver can handle this matrix shape. | |
int | SetUseTranspose (bool UseTranspose_in) |
If set true, X will be set to the solution of AT X = B (not A X = B). | |
bool | UseTranspose () const |
Returns the current UseTranspose setting. | |
const Epetra_Comm & | Comm () const |
Returns a pointer to the Epetra_Comm communicator associated with this operator. | |
void | setParameterList (Teuchos::RCP< Teuchos::ParameterList > const ¶mList) |
Use this parameter list to read values from. | |
Teuchos::RCP < Teuchos::ParameterList > | unsetParameterList () |
This is an empty stub. | |
int | SetParameters (Teuchos::ParameterList &ParameterList) |
Deprecated - Sets parameters. | |
int | GEEV (Epetra_Vector &Er, Epetra_Vector &Ei) |
Computes the eigenvalues of the linear system matrix using DGEEV. | |
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 timing information. | |
void | PrintStatus () const |
Print information about the factorization and solution phases. | |
void | GetTiming (Teuchos::ParameterList &TimingParameterList) const |
Extracts timing information from the current solver and places it in the parameter list. | |
Protected Member Functions | |
const Epetra_RowMatrix * | Matrix () const |
Returns a pointer to the linear system matrix. | |
int | NumGlobalRows () const |
Returns the number of global rows, or -1 if Matrix() returns 0. | |
int | NumMyRows () const |
Returns the number of local rows, or -1 if Matrix() returns 0. | |
const Epetra_Map & | SerialMap () |
Returns a reference to serial map (that with all elements on process 0). Builds SerialMap_ if necessary or required. | |
Epetra_RowMatrix & | SerialMatrix () |
Returns a reference to serial matrix (that with all rows on process 0). Builds SerialMap_ if necessary or required. | |
Epetra_CrsMatrix & | SerialCrsMatrix () |
const Epetra_Import & | Importer () |
Returns a reference to the importer map. Builds SerialMap_ if necessary or required. | |
int | SolveSerial (Epetra_MultiVector &X, const Epetra_MultiVector &B) |
Solves the linear system, when only one process is used. | |
int | SolveDistributed (Epetra_MultiVector &X, const Epetra_MultiVector &B) |
Solves the linear system, when more than one process is used. | |
int | DistributedToSerial () |
Converts a distributed matrix to serial matrix. | |
int | SerialToDense () |
Converts a serial matrix to dense format. | |
int | DenseToFactored () |
Factors the matrix using LAPACK. | |
Protected Attributes | |
Teuchos::RCP < Teuchos::ParameterList > | pl_ |
Teuchos::RCP< Epetra_RowMatrix > | SerialMatrix_ |
Teuchos::RCP< Epetra_CrsMatrix > | SerialCrsMatrix_ |
Teuchos::RCP< Epetra_Map > | SerialMap_ |
Teuchos::RCP< Epetra_Import > | Importer_ |
Epetra_SerialDenseMatrix | DenseMatrix_ |
Dense matrix. | |
Epetra_SerialDenseMatrix | DenseLHS_ |
Dense LHS. | |
Epetra_SerialDenseMatrix | DenseRHS_ |
Dense RHS. | |
Epetra_SerialDenseSolver | DenseSolver_ |
Linear problem for dense matrix and vectors. | |
bool | UseTranspose_ |
If true , the linear system with the transpose will be solved. | |
const Epetra_LinearProblem * | Problem_ |
Pointer to the linear problem. | |
int | MtxRedistTime_ |
Quick access ids for the individual timings. | |
int | MtxConvTime_ |
int | VecRedistTime_ |
int | SymFactTime_ |
int | NumFactTime_ |
int | SolveTime_ |
int | NumGlobalRows_ |
int | NumGlobalNonzeros_ |
Teuchos::RCP < Teuchos::ParameterList > | ParameterList_ |
Class Amesos_Lapack enables the solution of the distributed linear system, defined by an Epetra_LinearProblem, using LAPACK.
Amesos_Lapack stores the lineaar system matrix as an Epetra_SerialDensMatrix. The linear problem is an Epetra_SerialDenseProblem. Amesos_Lapack factorizes the matrix using DGETRF().
Amesos_Lapack::Amesos_Lapack | ( | const Epetra_LinearProblem & | LinearProblem | ) |
Amesos_Lapack Constructor.
Creates an Amesos_Lapack instance, using an Epetra_LinearProblem, passing in an already-defined Epetra_LinearProblem object.
Note: The operator in LinearProblem must be an Epetra_RowMatrix.
Amesos_Lapack::~Amesos_Lapack | ( | void | ) |
Amesos_Lapack Destructor.
Completely deletes an Amesos_Lapack object.
const Epetra_Comm& Amesos_Lapack::Comm | ( | ) | const [inline, virtual] |
Returns a pointer to the Epetra_Comm communicator associated with this operator.
Implements Amesos_BaseSolver.
int Amesos_Lapack::DenseToFactored | ( | ) | [protected] |
Factors the matrix using LAPACK.
int Amesos_Lapack::DistributedToSerial | ( | ) | [protected] |
Converts a distributed matrix to serial matrix.
int Amesos_Lapack::GEEV | ( | Epetra_Vector & | Er, | |
Epetra_Vector & | Ei | |||
) |
Computes the eigenvalues of the linear system matrix using DGEEV.
Er | - (Out) On processor zero only, it will contain the real component of the eigenvalues. | |
Ei | - (Out) On processor zero only, it will contain the imaginary component of the eigenvalues. |
const Epetra_LinearProblem* Amesos_Lapack::GetProblem | ( | ) | const [inline, virtual] |
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.
void Amesos_Lapack::GetTiming | ( | Teuchos::ParameterList & | TimingParameterList | ) | const [inline, virtual] |
Extracts timing information from the current solver and places it in the parameter list.
Reimplemented from Amesos_BaseSolver.
const Epetra_Import& Amesos_Lapack::Importer | ( | ) | [inline, protected] |
Returns a reference to the importer map. Builds SerialMap_ if necessary or required.
const Epetra_RowMatrix* Amesos_Lapack::Matrix | ( | ) | const [inline, protected] |
Returns a pointer to the linear system matrix.
bool Amesos_Lapack::MatrixShapeOK | ( | ) | const [virtual] |
Returns true if the solver can handle this matrix shape.
Returns true if the matrix shape is one that the underlying sparse direct solver can handle. Classes that work only on square matrices should return false for rectangular matrices. Classes that work only on symmetric matrices whould return false for non-symmetric matrices.
Implements Amesos_BaseSolver.
int Amesos_Lapack::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.
int Amesos_Lapack::NumGlobalRows | ( | ) | const [inline, protected] |
Returns the number of global rows, or -1 if Matrix() returns 0.
int Amesos_Lapack::NumMyRows | ( | ) | const [inline, protected] |
Returns the number of local rows, or -1 if Matrix() returns 0.
int Amesos_Lapack::NumNumericFact | ( | ) | const [inline, virtual] |
Returns the number of numeric factorizations performed by this object.
Implements Amesos_BaseSolver.
int Amesos_Lapack::NumSolve | ( | ) | const [inline, virtual] |
int Amesos_Lapack::NumSymbolicFact | ( | ) | const [inline, virtual] |
Returns the number of symbolic factorizations performed by this object.
Implements Amesos_BaseSolver.
void Amesos_Lapack::PrintStatus | ( | ) | const [virtual] |
void Amesos_Lapack::PrintTiming | ( | ) | const [virtual] |
Epetra_CrsMatrix& Amesos_Lapack::SerialCrsMatrix | ( | ) | [inline, protected] |
const Epetra_Map& Amesos_Lapack::SerialMap | ( | ) | [inline, protected] |
Returns a reference to serial map (that with all elements on process 0). Builds SerialMap_ if necessary or required.
Epetra_RowMatrix& Amesos_Lapack::SerialMatrix | ( | ) | [inline, protected] |
Returns a reference to serial matrix (that with all rows on process 0). Builds SerialMap_ if necessary or required.
int Amesos_Lapack::SerialToDense | ( | ) | [protected] |
Converts a serial matrix to dense format.
void Amesos_Lapack::setParameterList | ( | Teuchos::RCP< Teuchos::ParameterList > const & | paramList | ) | [virtual] |
Use this parameter list to read values from.
Redefined from Teuchos::ParameterListAcceptor
Reimplemented from Amesos_BaseSolver.
int Amesos_Lapack::SetParameters | ( | Teuchos::ParameterList & | ParameterList | ) | [virtual] |
int Amesos_Lapack::SetUseTranspose | ( | bool | UseTranspose | ) | [inline, virtual] |
If set true, X will be set to the solution of AT X = B (not A X = B).
If the implementation of this interface does not support transpose use, this method should return a value of -1.
<br >Preconditions:
<br >Postconditions:
UseTranspose | -- (In) If true, solve AT X = B, otherwise solve A X = B. |
Implements Amesos_BaseSolver.
int Amesos_Lapack::Solve | ( | ) | [virtual] |
Solves A X = B (or AT x = B).
<br >Preconditions:
<br >Postconditions:
Implements Amesos_BaseSolver.
int Amesos_Lapack::SolveDistributed | ( | Epetra_MultiVector & | X, | |
const Epetra_MultiVector & | B | |||
) | [protected] |
Solves the linear system, when more than one process is used.
int Amesos_Lapack::SolveSerial | ( | Epetra_MultiVector & | X, | |
const Epetra_MultiVector & | B | |||
) | [protected] |
Solves the linear system, when only one process is used.
int Amesos_Lapack::SymbolicFactorization | ( | ) | [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.
Teuchos::RCP<Teuchos::ParameterList> Amesos_Lapack::unsetParameterList | ( | ) | [virtual] |
bool Amesos_Lapack::UseTranspose | ( | ) | const [inline, virtual] |
Epetra_SerialDenseMatrix Amesos_Lapack::DenseLHS_ [protected] |
Dense LHS.
Epetra_SerialDenseMatrix Amesos_Lapack::DenseMatrix_ [protected] |
Dense matrix.
Epetra_SerialDenseMatrix Amesos_Lapack::DenseRHS_ [protected] |
Dense RHS.
Epetra_SerialDenseSolver Amesos_Lapack::DenseSolver_ [protected] |
Linear problem for dense matrix and vectors.
Teuchos::RCP<Epetra_Import> Amesos_Lapack::Importer_ [protected] |
int Amesos_Lapack::MtxConvTime_ [protected] |
int Amesos_Lapack::MtxRedistTime_ [protected] |
Quick access ids for the individual timings.
int Amesos_Lapack::NumFactTime_ [protected] |
int Amesos_Lapack::NumGlobalNonzeros_ [protected] |
int Amesos_Lapack::NumGlobalRows_ [protected] |
Teuchos::RCP<Teuchos::ParameterList> Amesos_Lapack::ParameterList_ [protected] |
Teuchos::RCP<Teuchos::ParameterList> Amesos_Lapack::pl_ [protected] |
const Epetra_LinearProblem* Amesos_Lapack::Problem_ [protected] |
Pointer to the linear problem.
Teuchos::RCP<Epetra_CrsMatrix> Amesos_Lapack::SerialCrsMatrix_ [protected] |
Teuchos::RCP<Epetra_Map> Amesos_Lapack::SerialMap_ [protected] |
Teuchos::RCP<Epetra_RowMatrix> Amesos_Lapack::SerialMatrix_ [protected] |
int Amesos_Lapack::SolveTime_ [protected] |
int Amesos_Lapack::SymFactTime_ [protected] |
bool Amesos_Lapack::UseTranspose_ [protected] |
If true
, the linear system with the transpose will be solved.
int Amesos_Lapack::VecRedistTime_ [protected] |