geosx::SuperLU_Dist Class Reference

#include <SuperLU_Dist.hpp>

Public Member Functions
	SuperLU_Dist ()
	Constructor.
	SuperLU_Dist (LinearSolverParameters const &params)
	Constructor with parameters. More...
	~SuperLU_Dist ()
	Destructor.
void	create (LinearSolverParameters const &params)
	Creates the SuperLU_Dist data structure. More...
int	setup ()
	Factorizes a linear system with SuperLU_Dist. More...
int	solve (real64 const *b, real64 *x)
	Solves a linear system with SuperLU_Dist (matrix has already been factorized) More...
real64	condEst ()
	Estimates the condition number of the matrix. More...
real64	relativeTolerance ()
	Estimates the relative tolerance for the matrix. More...
void	destroy ()
	Deallocates a SuperLU_Dist data structure.
void	setNumGlobalRows (int_t const numGlobalRows)
	Sets the global number of rows. More...
int_t	numGlobalRows () const
	Returns the global number of rows. More...
void	setNumGlobalCols (int_t const numGlobalCols)
	Sets the global number of columns. More...
int_t	numGlobalCols () const
	Returns the global number of columns. More...
void	setNumLocalRows (int_t const numLocalRows)
	Sets the local number of rows. More...
int_t	numLocalRows () const
	Returns the local number of rows. More...
void	setComm (MPI_Comm const comm)
	Sets the communicator. More...
MPI_Comm	getComm () const
	Returns the communicator. More...
void	resize (localIndex const numLocalRows, localIndex const numLocalNonzeros)
	Allocate the internal memory. More...
void	createSuperMatrix (globalIndex const ilower)
	Create the matrix in SuperLU_Dist format (SuperMatrix) More...
int_t *	rowPtr ()
	Returns the array with the row pointers. More...
int_t *	colIndices ()
	Returns the array with the column indices. More...
real64 *	values ()
	Returns the array with the values. More...
real64	setupTime () const
	Provides the setup time. More...
real64	solveTime () const
	Provides the solve time. More...
LinearSolverParameters	getParameters () const
	Returns the parameters used to initialize this object. More...
real64	precisionTolerance () const
	Returns the precision tolerance used in SuperLU_Dist class. More...

Detailed Description

SuperLU_Dist data

Definition at line 53 of file SuperLU_Dist.hpp.

Constructor & Destructor Documentation

SuperLU_Dist()

geosx::SuperLU_Dist::SuperLU_Dist

(

LinearSolverParameters const &

params

)

Constructor with parameters.

Parameters

[in]

params

the linear solver parameters

Member Function Documentation

colIndices()

int_t* geosx::SuperLU_Dist::colIndices

(

)

Returns the array with the column indices.

Returns

the array with the column indices

condEst()

real64 geosx::SuperLU_Dist::condEst

(

)

Estimates the condition number of the matrix.

Returns

the estimated condition number

create()

void geosx::SuperLU_Dist::create

(

LinearSolverParameters const &

params

)

Creates the SuperLU_Dist data structure.

Parameters

[in]

params

the linear solver parameters

createSuperMatrix()

void geosx::SuperLU_Dist::createSuperMatrix

(

globalIndex const

ilower

)

Create the matrix in SuperLU_Dist format (SuperMatrix)

Parameters

ilower

the first row on each process

getComm()

MPI_Comm geosx::SuperLU_Dist::getComm

(

)

const

Returns the communicator.

Returns

the communicator

getParameters()

LinearSolverParameters geosx::SuperLU_Dist::getParameters

(

)

const

Returns the parameters used to initialize this object.

Returns

the parameters used to initialize this object

numGlobalCols()

int_t geosx::SuperLU_Dist::numGlobalCols

(

)

const

Returns the global number of columns.

Returns

the global number of columns

numGlobalRows()

int_t geosx::SuperLU_Dist::numGlobalRows

(

)

const

Returns the global number of rows.

Returns

the global number of rows

numLocalRows()

int_t geosx::SuperLU_Dist::numLocalRows

(

)

const

Returns the local number of rows.

Returns

the local number of rows

precisionTolerance()

real64 geosx::SuperLU_Dist::precisionTolerance

(

)

const

Returns the precision tolerance used in SuperLU_Dist class.

Returns

the precision tolerance used in SuperLU_Dist class

relativeTolerance()

real64 geosx::SuperLU_Dist::relativeTolerance

(

)

Estimates the relative tolerance for the matrix.

Returns

the relative tolerance (condEst * eps)

resize()

void geosx::SuperLU_Dist::resize	(	localIndex const	numLocalRows,
		localIndex const	numLocalNonzeros
	)

Allocate the internal memory.

Parameters

numLocalRows	the number of local rows
numLocalNonzeros	the number of local entries

rowPtr()

int_t* geosx::SuperLU_Dist::rowPtr

(

)

Returns the array with the row pointers.

Returns

the array with the row pointers

setComm()

void geosx::SuperLU_Dist::setComm

(

MPI_Comm const

comm

)

Sets the communicator.

Parameters

[in]

comm

the MPI communicator

setNumGlobalCols()

void geosx::SuperLU_Dist::setNumGlobalCols

(

int_t const

numGlobalCols

)

Sets the global number of columns.

Parameters

numGlobalCols

the global number of columns

setNumGlobalRows()

void geosx::SuperLU_Dist::setNumGlobalRows

(

int_t const

numGlobalRows

)

Sets the global number of rows.

Parameters

numGlobalRows

the global number of rows

setNumLocalRows()

void geosx::SuperLU_Dist::setNumLocalRows

(

int_t const

numLocalRows

)

Sets the local number of rows.

Parameters

numLocalRows

the local number of rows

setup()

int geosx::SuperLU_Dist::setup

(

)

Factorizes a linear system with SuperLU_Dist.

Returns

info error code

setupTime()

real64 geosx::SuperLU_Dist::setupTime

(

)

const

Provides the setup time.

Returns

the setup time

solve()

int geosx::SuperLU_Dist::solve	(	real64 const *	b,
		real64 *	x
	)

Solves a linear system with SuperLU_Dist (matrix has already been factorized)

Parameters

[in]	b	the right-hand side
[out]	x	the solution vector

Returns

info error code

solveTime()

real64 geosx::SuperLU_Dist::solveTime

(

)

const

Provides the solve time.

Returns

the solve time

values()

real64* geosx::SuperLU_Dist::values

(

)

Returns the array with the values.

Returns

the array with the values

---

The documentation for this class was generated from the following file:

• coreComponents/linearAlgebra/interfaces/direct/SuperLU_Dist.hpp