SymmetricSuccessiveOverRelaxationPreconditioner<T> Constructor

Definition

Namespace: Numerics.NET.LinearAlgebra.IterativeSolvers.Preconditioners
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.9.0

Overload List

SymmetricSuccessiveOverRelaxationPreconditioner<T>(SparseMatrix<T>)Constructs an SSOR preconditioner with explicit relaxation and ordering.
SymmetricSuccessiveOverRelaxationPreconditioner<T>(SparseMatrix<T>, T, Permutation)Constructs an SSOR preconditioner with explicit relaxation and ordering.

SymmetricSuccessiveOverRelaxationPreconditioner<T>(SparseMatrix<T>)

Constructs an SSOR preconditioner with explicit relaxation and ordering.
C# 
public SymmetricSuccessiveOverRelaxationPreconditioner(
	SparseMatrix<T> matrix
)

Parameters

matrix  SparseMatrix<T>
A square sparse matrix with finite Hermitian logical coefficients and strictly positive real diagonal entries. General, symmetric, Hermitian and diagonal structures are supported.

Remarks

Uses symmetric Gauss-Seidel with natural ordering.

Exceptions

ArgumentNullExceptionmatrix is null.
DimensionMismatchExceptionThe matrix is not square or the ordering has the wrong length.
ArgumentOutOfRangeExceptionThe relaxation factor is outside its valid range.
ArgumentExceptionThe matrix is unsupported or non-Hermitian, the ordering is invalid, or a nonzero normalized coefficient or application scale is unrepresentable.
MatrixNotPositiveDefiniteExceptionA diagonal entry is missing or nonpositive.

SymmetricSuccessiveOverRelaxationPreconditioner<T>(SparseMatrix<T>, T, Permutation)

Constructs an SSOR preconditioner with explicit relaxation and ordering.
C# 
public SymmetricSuccessiveOverRelaxationPreconditioner(
	SparseMatrix<T> matrix,
	T relaxationFactor,
	Permutation? ordering = null
)

Parameters

matrix  SparseMatrix<T>
A square sparse matrix with finite Hermitian logical coefficients and strictly positive real diagonal entries. General, symmetric, Hermitian and diagonal structures are supported.
relaxationFactor  T
A finite real value strictly between zero and two.
ordering  Permutation  (Optional)
An optional copied permutation mapping factor coordinates to original coordinates. The same ordering is applied to rows and columns. Null uses natural ordering.

Exceptions

ArgumentNullExceptionmatrix is null.
DimensionMismatchExceptionThe matrix is not square or the ordering has the wrong length.
ArgumentOutOfRangeExceptionThe relaxation factor is outside its valid range.
ArgumentExceptionThe matrix is unsupported or non-Hermitian, the ordering is invalid, or a nonzero normalized coefficient or application scale is unrepresentable.
MatrixNotPositiveDefiniteExceptionA diagonal entry is missing or nonpositive.

See Also