concepts::Umfpack Class Reference

Sparse direct solver for unsymmetric matrices. More...

#include <umfpack.hh>

Inheritance diagram for concepts::Umfpack:

Public Types
typedef Cmplxtype< Real >::type	c_type
	Real type of data type. More...
typedef Realtype< Real >::type	r_type
	Real type of data type. More...
typedef Real	type
	Type of data, e.g. matrix entries. More...

Public Member Functions
virtual const uint	dimX () const
	Returns the size of the image space of the operator (number of rows of the corresponding matrix) More...
virtual const uint	dimY () const
	Returns the size of the source space of the operator (number of columns of the corresponding matrix) More...
uint	iterations () const
virtual void	operator() ()
	Application operator without argument. More...
virtual void	operator() (const Function< c_type > &fncY, Function< c_type > &fncX)
	Application operator for complex function fncY. More...
virtual void	operator() (const Function< r_type > &fncY, Function< Real > &fncX)
	Application operator for real function fncY. More...
virtual void	operator() (const Function< Real > &fncY, Function< Real > &fncX)
void	operator() (const Vector< Real > &fncY, Vector< Real > &fncX)
virtual void	show_messages ()
	Umfpack (const SparseMatrix< Real > &A, bool symmetric=false)
	Constructor. More...
virtual	~Umfpack ()

Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const

Protected Attributes
uint	dimX_
	Dimension of image space and the source space. More...
uint	dimY_

Private Attributes
concepts::Array< long int >	Ai_
concepts::Array< long int >	Ap_
	UMFPACK data. More...
concepts::Array< Real >	Ax_
	UMFPACK data. More...
bool	factored_
	Stores if the factorization was already computed before. More...
const uint	n_
	System size. More...
void *	numeric_
void *	symbolic_
	UMFPACK data. More...

Detailed Description

Sparse direct solver for unsymmetric matrices.

UMFPACK is a set of routines for solving unsymmetric sparse linear systems, Ax=b, using the Unsymmetric MultiFrontal method.

See also

UMFPACK Homepage

Tim A. Davis. A column pre-ordering strategy for the unsymmetric-pattern multifrontal method. Technical Report TR-03-006, Departement of Computer and Information Science and Engineering, University of Florida, 2003. Submitted to ACM Trans. Math. Software.

Tim A. Davis. UMFPACK Version 4.1 User Guide. Technical Report TR-03-008, Univ. of Florida, CISE Dept., Gainesville, FL, 2003.

Author

Philipp Frauenfelder, 2003

Test:

test::UmfpackTest

Examples

hpFEM2d.cc.

Definition at line 39 of file umfpack.hh.

Member Typedef Documentation

c_type

typedef Cmplxtype<Real >::type concepts::Operator< Real >::c_type

inherited

Real type of data type.

Definition at line 49 of file compositions.hh.

r_type

typedef Realtype<Real >::type concepts::Operator< Real >::r_type

inherited

Real type of data type.

Definition at line 47 of file compositions.hh.

type

typedef Real concepts::Operator< Real >::type

inherited

Type of data, e.g. matrix entries.

Definition at line 45 of file compositions.hh.

Constructor & Destructor Documentation

Umfpack()

concepts::Umfpack::Umfpack	(	const SparseMatrix< Real > &	A,
		bool	symmetric = false
	)

Constructor.

Has to transpose the matrix A while filling the UMFPACK data structure since SparseMatrix has row compressed form and UMFPACK needs column compressed form.

Parameters

A	Matrix
symmetric	Set this to true if the matrix is symmetric. In this case, this constructor does not need to transpose the matrix

~Umfpack()

virtual concepts::Umfpack::~Umfpack ( )

virtual

Member Function Documentation

dimX()

virtual const uint concepts::Operator< Real >::dimX ( ) const

inlinevirtualinherited

Returns the size of the image space of the operator (number of rows of the corresponding matrix)

Definition at line 93 of file compositions.hh.

dimY()

virtual const uint concepts::Operator< Real >::dimY ( ) const

inlinevirtualinherited

Returns the size of the source space of the operator (number of columns of the corresponding matrix)

Definition at line 98 of file compositions.hh.

info()

virtual std::ostream& concepts::Umfpack::info ( std::ostream &  os ) const

protectedvirtual

Reimplemented from concepts::Operator< Real >.

iterations()

uint concepts::Umfpack::iterations ( ) const

inline

Definition at line 52 of file umfpack.hh.

operator()() [1/5]

virtual void concepts::Operator< Real >::operator() ( )

virtualinherited

Application operator without argument.

Reimplemented in concepts::VecOperator< Real >.

operator()() [2/5]

virtual void concepts::Operator< Real >::operator() ( const Function< c_type > &  fncY, Function< c_type > &  fncX  )

virtualinherited

Application operator for complex function fncY.

Computes fncX = A(fncY) where A is this operator. fncX becomes complex.

In derived classes its enough to implement the operator() for complex Operator's. If a real counterpart is not implemented, the function fncY is splitted into real and imaginary part and the application operator for real functions is called for each. Then the result is combined.

If in a derived class the operator() for complex Operator's is not implemented, a exception is thrown from here.

Reimplemented in concepts::VecOperator< Real >.

operator()() [3/5]

virtual void concepts::Operator< Real >::operator() ( const Function< r_type > &  fncY, Function< F > &  fncX  )

virtualinherited

Application operator for real function fncY.

Computes fncX = A(fncY) where A is this operator.

fncX becomes the type of the operator, for real data it becomes real, for complex data it becomes complex.

In derived classes its enough to implement the operator() for real Operator's. If a complex counterpart is not implemented, the function fncY is transformed to a complex function and then the application operator for complex functions is called.

If in a derived class the operator() for real Operator's is not implemented, a exception is thrown from here.

Reimplemented in concepts::VecOperator< Real >.

operator()() [4/5]

virtual void concepts::Umfpack::operator() ( const Function< Real > &  fncY, Function< Real > &  fncX  )

virtual

operator()() [5/5]

void concepts::Umfpack::operator()	(	const Vector< Real > &	fncY,
		Vector< Real > &	fncX
	)

show_messages()

virtual void concepts::Operator< Real >::show_messages ( )

inlinevirtualinherited

Definition at line 100 of file compositions.hh.

Member Data Documentation

Ai_

concepts::Array<long int> concepts::Umfpack::Ai_

private

Definition at line 60 of file umfpack.hh.

Ap_

concepts::Array<long int> concepts::Umfpack::Ap_

private

UMFPACK data.

Definition at line 60 of file umfpack.hh.

Ax_

concepts::Array<Real> concepts::Umfpack::Ax_

private

UMFPACK data.

Definition at line 62 of file umfpack.hh.

dimX_

uint concepts::Operator< Real >::dimX_

protectedinherited

Dimension of image space and the source space.

Definition at line 104 of file compositions.hh.

dimY_

uint concepts::Operator< Real >::dimY_

protectedinherited

Definition at line 104 of file compositions.hh.

factored_

bool concepts::Umfpack::factored_

private

Stores if the factorization was already computed before.

Definition at line 67 of file umfpack.hh.

n_

const uint concepts::Umfpack::n_

private

System size.

Definition at line 57 of file umfpack.hh.

numeric_

void * concepts::Umfpack::numeric_

private

Definition at line 64 of file umfpack.hh.

symbolic_

void* concepts::Umfpack::symbolic_

private

UMFPACK data.

Definition at line 64 of file umfpack.hh.

---

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

• operator/umfpack.hh