naginterfaces.library.sparse.complex_​herm_​precon_​ssor_​solve

naginterfaces.library.sparse.complex_herm_precon_ssor_solve(a, irow, icol, rdiag, omega, y, check='N')

complex_herm_precon_ssor_solve solves a system of linear equations involving the preconditioning matrix corresponding to SSOR applied to a complex sparse Hermitian matrix, represented in symmetric coordinate storage format.

For full information please refer to the NAG Library document for f11jr

https://support.nag.com/numeric/nl/nagdoc_30.2/flhtml/f11/f11jrf.html

Parameters

acomplex, array-like, shape $\left(\text{nnz}\right)$

The nonzero elements in the lower triangular part of the matrix $A$, ordered by increasing row index, and by increasing column index within each row. Multiple entries for the same row and column indices are not permitted. The function complex_herm_sort() may be used to order the elements in this way.

irowint, array-like, shape $\left(\text{nnz}\right)$

The row indices of the nonzero elements supplied in array $a$.

icolint, array-like, shape $\left(\text{nnz}\right)$

The column indices of the nonzero elements supplied in array $a$.

rdiagfloat, array-like, shape $\left(n\right)$

The elements of the diagonal matrix $D^{-1}$, where $D$ is the diagonal part of $A$. Note that since $A$ is Hermitian the elements of $D^{-1}$ are necessarily real.

omegafloat

The relaxation parameter $\omega$.

ycomplex, array-like, shape $\left(n\right)$

The right-hand side vector $y$.

checkstr, length 1, optional

Specifies whether or not the input data should be checked.

$check=\text{'C'}$

Checks are carried out on the values of $\text{n}$, $\text{nnz}$, $irow$, $icol$ and $omega$.

$check=\text{'N'}$

None of these checks are carried out.

Returns

xcomplex, ndarray, shape $\left(n\right)$

The solution vector $x$.

Raises

NagValueError

(errno $1$)

On entry, $check=⟨value⟩$.

Constraint: $check=\text{'C'}$ or $\text{'N'}$.

(errno $2$)

On entry, $omega=⟨value⟩$.

Constraint: $0.0<omega<2.0$.

(errno $2$)

On entry, $\text{nnz}=⟨value⟩$ and $n=⟨value⟩$.

Constraint: $\text{nnz}\le n\times (n+1)/2$.

(errno $2$)

On entry, $\text{nnz}=⟨value⟩$.

Constraint: $\text{nnz}\ge 1$.

(errno $2$)

On entry, $n=⟨value⟩$.

Constraint: $n\ge 1$.

(errno $3$)

On entry, the location ($irow[\text{I}-1],icol[\text{I}-1]$) is a duplicate: $\text{I}=⟨value⟩$.

(errno $3$)

On entry, $a[i-1]$ is out of order: $i=⟨value⟩$.

(errno $3$)

On entry, $\text{I}=⟨value⟩$, $icol[\text{I}-1]=⟨value⟩$, $irow[\text{I}-1]=⟨value⟩$.

Constraint: $1\le icol[i-1]\le irow[i-1]$.

(errno $3$)

On entry, $\text{I}=⟨value⟩$, $irow[\text{I}-1]=⟨value⟩$ and $n=⟨value⟩$.

Constraint: $1\le irow[\text{i}-1]\le n$.

(errno $4$)

The matrix $A$ has no diagonal entry in row $⟨value⟩$.

Notes

complex_herm_precon_ssor_solve solves a system of equations

$$Mx=y$$

involving the preconditioning matrix

$$M=\frac{1}{\omega (2-\omega )}(D+\omega L)D^{-1}{(D+\omega L)}^H$$

corresponding to symmetric successive-over-relaxation (SSOR) (see Young (1971)) on a linear system $Ax=b$, where $A$ is a sparse complex Hermitian matrix stored in symmetric coordinate storage (SCS) format (see the F11 Introduction).

In the definition of $M$ given above $D$ is the diagonal part of $A$, $L$ is the strictly lower triangular part of $A$ and $\omega$ is a user-defined relaxation parameter. Note that since $A$ is Hermitian the matrix $D$ is necessarily real.

References

Young, D, 1971, Iterative Solution of Large Linear Systems, Academic Press, New York