Amesos_Taucs Class Reference

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

#include <Amesos_Taucs.h>

Inheritance diagram for Amesos_Taucs:

[legend]Collaboration diagram for Amesos_Taucs:[legend]List of all members.

Public Member Functions
Constructor methods
	Amesos_Taucs (const Epetra_LinearProblem &LinearProblem)
	Default constructor.
	~Amesos_Taucs (void)
	Default destructor.
Mathematical functions.
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).
Additional methods required to support the Epetra_Operator interface.
const Epetra_LinearProblem *	GetProblem () const
	Returns the Epetra_LinearProblem.
Query methods.
bool	MatrixShapeOK () const
	Returns true if the solver can handle this matrix shape.
int	SetUseTranspose (bool UseTranspose)
	Amesos_Taucs does not support transpose at this time.
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.
int	SetParameters (Teuchos::ParameterList &ParameterList)
	Updates internal variables.
void	PrintTiming () const
	Prints timing information.
void	PrintStatus () const
	Prints status information.

---

Detailed Description

Amesos_Taucs: An interface to the TAUCS package.

Author:

Marzio Sala, SNL 9214

Date:

Last updated on June 2005

---

Member Function Documentation

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.

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.

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.

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.

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

Amesos_Taucs does not support transpose at this time. returns 0 if UseTranspose is set to false, else 1 (failure) Implements Amesos_BaseSolver.

int Amesos_Taucs::Solve (   )  [virtual]

Solves A X = B (or AT x = B). <br >Preconditions: GetProblem().GetOperator() != 0 (return -1) MatrixShapeOk(GetProblem().GetOperator()) == true (return -6) GetProblem()->CheckInput (see Epetra_LinearProblem::CheckInput() for return values) The non-zero structure of the matrix should not have changed since the last call to SymbolicFactorization(). The distribution of the matrix should not have changed since the last call to SymbolicFactorization() The matrix should not have changed since the last call to NumericFactorization(). <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.

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: GetProblem().GetOperator() != 0 (return -1) MatrixShapeOk(GetProblem().GetOperator()) == true (return -6) <br >Postconditions: Symbolic Factorization will be performed (or marked to be performed) allowing NumericFactorization() and Solve() to be called. Returns: Integer error code, set to 0 if successful. Implements Amesos_BaseSolver.

---

The documentation for this class was generated from the following files:

• Amesos_Taucs.h
• Amesos_Taucs.cpp

---