Public Member Functions | |
def | __init__ |
def | SymbolicFactorization |
def | NumericFactorization |
def | Solve |
def | GetProblem |
def | MatrixShapeOK |
def | SetUseTranspose |
def | UseTranspose |
def | Comm |
def | SetParameters |
def | NumSymbolicFact |
def | NumNumericFact |
def | NumSolve |
def | PrintTiming |
def | PrintStatus |
def | GetTiming |
def | __init__ |
def | SymbolicFactorization |
def | NumericFactorization |
def | Solve |
def | GetProblem |
def | MatrixShapeOK |
def | SetUseTranspose |
def | UseTranspose |
def | Comm |
def | SetParameters |
def | NumSymbolicFact |
def | NumNumericFact |
def | NumSolve |
def | PrintTiming |
def | PrintStatus |
def | GetTiming |
Public Attributes | |
this |
Interface to TAUCS. C++ includes: Amesos_Taucs.h
def PyTrilinos::Amesos::Taucs::__init__ | ( | self, | ||
args | ||||
) |
__init__(self, LinearProblem LinearProblem) -> Taucs Amesos_Taucs::Amesos_Taucs(const Epetra_LinearProblem &LinearProblem) Default constructor.
def PyTrilinos::Amesos::Taucs::__init__ | ( | self, | ||
args | ||||
) |
__init__(self, LinearProblem LinearProblem) -> Taucs Amesos_Taucs::Amesos_Taucs(const Epetra_LinearProblem &LinearProblem) Default constructor.
def PyTrilinos::Amesos::Taucs::Comm | ( | self, | ||
args | ||||
) |
Comm(self) -> Comm const Epetra_Comm& Amesos_Taucs::Comm() const Returns a pointer to the Epetra_Comm communicator associated with this operator.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::Comm | ( | self, | ||
args | ||||
) |
Comm(self) -> Comm const Epetra_Comm& Amesos_Taucs::Comm() const Returns a pointer to the Epetra_Comm communicator associated with this operator.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::GetProblem | ( | self, | ||
args | ||||
) |
GetProblem(self) -> LinearProblem const Epetra_LinearProblem* Amesos_Taucs::GetProblem() const 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!
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::GetProblem | ( | self, | ||
args | ||||
) |
GetProblem(self) -> LinearProblem const Epetra_LinearProblem* Amesos_Taucs::GetProblem() const 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!
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::GetTiming | ( | self, | ||
args | ||||
) |
GetTiming(self, ParameterList TimingParameterList) void Amesos_Taucs::GetTiming(Teuchos::ParameterList &TimingParameterList) const Extracts timing information from the current solver and places it in the parameter list.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::GetTiming | ( | self, | ||
args | ||||
) |
GetTiming(self, ParameterList TimingParameterList) void Amesos_Taucs::GetTiming(Teuchos::ParameterList &TimingParameterList) const Extracts timing information from the current solver and places it in the parameter list.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::MatrixShapeOK | ( | self, | ||
args | ||||
) |
MatrixShapeOK(self) -> bool bool Amesos_Taucs::MatrixShapeOK() const 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.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::MatrixShapeOK | ( | self, | ||
args | ||||
) |
MatrixShapeOK(self) -> bool bool Amesos_Taucs::MatrixShapeOK() const 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.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::NumericFactorization | ( | self, | ||
args | ||||
) |
NumericFactorization(self) -> int int Amesos_Taucs::NumericFactorization() 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). Integer error code, set to 0 if successful.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::NumericFactorization | ( | self, | ||
args | ||||
) |
NumericFactorization(self) -> int int Amesos_Taucs::NumericFactorization() 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). Integer error code, set to 0 if successful.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::NumNumericFact | ( | self, | ||
args | ||||
) |
NumNumericFact(self) -> int int Amesos_Taucs::NumNumericFact() const Returns the number of numeric factorizations performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::NumNumericFact | ( | self, | ||
args | ||||
) |
NumNumericFact(self) -> int int Amesos_Taucs::NumNumericFact() const Returns the number of numeric factorizations performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::NumSolve | ( | self, | ||
args | ||||
) |
NumSolve(self) -> int int Amesos_Taucs::NumSolve() const Returns the number of solves performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::NumSolve | ( | self, | ||
args | ||||
) |
NumSolve(self) -> int int Amesos_Taucs::NumSolve() const Returns the number of solves performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::NumSymbolicFact | ( | self, | ||
args | ||||
) |
NumSymbolicFact(self) -> int int Amesos_Taucs::NumSymbolicFact() const Returns the number of symbolic factorizations performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::NumSymbolicFact | ( | self, | ||
args | ||||
) |
NumSymbolicFact(self) -> int int Amesos_Taucs::NumSymbolicFact() const Returns the number of symbolic factorizations performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::PrintStatus | ( | self, | ||
args | ||||
) |
PrintStatus(self) void Amesos_Taucs::PrintStatus() const Prints status information.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::PrintStatus | ( | self, | ||
args | ||||
) |
PrintStatus(self) void Amesos_Taucs::PrintStatus() const Prints status information.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::PrintTiming | ( | self, | ||
args | ||||
) |
PrintTiming(self) void Amesos_Taucs::PrintTiming() const Prints timing information.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::PrintTiming | ( | self, | ||
args | ||||
) |
PrintTiming(self) void Amesos_Taucs::PrintTiming() const Prints timing information.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::SetParameters | ( | self, | ||
args | ||||
) |
SetParameters(self, ParameterList ParameterList) -> int int Amesos_Taucs::SetParameters(Teuchos::ParameterList &ParameterList) 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. Integer error code, set to 0 if successful.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::SetParameters | ( | self, | ||
args | ||||
) |
SetParameters(self, ParameterList ParameterList) -> int int Amesos_Taucs::SetParameters(Teuchos::ParameterList &ParameterList) 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. Integer error code, set to 0 if successful.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::SetUseTranspose | ( | self, | ||
args | ||||
) |
SetUseTranspose(self, bool UseTranspose) -> int int Amesos_Taucs::SetUseTranspose(bool UseTranspose) Amesos_Taucs supports only symmetric matrices, hence transpose is irrelevant, but harmless.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::SetUseTranspose | ( | self, | ||
args | ||||
) |
SetUseTranspose(self, bool UseTranspose) -> int int Amesos_Taucs::SetUseTranspose(bool UseTranspose) Amesos_Taucs supports only symmetric matrices, hence transpose is irrelevant, but harmless.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::Solve | ( | self, | ||
args | ||||
) |
Solve(self) -> int int Amesos_Taucs::Solve() 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. Integer error code, set to 0 if successful.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::Solve | ( | self, | ||
args | ||||
) |
Solve(self) -> int int Amesos_Taucs::Solve() 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. Integer error code, set to 0 if successful.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::SymbolicFactorization | ( | self, | ||
args | ||||
) |
SymbolicFactorization(self) -> int int Amesos_Taucs::SymbolicFactorization() 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. Integer error code, set to 0 if successful.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::SymbolicFactorization | ( | self, | ||
args | ||||
) |
SymbolicFactorization(self) -> int int Amesos_Taucs::SymbolicFactorization() 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. Integer error code, set to 0 if successful.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::UseTranspose | ( | self, | ||
args | ||||
) |
UseTranspose(self) -> bool bool Amesos_Taucs::UseTranspose() const Returns the current UseTranspose setting.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Taucs::UseTranspose | ( | self, | ||
args | ||||
) |
UseTranspose(self) -> bool bool Amesos_Taucs::UseTranspose() const Returns the current UseTranspose setting.
Reimplemented from PyTrilinos::Amesos::BaseSolver.