Public Member Functions | |
def | __init__ |
def | SymbolicFactorization |
def | NumericFactorization |
def | Solve |
def | SetUseTranspose |
def | GetProblem |
def | MatrixShapeOK |
def | UseTranspose |
def | SetParameters |
def | NumSymbolicFact |
def | NumNumericFact |
def | NumSolve |
def | PrintTiming |
def | PrintStatus |
def | GetTiming |
def | __init__ |
def | SymbolicFactorization |
def | NumericFactorization |
def | Solve |
def | SetUseTranspose |
def | GetProblem |
def | MatrixShapeOK |
def | UseTranspose |
def | SetParameters |
def | NumSymbolicFact |
def | NumNumericFact |
def | NumSolve |
def | PrintTiming |
def | PrintStatus |
def | GetTiming |
Public Attributes | |
this |
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. C++ includes: Amesos_Superludist.h
def PyTrilinos::Amesos::Superludist::__init__ | ( | self, | ||
args | ||||
) |
__init__(self, LinearProblem LinearProblem) -> Superludist 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.
def PyTrilinos::Amesos::Superludist::__init__ | ( | self, | ||
args | ||||
) |
__init__(self, LinearProblem LinearProblem) -> Superludist 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.
def PyTrilinos::Amesos::Superludist::GetProblem | ( | self, | ||
args | ||||
) |
GetProblem(self) -> LinearProblem const Epetra_LinearProblem* Amesos_Superludist::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::Superludist::GetProblem | ( | self, | ||
args | ||||
) |
GetProblem(self) -> LinearProblem const Epetra_LinearProblem* Amesos_Superludist::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::Superludist::GetTiming | ( | self, | ||
args | ||||
) |
GetTiming(self, ParameterList TimingParameterList) void Amesos_Superludist::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::Superludist::GetTiming | ( | self, | ||
args | ||||
) |
GetTiming(self, ParameterList TimingParameterList) void Amesos_Superludist::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::Superludist::MatrixShapeOK | ( | self, | ||
args | ||||
) |
MatrixShapeOK(self) -> bool bool Amesos_Superludist::MatrixShapeOK() const 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.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::MatrixShapeOK | ( | self, | ||
args | ||||
) |
MatrixShapeOK(self) -> bool bool Amesos_Superludist::MatrixShapeOK() const 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.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::NumericFactorization | ( | self, | ||
args | ||||
) |
NumericFactorization(self) -> int int Amesos_Superludist::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::Superludist::NumericFactorization | ( | self, | ||
args | ||||
) |
NumericFactorization(self) -> int int Amesos_Superludist::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::Superludist::NumNumericFact | ( | self, | ||
args | ||||
) |
NumNumericFact(self) -> int int Amesos_Superludist::NumNumericFact() const Returns the number of numeric factorizations performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::NumNumericFact | ( | self, | ||
args | ||||
) |
NumNumericFact(self) -> int int Amesos_Superludist::NumNumericFact() const Returns the number of numeric factorizations performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::NumSolve | ( | self, | ||
args | ||||
) |
NumSolve(self) -> int int Amesos_Superludist::NumSolve() const Returns the number of solves performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::NumSolve | ( | self, | ||
args | ||||
) |
NumSolve(self) -> int int Amesos_Superludist::NumSolve() const Returns the number of solves performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::NumSymbolicFact | ( | self, | ||
args | ||||
) |
NumSymbolicFact(self) -> int int Amesos_Superludist::NumSymbolicFact() const Returns the number of symbolic factorizations performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::NumSymbolicFact | ( | self, | ||
args | ||||
) |
NumSymbolicFact(self) -> int int Amesos_Superludist::NumSymbolicFact() const Returns the number of symbolic factorizations performed by this object.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::PrintStatus | ( | self, | ||
args | ||||
) |
PrintStatus(self) void Amesos_Superludist::PrintStatus() const Print various information about the parameters used by Superludist.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::PrintStatus | ( | self, | ||
args | ||||
) |
PrintStatus(self) void Amesos_Superludist::PrintStatus() const Print various information about the parameters used by Superludist.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::PrintTiming | ( | self, | ||
args | ||||
) |
PrintTiming(self) void Amesos_Superludist::PrintTiming() const Print various timig.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::PrintTiming | ( | self, | ||
args | ||||
) |
PrintTiming(self) void Amesos_Superludist::PrintTiming() const Print various timig.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::SetParameters | ( | self, | ||
args | ||||
) |
SetParameters(self, ParameterList ParameterList) -> int int Amesos_Superludist::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::Superludist::SetParameters | ( | self, | ||
args | ||||
) |
SetParameters(self, ParameterList ParameterList) -> int int Amesos_Superludist::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::Superludist::SetUseTranspose | ( | self, | ||
args | ||||
) |
SetUseTranspose(self, bool UseTranspose) -> int int Amesos_Superludist::SetUseTranspose(bool UseTranspose) Amesos_Superludist does not support transpose at this time. returns 0 if UseTranspose is set to false, else 1 (failure)
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::SetUseTranspose | ( | self, | ||
args | ||||
) |
SetUseTranspose(self, bool UseTranspose) -> int int Amesos_Superludist::SetUseTranspose(bool UseTranspose) Amesos_Superludist does not support transpose at this time. returns 0 if UseTranspose is set to false, else 1 (failure)
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::Solve | ( | self, | ||
args | ||||
) |
Solve(self) -> int int Amesos_Superludist::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::Superludist::Solve | ( | self, | ||
args | ||||
) |
Solve(self) -> int int Amesos_Superludist::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::Superludist::SymbolicFactorization | ( | self, | ||
args | ||||
) |
SymbolicFactorization(self) -> int int Amesos_Superludist::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::Superludist::SymbolicFactorization | ( | self, | ||
args | ||||
) |
SymbolicFactorization(self) -> int int Amesos_Superludist::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::Superludist::UseTranspose | ( | self, | ||
args | ||||
) |
UseTranspose(self) -> bool bool Amesos_Superludist::UseTranspose() const Always returns true.
Reimplemented from PyTrilinos::Amesos::BaseSolver.
def PyTrilinos::Amesos::Superludist::UseTranspose | ( | self, | ||
args | ||||
) |
UseTranspose(self) -> bool bool Amesos_Superludist::UseTranspose() const Always returns true.
Reimplemented from PyTrilinos::Amesos::BaseSolver.