|
PyTrilinos
Development
|
Public Member Functions | |
| def | __init__ |
| def | SetParameters |
| def | Matrix |
| def | IsInitialized |
| def | Initialize |
| def | Compute |
| def | IsComputed |
| def | ApplyInverse |
| def | Apply |
| def | Condest |
| def | NumGlobalNonzeros |
| def | NumMyNonzeros |
| def | H |
| def | SetUseTranspose |
| def | NormInf |
| def | HasNormInf |
| def | UseTranspose |
| def | OperatorDomainMap |
| def | OperatorRangeMap |
| def | Comm |
| def | Label |
| def | SetLabel |
| def | NumInitialize |
| def | NumCompute |
| def | NumApplyInverse |
| def | InitializeTime |
| def | ComputeTime |
| def | ApplyInverseTime |
| def | InitializeFlops |
| def | ComputeFlops |
| def | ApplyInverseFlops |
| def | LevelOfFill |
| def | AbsoluteThreshold |
| def | RelativeThreshold |
| def | RelaxValue |
| def | DropTolerance |
Public Attributes | |
| this | |
Ifpack_ICT: A class for constructing and using an incomplete Cholesky factorization of a given Epetra_RowMatrix. The Ifpack_ICT class computes a threshold based incomplete LDL^T factorization of a given Epetra_RowMatrix. The factorization that is produced is a function of several parameters: Maximum number of entries per row/column in factor - The factorization will contain at most this number of nonzero terms in each row/column of the factorization. Diagonal perturbation - Prior to computing the factorization, it is possible to modify the diagonal entries of the matrix for which the factorization will be computing. If the absolute and relative perturbation values are zero and one, respectively, the factorization will be compute for the original user matrix A. Otherwise, the factorization will computed for a matrix that differs from the original user matrix in the diagonal values only. Details can be found in ifp_diag_pert. C++ includes: Ifpack_ICT.h
| def PyTrilinos.IFPACK.ICT.__init__ | ( | self, | |
| args | |||
| ) |
__init__(Ifpack_ICT self, RowMatrix A) -> ICT Ifpack_ICT::Ifpack_ICT(const Epetra_RowMatrix *A) Ifpack_ICT constuctor with variable number of indices per row. Creates a Ifpack_ICT object and allocates storage. Parameters: ----------- In: A - User matrix to be factored. In: Graph - Graph generated by Ifpack_IlukGraph.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.ICT.AbsoluteThreshold | ( | self, | |
| args | |||
| ) |
AbsoluteThreshold(ICT self) -> double double Ifpack_ICT::AbsoluteThreshold() const Returns the absolute threshold.
| def PyTrilinos.IFPACK.ICT.Apply | ( | self, | |
| args | |||
| ) |
Apply(ICT self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int int Ifpack_ICT::Apply(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.ICT.ApplyInverse | ( | self, | |
| args | |||
| ) |
ApplyInverse(ICT self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int int Ifpack_ICT::ApplyInverse(const Epetra_MultiVector &X, Epetra_MultiVector &Y) const Returns the result of a Ifpack_ICT forward/back solve on a Epetra_MultiVector X in Y. Parameters: ----------- In: Trans -If true, solve transpose problem. In: X - A Epetra_MultiVector of dimension NumVectors to solve for. Out: Y -A Epetra_MultiVector of dimension NumVectorscontaining result. Integer error code, set to 0 if successful.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.ApplyInverseFlops | ( | self, | |
| args | |||
| ) |
ApplyInverseFlops(ICT self) -> double virtual double Ifpack_ICT::ApplyInverseFlops() const Returns the number of flops in all applications of ApplyInverse().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.ApplyInverseTime | ( | self, | |
| args | |||
| ) |
ApplyInverseTime(ICT self) -> double virtual double Ifpack_ICT::ApplyInverseTime() const Returns the time spent in ApplyInverse().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.Comm | ( | self, | |
| args | |||
| ) |
Comm(ICT self) -> Comm const Epetra_Comm& Ifpack_ICT::Comm() const Returns the Epetra_BlockMap object associated with the range of this matrix operator.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.ICT.Compute | ( | self, | |
| args | |||
| ) |
Compute(ICT self) -> int int Ifpack_ICT::Compute() Compute IC factor U using the specified graph, diagonal perturbation thresholds and relaxation parameters. This function computes the RILU(k) factors L and U using the current: Ifpack_IlukGraph specifying the structure of L and U. Value for the RILU(k) relaxation parameter. Value for the a priori diagonal threshold values. InitValues() must be called before the factorization can proceed.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.ComputeFlops | ( | self, | |
| args | |||
| ) |
ComputeFlops(ICT self) -> double virtual double Ifpack_ICT::ComputeFlops() const Returns the number of flops in all applications of Compute().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.ComputeTime | ( | self, | |
| args | |||
| ) |
ComputeTime(ICT self) -> double virtual double Ifpack_ICT::ComputeTime() const Returns the time spent in Compute().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.Condest | ( | self, | |
| args | |||
| ) |
Condest(ICT self, Ifpack_CondestType const CT=Ifpack_Cheap, int const MaxIters=1550, double const Tol=1e-9,
RowMatrix Matrix_in=None) -> double
double
Ifpack_ICT::Condest() const
Returns the computed condition number estimate, or -1.0 if not
computed.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.DropTolerance | ( | self, | |
| args | |||
| ) |
DropTolerance(ICT self) -> double double Ifpack_ICT::DropTolerance() const Returns the drop threshold.
| def PyTrilinos.IFPACK.ICT.H | ( | self, | |
| args | |||
| ) |
H(ICT self) -> CrsMatrix const Epetra_CrsMatrix& Ifpack_ICT::H() const Returns the address of the D factor associated with this factored matrix.
| def PyTrilinos.IFPACK.ICT.HasNormInf | ( | self, | |
| args | |||
| ) |
HasNormInf(ICT self) -> bool bool Ifpack_ICT::HasNormInf() const Returns false because this class cannot compute an Inf-norm.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.ICT.Initialize | ( | self, | |
| args | |||
| ) |
Initialize(ICT self) -> int int Ifpack_ICT::Initialize() Initialize L and U with values from user matrix A. Copies values from the user's matrix into the nonzero pattern of L and U. Parameters: ----------- In: A - User matrix to be factored. WARNING: The graph of A must be identical to the graph passed in to Ifpack_IlukGraph constructor.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.InitializeFlops | ( | self, | |
| args | |||
| ) |
InitializeFlops(ICT self) -> double virtual double Ifpack_ICT::InitializeFlops() const Returns the number of flops in the initialization phase.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.InitializeTime | ( | self, | |
| args | |||
| ) |
InitializeTime(ICT self) -> double virtual double Ifpack_ICT::InitializeTime() const Returns the time spent in Initialize().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.IsComputed | ( | self, | |
| args | |||
| ) |
IsComputed(ICT self) -> bool bool Ifpack_ICT::IsComputed() const If factor is completed, this query returns true, otherwise it returns false.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.IsInitialized | ( | self, | |
| args | |||
| ) |
IsInitialized(ICT self) -> bool bool Ifpack_ICT::IsInitialized() const Returns true is the preconditioner has been successfully initialized.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.Label | ( | self, | |
| args | |||
| ) |
Label(ICT self) -> char const * const char* Ifpack_ICT::Label() const
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.ICT.LevelOfFill | ( | self, | |
| args | |||
| ) |
LevelOfFill(ICT self) -> double double Ifpack_ICT::LevelOfFill() const Returns the level-of-fill. : if 1.0, then the factored matrix contains approximatively the same number of elements of A.
| def PyTrilinos.IFPACK.ICT.Matrix | ( | self, | |
| args | |||
| ) |
Matrix(ICT self) -> RowMatrix const Epetra_RowMatrix& Ifpack_ICT::Matrix() const Returns a reference to the matrix to be preconditioned.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.NormInf | ( | self, | |
| args | |||
| ) |
NormInf(ICT self) -> double double Ifpack_ICT::NormInf() const Returns 0.0 because this class cannot compute Inf-norm.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.ICT.NumApplyInverse | ( | self, | |
| args | |||
| ) |
NumApplyInverse(ICT self) -> int virtual int Ifpack_ICT::NumApplyInverse() const Returns the number of calls to ApplyInverse().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.NumCompute | ( | self, | |
| args | |||
| ) |
NumCompute(ICT self) -> int virtual int Ifpack_ICT::NumCompute() const Returns the number of calls to Compute().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.NumGlobalNonzeros | ( | self, | |
| args | |||
| ) |
NumGlobalNonzeros(ICT self) -> int int Ifpack_ICT::NumGlobalNonzeros() const Returns the number of nonzero entries in the global graph.
| def PyTrilinos.IFPACK.ICT.NumInitialize | ( | self, | |
| args | |||
| ) |
NumInitialize(ICT self) -> int virtual int Ifpack_ICT::NumInitialize() const Returns the number of calls to Initialize().
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.NumMyNonzeros | ( | self, | |
| args | |||
| ) |
NumMyNonzeros(ICT self) -> int int Ifpack_ICT::NumMyNonzeros() const Returns the number of nonzero entries in the local graph.
| def PyTrilinos.IFPACK.ICT.OperatorDomainMap | ( | self, | |
| args | |||
| ) |
OperatorDomainMap(ICT self) -> Map const Epetra_Map& Ifpack_ICT::OperatorDomainMap() const Returns the Epetra_Map object associated with the domain of this operator.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.ICT.OperatorRangeMap | ( | self, | |
| args | |||
| ) |
OperatorRangeMap(ICT self) -> Map const Epetra_Map& Ifpack_ICT::OperatorRangeMap() const Returns the Epetra_Map object associated with the range of this operator.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.ICT.RelativeThreshold | ( | self, | |
| args | |||
| ) |
RelativeThreshold(ICT self) -> double double Ifpack_ICT::RelativeThreshold() const Returns the relative threshold.
| def PyTrilinos.IFPACK.ICT.RelaxValue | ( | self, | |
| args | |||
| ) |
RelaxValue(ICT self) -> double double Ifpack_ICT::RelaxValue() const Returns the relaxation value.
| def PyTrilinos.IFPACK.ICT.SetLabel | ( | self, | |
| args | |||
| ) |
SetLabel(ICT self, char const * Label_in) -> int int Ifpack_ICT::SetLabel(const char *Label_in)
| def PyTrilinos.IFPACK.ICT.SetParameters | ( | self, | |
| args | |||
| ) |
SetParameters(ICT self, ParameterList parameterlis) -> int int Ifpack_ICT::SetParameters(Teuchos::ParameterList ¶meterlis) Set parameters using a Teuchos::ParameterList object.
Reimplemented from PyTrilinos.IFPACK.Preconditioner.
| def PyTrilinos.IFPACK.ICT.SetUseTranspose | ( | self, | |
| args | |||
| ) |
SetUseTranspose(ICT self, bool UseTranspose_in) -> int int Ifpack_ICT::SetUseTranspose(bool UseTranspose_in) If set true, transpose of this operator will be applied. This flag allows the transpose of the given operator to be used implicitly. Setting this flag affects only the Apply() and ApplyInverse() methods. If the implementation of this interface does not support transpose use, this method should return a value of -1. Parameters: ----------- In: UseTranspose_in -If true, multiply by the transpose of operator, otherwise just use operator. Always returns 0.
Reimplemented from PyTrilinos.Epetra.Operator.
| def PyTrilinos.IFPACK.ICT.UseTranspose | ( | self, | |
| args | |||
| ) |
UseTranspose(ICT self) -> bool bool Ifpack_ICT::UseTranspose() const Returns the current UseTranspose setting.
Reimplemented from PyTrilinos.Epetra.Operator.
1.7.6.1