Amesos Package Browser (Single Doxygen Collection) Development
Private Attributes
Amesos_Taucs Class Reference

Amesos_Taucs: An interface to the TAUCS package. More...

#include <Amesos_Taucs.h>

Inheritance diagram for Amesos_Taucs:
Inheritance graph
[legend]

List of all members.

Private Attributes

bool UseTranspose_
 If true, the transpose of A is used.
Teuchos::RCP< Epetra_MapSerialMap_
Teuchos::RCP< Epetra_CrsMatrixSerialCrsMatrix_
Teuchos::RCP< Epetra_RowMatrixSerialMatrix_
Teuchos::RCP< Epetra_ImportImporter_
const Epetra_MapMap_
const Epetra_RowMatrixMatrix_
const Epetra_LinearProblemProblem_
 Pointer to the linear system problem.
int MtxConvTime_
 Quick accessor pointer to internal timing data.
int MtxRedistTime_
int VecRedistTime_
int SymFactTime_
int NumFactTime_
int SolveTime_
Teuchos::RCP< Amesos_Taucs_PimplPrivateTaucsData_
 Amesos_Taucs (const Epetra_LinearProblem &LinearProblem)
 Default constructor.
 ~Amesos_Taucs (void)
 Default 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_LinearProblemGetProblem () const
 Returns the Epetra_LinearProblem.
bool MatrixShapeOK () const
 Returns true if the solver can handle this matrix shape.
int SetUseTranspose (bool UseTranspose)
 Amesos_Taucs supports only symmetric matrices, hence transpose is irrelevant, but harmless.
bool UseTranspose () const
 Returns the current UseTranspose setting.
const Epetra_CommComm () const
 Returns a pointer to the Epetra_Comm communicator associated with this operator.
int SetParameters (Teuchos::ParameterList &ParameterList)
 Updates internal variables.
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
 Prints timing information.
void PrintStatus () const
 Prints status information.
void GetTiming (Teuchos::ParameterList &TimingParameterList) const
 Extracts timing information from the current solver and places it in the parameter list.
const Epetra_MapMap () const
 Returns a reference to the RowMatrixRowMap().
const Epetra_RowMatrixMatrix () const
 Returns a reference to the linear system matrix.
Epetra_MapSerialMap ()
 Returns a reference to the already allocated SerialMap.
Epetra_RowMatrixSerialMatrix ()
 Returns a reference to the SerialMatrix.
Epetra_CrsMatrixSerialCrsMatrix ()
 Returns a reference to the already SerialMatrix as Crs (if allocated).
Epetra_ImportImporter ()
 Returns a reference to the already allocated Importer.
int ConvertToSerial ()
 Constructs a matrix with all rows on processor 0.
int ConvertToTaucs ()
 Converts the Epetra_RowMatrix into TAUCS format.
int PerformSymbolicFactorization ()
 Performs the symbolic factorization.
int PerformNumericFactorization ()
 Performs the numeric factorization.

Detailed Description

Amesos_Taucs: An interface to the TAUCS package.

Interface to TAUCS.

Author:
Marzio Sala, SNL 9214
Date:
Last updated on June 2005
Last updated on 24-May-05.

Definition at line 73 of file Amesos_Taucs.h.


Constructor & Destructor Documentation

Amesos_Taucs::Amesos_Taucs ( const Epetra_LinearProblem LinearProblem)

Default constructor.

Definition at line 88 of file Amesos_Taucs.cpp.

Amesos_Taucs::~Amesos_Taucs ( void  )

Default destructor.

Definition at line 101 of file Amesos_Taucs.cpp.


Member Function Documentation

int Amesos_Taucs::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:

Returns:
Integer error code, set to 0 if successful.

Implements Amesos_BaseSolver.

Definition at line 307 of file Amesos_Taucs.cpp.

int Amesos_Taucs::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:

  • GetProblem().GetOperator() != 0 (return -1)
  • MatrixShapeOk(GetProblem().GetOperator()) == true (return -6)
  • The non-zero structure of the matrix should not have changed since the last call to SymbolicFactorization(). (return -2 if the number of non-zeros changes) Other changes can have arbitrary consequences.
  • The distribution of the matrix should not have changed since the last call to SymbolicFactorization()
  • The matrix should be indexed from 0 to n-1, unless the parameter "Reindex" was set to "true" prior to the call to SymbolicFactorization(). (return -3 - if caught)
  • The paremeter "Reindex" should not be set to "true" except on CrsMatrices. (return -4)
  • The paremeter "Reindex" should not be set to "true" unless Amesos was built with EpetraExt, i.e. with --enable-epetraext on the configure line. (return -4)
  • Internal errors retur -5.

<br >Postconditions:

  • Numeric Factorization will be performed (or marked to be performed) allowing Solve() to be performed correctly despite a potential change in in the matrix values (though not in the non-zero structure).
Returns:
Integer error code, set to 0 if successful.

Implements Amesos_BaseSolver.

Definition at line 351 of file Amesos_Taucs.cpp.

int Amesos_Taucs::Solve ( ) [virtual]

Solves A X = B (or AT x = B)

<br >Preconditions:

<br >Postconditions:

  • X will be set such that A X = B (or AT X = B), within the limits of the accuracy of the underlying solver.
Returns:
Integer error code, set to 0 if successful.

Implements Amesos_BaseSolver.

Definition at line 375 of file Amesos_Taucs.cpp.

const Epetra_LinearProblem* Amesos_Taucs::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.

Definition at line 102 of file Amesos_Taucs.h.

bool Amesos_Taucs::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.

Definition at line 294 of file Amesos_Taucs.cpp.

int Amesos_Taucs::SetUseTranspose ( bool  UseTranspose) [inline, virtual]

Amesos_Taucs supports only symmetric matrices, hence transpose is irrelevant, but harmless.

Implements Amesos_BaseSolver.

Definition at line 112 of file Amesos_Taucs.h.

bool Amesos_Taucs::UseTranspose ( ) const [inline, virtual]

Returns the current UseTranspose setting.

Implements Amesos_BaseSolver.

Definition at line 114 of file Amesos_Taucs.h.

const Epetra_Comm& Amesos_Taucs::Comm ( ) const [inline, virtual]

Returns a pointer to the Epetra_Comm communicator associated with this operator.

Implements Amesos_BaseSolver.

Definition at line 116 of file Amesos_Taucs.h.

int Amesos_Taucs::SetParameters ( Teuchos::ParameterList ParameterList) [virtual]

Updates internal variables.

<br >Preconditions:

  • None.

<br >Postconditions:

  • Internal variables controlling the factorization and solve will be updated and take effect on all subseuent calls to NumericFactorization() and Solve().
  • All parameters whose value are to differ from the default values must be included in ParameterList. Parameters not specified in ParameterList revert to their default values.
Returns:
Integer error code, set to 0 if successful.

Implements Amesos_BaseSolver.

Definition at line 230 of file Amesos_Taucs.cpp.

int Amesos_Taucs::NumSymbolicFact ( ) const [inline, virtual]

Returns the number of symbolic factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 121 of file Amesos_Taucs.h.

int Amesos_Taucs::NumNumericFact ( ) const [inline, virtual]

Returns the number of numeric factorizations performed by this object.

Implements Amesos_BaseSolver.

Definition at line 124 of file Amesos_Taucs.h.

int Amesos_Taucs::NumSolve ( ) const [inline, virtual]

Returns the number of solves performed by this object.

Implements Amesos_BaseSolver.

Definition at line 127 of file Amesos_Taucs.h.

void Amesos_Taucs::PrintTiming ( ) const [virtual]

Prints timing information.

Implements Amesos_BaseSolver.

Definition at line 492 of file Amesos_Taucs.cpp.

void Amesos_Taucs::PrintStatus ( ) const [virtual]

Prints status information.

Implements Amesos_BaseSolver.

Definition at line 463 of file Amesos_Taucs.cpp.

void Amesos_Taucs::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.

Definition at line 136 of file Amesos_Taucs.h.

const Epetra_Map& Amesos_Taucs::Map ( ) const [inline, private]

Returns a reference to the RowMatrixRowMap().

Definition at line 144 of file Amesos_Taucs.h.

const Epetra_RowMatrix& Amesos_Taucs::Matrix ( ) const [inline, private]

Returns a reference to the linear system matrix.

Definition at line 150 of file Amesos_Taucs.h.

Epetra_Map& Amesos_Taucs::SerialMap ( ) [inline, private]

Returns a reference to the already allocated SerialMap.

Definition at line 156 of file Amesos_Taucs.h.

Epetra_RowMatrix& Amesos_Taucs::SerialMatrix ( ) [inline, private]

Returns a reference to the SerialMatrix.

Definition at line 162 of file Amesos_Taucs.h.

Epetra_CrsMatrix& Amesos_Taucs::SerialCrsMatrix ( ) [inline, private]

Returns a reference to the already SerialMatrix as Crs (if allocated).

Definition at line 168 of file Amesos_Taucs.h.

Epetra_Import& Amesos_Taucs::Importer ( ) [inline, private]

Returns a reference to the already allocated Importer.

Definition at line 174 of file Amesos_Taucs.h.

int Amesos_Taucs::ConvertToSerial ( ) [private]

Constructs a matrix with all rows on processor 0.

Definition at line 124 of file Amesos_Taucs.cpp.

int Amesos_Taucs::ConvertToTaucs ( ) [private]

Converts the Epetra_RowMatrix into TAUCS format.

Definition at line 159 of file Amesos_Taucs.cpp.

int Amesos_Taucs::PerformSymbolicFactorization ( ) [private]

Performs the symbolic factorization.

Definition at line 242 of file Amesos_Taucs.cpp.

int Amesos_Taucs::PerformNumericFactorization ( ) [private]

Performs the numeric factorization.

Definition at line 270 of file Amesos_Taucs.cpp.


Member Data Documentation

If true, the transpose of A is used.

Definition at line 194 of file Amesos_Taucs.h.

Definition at line 196 of file Amesos_Taucs.h.

Definition at line 197 of file Amesos_Taucs.h.

Definition at line 198 of file Amesos_Taucs.h.

Definition at line 199 of file Amesos_Taucs.h.

const Epetra_Map* Amesos_Taucs::Map_ [private]

Definition at line 201 of file Amesos_Taucs.h.

Definition at line 202 of file Amesos_Taucs.h.

Pointer to the linear system problem.

Definition at line 205 of file Amesos_Taucs.h.

Quick accessor pointer to internal timing data.

Definition at line 208 of file Amesos_Taucs.h.

Definition at line 208 of file Amesos_Taucs.h.

Definition at line 208 of file Amesos_Taucs.h.

Definition at line 209 of file Amesos_Taucs.h.

Definition at line 209 of file Amesos_Taucs.h.

int Amesos_Taucs::SolveTime_ [private]

Definition at line 209 of file Amesos_Taucs.h.

Definition at line 215 of file Amesos_Taucs.h.


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