nl_preconditioners.h File Reference

Internal OpenNL functions that implement preconditioners. More...

#include "nl_private.h"
#include "nl_matrix.h"

Go to the source code of this file.

Functions
NLAPI NLMatrix NLAPIENTRY	nlNewJacobiPreconditioner (NLMatrix M)
	Creates a new Jacobi preconditioner.
NLAPI NLMatrix NLAPIENTRY	nlNewSSORPreconditioner (NLMatrix M, double omega)
	Creates a new SSOR preconditioner.

Detailed Description

Internal OpenNL functions that implement preconditioners.

Definition in file nl_preconditioners.h.

Function Documentation

nlNewJacobiPreconditioner()

NLAPI NLMatrix NLAPIENTRY nlNewJacobiPreconditioner

(

NLMatrix

M

)

Creates a new Jacobi preconditioner.

Parameters

[in]

M

the matrix, needs to be of type NL_MATRIX_SPARSE_DYNAMIC

The inverse of the diagonal is stored in the preconditioner. No reference to the input data is kept.

Returns

the Jacobi preconditioner

nlNewSSORPreconditioner()

NLAPI NLMatrix NLAPIENTRY nlNewSSORPreconditioner	(	NLMatrix	M,
		double	omega
	)

Creates a new SSOR preconditioner.

Parameters

[in]	M	the matrix, needs to be of type NL_MATRIX_SPARSE_DYNAMIC and needs to have both rows and columns storage, and symmetric storage.
[in]	omega	the relaxation parameter, within range [1.0,2.0].

A reference to the input matrix is kept and used in the computations.

Returns

the SSOR preconditioner.