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

#include <PETSc.hh>

Inheritance diagram for concepts::PETSc:

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
	Returns the number of iterations. More...

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)

	PETSc (Operator< Real > &A, const Real maxeps, const std::string ksptype, const std::string pctype=std::string("none"))
	Constructor. More...

virtual void	show_messages ()

	~PETSc ()

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 Types
typedef int(*	multPointer) (Mat, Vec, Vec)

typedef void(*	PETScmultPointer) ()

Private Attributes
Operator< Real > &	A_
	The operator of the matrix. More...

bool	destroyPETScA_

int	iterations_
	Number of iterations. More...

Mat	PETScA_
	PETSc matrix handle. More...

SLES	solver_
	PETSc solver handle. More...

Vec	x_
	PETSc vector handle. More...

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 74 of file PETSc.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.

◆ multPointer

typedef int(* concepts::PETSc::multPointer) (Mat, Vec, Vec)

private

Definition at line 94 of file PETSc.hh.

◆ PETScmultPointer

typedef void(* concepts::PETSc::PETScmultPointer) ()

private

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

◆ PETSc()

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

◆ ~PETSc()

concepts::PETSc::~PETSc ( )

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::PETSc::info ( std::ostream & os ) const

protectedvirtual

Reimplemented from concepts::Operator< Real >.

◆ iterations()

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 90 of file PETSc.hh.

◆ operator()() [1/4]

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

virtualinherited

Application operator without argument.

Reimplemented in concepts::VecOperator< Real >.

◆ operator()() [2/4]

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/4]

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/4]

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

virtual

◆ show_messages()

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

inlinevirtualinherited

Definition at line 100 of file compositions.hh.

Member Data Documentation

◆ A_

Operator<Real>& concepts::PETSc::A_

private

The operator of the matrix.

Definition at line 98 of file PETSc.hh.

◆ destroyPETScA_

bool concepts::PETSc::destroyPETScA_

private

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

◆ iterations_

int concepts::PETSc::iterations_

private

Number of iterations.

Definition at line 101 of file PETSc.hh.

◆ PETScA_

Mat concepts::PETSc::PETScA_

private

PETSc matrix handle.

Definition at line 104 of file PETSc.hh.

◆ solver_

SLES concepts::PETSc::solver_

private

PETSc solver handle.

Definition at line 108 of file PETSc.hh.

◆ x_

Vec concepts::PETSc::x_

private

PETSc vector handle.

Definition at line 111 of file PETSc.hh.

◆ y_

Vec concepts::PETSc::y_

private

Definition at line 111 of file PETSc.hh.

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

operator/PETSc.hh

concepts::PETSc Class ReferenceLinear Solvers

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ c_type

◆ multPointer

◆ PETScmultPointer

◆ r_type

◆ type

Constructor & Destructor Documentation

◆ PETSc()

◆ ~PETSc()

Member Function Documentation

◆ dimX()

◆ dimY()

◆ info()

◆ iterations()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ show_messages()

Member Data Documentation

◆ A_

◆ destroyPETScA_

◆ dimX_

◆ dimY_

◆ iterations_

◆ PETScA_

◆ solver_

◆ x_

◆ y_

concepts::PETSc Class Reference
Linear Solvers