Interface to the iterative solvers of the PETSc library. More...

#include <PETSc.hh>

Inheritance diagram for concepts::PETSc:

Collaboration diagram for concepts::PETSc:

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
	Returns the number of iterations.
virtual void	operator() (const Function< Real > &fncY, Function< Real > &fncX)
virtual void	operator() (const Function< r_type > &fncY, Function< Real > &fncX)
	Application operator for real function `fncY`.
virtual void	operator() (const Function< c_type > &fncY, Function< c_type > &fncX)
	Application operator for complex function `fncY`.
	PETSc (Operator< Real > &A, const Real maxeps, const std::string ksptype, const std::string pctype=std::string("none"))
	Constructor.
	~PETSc ()
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 Types
typedef int(*	multPointer )(Mat, Vec, Vec)
typedef void(*	PETScmultPointer )()
Private Attributes
Operator< Real > &	A_
	The operator of the matrix.
bool	destroyPETScA_
int	iterations_
	Number of iterations.
Mat	PETScA_
	PETSc matrix handle.
SLES	solver_
	PETSc solver handle.
Vec	x_
	PETSc vector handle.
Vec	y_

Detailed Description

Interface to the iterative solvers of the PETSc library.

PETSc is a suite of data structures and routines for the scalable (parallel) solution of scientific applications modeled by partial differential equations. It employs the MPI standard for all message-passing communication.

Our interface to PETSc uses only its serial capablities and we only use the linear solvers of PETSc (but there is much more).

You can choose from a list of solvers from the PETSc library. Currently, the preconditioners of PETSc are supported, if and only if the type of the operator used to construct this solver is PETScMat.

See also:: types of solvers; types of preconditioners; Satish Balay, Kris Buschelman, William D. Gropp, Dinesh Kaushik, Lois Curfman McInnes, and Barry F. Smith, PETSc home page, 2001.; Satish Balay, William D. Gropp, Lois Curfman McInnes, and Barry F. Smith. Efficient Management of Parallelism in Object Oriented Numerical Software Libraries. In E. Arge, A. M. Bruaset, and H. P. Langtangen, editors, Modern Software Tools in Scientific Computing, pages 163-202. Birkhauser Press, 1997.; Satish Balay, William D. Gropp, Lois Curfman McInnes, and Barry F. Smith. PETSc Users Manual. Technical Report ANL-95/11 - Revision 2.1.0, Argonne National Laboratory, 2001.

Author:: Philipp Frauenfelder, 2001

Examples:: hpFEM2d.cc.

Definition at line 70 of file PETSc.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 int(* concepts::PETSc::multPointer)(Mat, Vec, Vec) [private]

Definition at line 90 of file PETSc.hh.

typedef void(* concepts::PETSc::PETScmultPointer)() [private]

Definition at line 91 of file PETSc.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::PETSc::PETSc	(	Operator< Real > &	A,
		const Real	maxeps,
		const std::string	ksptype,
		const std::string	pctype = `std::string("none")`
	)

Constructor.

Parameters:

A	Operator
maxeps	Maximal residual
ksptype	Type of Krylov Subspace Solver
pctype	Type of preconditioner

concepts::PETSc::~PETSc ( )

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::PETSc::info ( std::ostream & os ) const [protected, virtual]

Returns information in an output stream.

Reimplemented from concepts::Operator< Real >.

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

Returns the number of iterations.

Calling this method makes only sence after xa linear system has been solved.

Examples:: hpFEM2d.cc.

Definition at line 86 of file PETSc.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 >.

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 >.