nl_superlu.h File Reference

Internal OpenNL functions that interfaces SuperLU. More...

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

Go to the source code of this file.

Functions
NLAPI NLMatrix NLAPIENTRY	nlMatrixFactorize_SUPERLU (NLMatrix M, NLenum solver)
	Factorizes a matrix using SuperLU.
NLboolean	nlInitExtension_SUPERLU (void)
	Initializes the SUPERLU extension.
NLboolean	nlExtensionIsInitialized_SUPERLU (void)
	Tests whether the SUPERLU extension is initialized.

Detailed Description

Internal OpenNL functions that interfaces SuperLU.

Definition in file nl_superlu.h.

Function Documentation

nlExtensionIsInitialized_SUPERLU()

NLboolean nlExtensionIsInitialized_SUPERLU

(

void

)

Tests whether the SUPERLU extension is initialized.

Return values

NL_TRUE	if the extension is initialized
NL_FALSE	otherwise

nlInitExtension_SUPERLU()

NLboolean nlInitExtension_SUPERLU

(

void

)

Initializes the SUPERLU extension.

This dynamically loads the SuperLU library available in the system (if available) and retrieves the symbols in there. It supports SuperLU 5.x.

Return values

NL_TRUE	if SUPERLU could be successfully dynamically loaded and all functions could be found in it.
NL_FALSE	otherwise.

nlMatrixFactorize_SUPERLU()

NLAPI NLMatrix NLAPIENTRY nlMatrixFactorize_SUPERLU	(	NLMatrix	M,
		NLenum	solver
	)

Factorizes a matrix using SuperLU.

The SUPERLU extension needs to be initialized, by first calling nlInitExtension("SUPERLU").

Parameters

[in]

M

the input sparse matrix. Should be a either an NLSparseMatrix or an NLCRSMatrix.

Returns

a factorization P of M. Subsequent calls to nlMultMatrixVector(P,x,y) solves M y = x (P may be thought-of as M^-1)

Parameters

[in]

solver

one of: NL_SUPERLU_EXT if no pre-ordering should be used NL_PERM_SUPERLU_EXT pre-ordering for general matrices NL_SYMMETRIC_SUPERLU_EXT pre-ordering for symmetric matrices