Threshold Incomplete LUPreconditioner<T> Class
Definition
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.9.0
public sealed class ThresholdIncompleteLUPreconditioner<T> : Preconditioner<T>
- Inheritance
- Object → LinearOperator<T> → Preconditioner<T> → ThresholdIncompleteLUPreconditioner<T>
Type Parameters
- T
- The real or complex floating-point scalar type.
Remarks
Lower multipliers of magnitude at most DropTolerance are dropped during elimination. Strict-upper coefficients of magnitude at most that tolerance times the mean magnitude of nonzero entries in the original shifted/scaled row are dropped afterward. Each strict triangular row part retains at most MaximumFillPerRow largest entries; ties prefer the smaller column. The diagonal is always retained. Fill-cap dropping of lower multipliers occurs after their row updates.
No numerical pivoting or automatic ordering is performed. This preconditioner is intended for nonsymmetric solvers such as GeneralizedMinimalResidualSolver<T> and does not ensure the positive definiteness required by CG. Call Refresh() after changing coefficients. Distinct-destination applications may run concurrently; refresh requires exclusive access.
Constructors
| Threshold | Constructs an ILUT preconditioner with explicit dropping, fill and pivot options. |
| Threshold | Constructs an ILUT preconditioner with explicit dropping, fill and pivot options. |
Properties
| Column |
Gets the number of columns in the matrix.
(Inherited from LinearOperator<T>) |
| Column |
Gets or sets the index of labels for the columns of the matrix.
(Inherited from LinearOperator<T>) |
| Drop | Gets the requested magnitude-dropping tolerance. |
| Element |
Gets the element type of the matrix.
(Inherited from LinearOperator<T>) |
| Factorization | Gets the number of successful numeric factorizations, including construction. |
| Factor | Gets the number of retained factor entries, excluding the implicit unit diagonal of L. |
| Linear |
Gets the linear operator to which the Preconditioner<T> applies.
(Inherited from Preconditioner<T>) |
| Maximum | Gets the requested cap on each strict triangular row part. |
| Minimum | Gets the smallest relative pivot in the most recent successful factorization, or zero for an empty matrix. |
| Row |
Gets the number of rows in the matrix.
(Inherited from LinearOperator<T>) |
| Row |
Gets or sets the index of labels for the rows of the matrix.
(Inherited from LinearOperator<T>) |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Estimate |
Calculates an estimate for the condition number of a matrix.
(Inherited from LinearOperator<T>) |
| Get |
Calculates the determinant of a matrix.
(Inherited from LinearOperator<T>) |
| Get | Serves as the default hash function. (Inherited from Object) |
| Get |
Calculates the inverse matrix..
(Inherited from LinearOperator<T>) |
| Get |
Calculates the inverse of the factorized
matrix.
(Inherited from LinearOperator<T>) |
| Get | Gets the Type of the current instance. (Inherited from Object) |
| IsSingular |
Gets whether the matrix
is singular.
(Inherited from LinearOperator<T>) |
| Least |
Solves the system of linear equations for the specified
right-hand side matrix in the least squares sense.
(Inherited from LinearOperator<T>) |
| Least |
Solves the system of linear equations for the specified
right-hand side vector.
(Inherited from LinearOperator<T>) |
| Least |
Solves the system of linear equations for the specified
right-hand side dense matrix in the least squares sense and optionally overwrites the
right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Least |
Solves the system of linear equations for the specified
right-hand side dense vector in the least squares sense and optionally
overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Least |
Solves a system of equations defined by the matrix and multiple right-hand sides in the least squares sense.
(Inherited from LinearOperator<T>) |
| Least |
Solves a system of equations defined by the matrix and the specified right-hand side in the least squares sense.
(Inherited from Preconditioner<T>) |
| Multiply( | Applies the linear operator to a matrix. (Inherited from LinearOperator<T>) |
| Multiply( | Applies the linear operator to a vector. (Inherited from LinearOperator<T>) |
| Multiply | Applies the transpose of the linear operator to a matrix. (Inherited from LinearOperator<T>) |
| Multiply | Applies the (conjugate) transpose of the linear operator to a vector. (Inherited from LinearOperator<T>) |
| Rank() |
Returns the numerical rank of a matrix.
(Inherited from LinearOperator<T>) |
| Rank( |
Returns the numerical rank of a matrix using the specified tolerance.
(Inherited from Preconditioner<T>) |
| Refresh | Recomputes coefficients and retained ILUT fill using the existing input pattern and options. |
| Solve( |
Solves the system of linear equations for the specified
right-hand side matrix.
(Inherited from LinearOperator<T>) |
| Solve( |
Solves the system of linear equations for the specified
right-hand side vector.
(Inherited from LinearOperator<T>) |
| Solve( |
Solves the system of linear equations for the specified
right-hand side dense matrix and optionally overwrites the
right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Solve( |
Solves the system of linear equations for the specified
right-hand side dense vector and optionally
overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Solve |
Solves a system of equations defined by the matrix and multiple right-hand sides.
(Inherited from LinearOperator<T>) |
| Solve |
Solves a system of equations defined by the matrix and the specified right-hand side.
(Inherited from LinearOperator<T>) |
| Solve |
Solves a system of equations defined by the matrix and the specified right-hand side.
(Overrides Preconditioner<T>.SolveInto(TransposeOperation, Vector<T>, Vector<T>)) |
| Solve |
Solves a system of equations defined by the matrix and multiple right-hand sides.
(Inherited from LinearOperator<T>) |
| Solve |
Solves the transposed system of linear equations for the specified
right-hand side matrix.
(Inherited from LinearOperator<T>) |
| Solve |
Solves the system of linear equations for the specified
right-hand side vector.
(Inherited from LinearOperator<T>) |
| Solve |
Solves the transposed system of linear equations for the specified
right-hand side dense matrix and optionally overwrites the
right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Solve |
Solves the transposed system of linear equations for the specified
right-hand side dense vector and optionally
overwrites the right-hand side with the solution.
(Inherited from LinearOperator<T>) |
| Solve |
Solves a system of equations defined by the matrix and multiple right-hand sides.
(Inherited from LinearOperator<T>) |
| Solve |
Solves a system of equations defined by the matrix and the specified right-hand side.
(Inherited from LinearOperator<T>) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |