Sparse direct solver for unsymmetric matrices. More...

#include <umfpack.hh>

Inheritance diagram for concepts::Umfpack:

Collaboration diagram for concepts::Umfpack:

Public Types
typedef Cmplxtype< Real >::type	c_type
	Real type of data type.
typedef Realtype< Real >::type	r_type
	Real type of data type.
typedef Real	type
	Type of data, e.g. matrix entries.
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)
virtual const uint	dimY () const
	Returns the size of the source space of the operator (number of columns of the corresponding matrix)
uint	iterations () const
virtual void	operator() (const Function< c_type > &fncY, Function< c_type > &fncX)
	Application operator for complex function `fncY`.
virtual void	operator() (const Function< Real > &fncY, Function< Real > &fncX)
void	operator() (const Vector< Real > &fncY, Vector< Real > &fncX)
virtual void	operator() (const Function< r_type > &fncY, Function< Real > &fncX)
	Application operator for real function `fncY`.
	Umfpack (const SparseMatrix< Real > &A, bool symmetric=false)
	Constructor.
virtual	~Umfpack ()
Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.
Protected Attributes
uint	dimX_
	Dimension of image space and the source space.
uint	dimY_
Private Attributes
concepts::Array< long int >	Ai_
concepts::Array< long int >	Ap_
	UMFPACK data.
concepts::Array< Real >	Ax_
	UMFPACK data.
bool	factored_
	Stores if the factorization was already computed before.
const uint	n_
	System size.
void *	numeric_
void *	symbolic_
	UMFPACK data.

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 36 of file umfpack.hh.

Member Typedef Documentation

typedef Cmplxtype<Real >::type concepts::Operator< Real >::c_type [inherited]

Real type of data type.

Reimplemented in concepts::VecOperator< Real >, concepts::DenseMatrix< Real >, concepts::DiagonalMatrix< Real >, concepts::Matrix< Real >, concepts::Permutation< Real >, and concepts::SparseMatrix< Real >.

Definition at line 47 of file compositions.hh.

typedef Realtype<Real >::type concepts::Operator< Real >::r_type [inherited]

Real type of data type.

Reimplemented in concepts::VecOperator< Real >, concepts::DenseMatrix< Real >, concepts::DiagonalMatrix< Real >, concepts::Matrix< Real >, concepts::Permutation< Real >, and concepts::SparseMatrix< Real >.

Definition at line 45 of file compositions.hh.

typedef Real concepts::Operator< Real >::type [inherited]

Type of data, e.g. matrix entries.

Definition at line 43 of file compositions.hh.

Constructor & Destructor Documentation

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

virtual concepts::Umfpack::~Umfpack ( ) [virtual]

Member Function Documentation

virtual const uint concepts::Operator< Real >::dimX ( ) const [inline, virtual, inherited]

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

Examples:: hpFEM2d-simple.cc, and hpFEM2d.cc.

Definition at line 87 of file compositions.hh.

virtual const uint concepts::Operator< Real >::dimY ( ) const [inline, virtual, inherited]

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

Definition at line 92 of file compositions.hh.

virtual std::ostream& concepts::Umfpack::info ( std::ostream & os ) const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::Operator< Real >.

uint concepts::Umfpack::iterations ( ) const [inline]

Definition at line 49 of file umfpack.hh.

virtual void concepts::Operator< Real >::operator()	(	const Function< r_type > &	fncY,
		Function< Real > &	fncX
	)		`[virtual, inherited]`

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 >, concepts::DenseMatrix< Real >, concepts::DiagonalMatrix< Real >, concepts::Matrix< Real >, concepts::Permutation< Real >, and concepts::SparseMatrix< Real >.

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

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

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

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 >, concepts::DenseMatrix< Real >, concepts::DiagonalMatrix< Real >, concepts::Matrix< Real >, concepts::Permutation< Real >, and concepts::SparseMatrix< Real >.