Belos::GmresPolyOp< ScalarType, MV, OP > Class Template Reference

Belos's class for applying the GMRES polynomial operator that is used by the hybrid-GMRES linear solver. More...

#include <BelosGmresPolyOp.hpp>

List of all members.

Public Member Functions
Constructor/Destructor
	GmresPolyOp ()
	Default constructor.
	GmresPolyOp (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem_in, const Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > &hess, const Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > &comb, const Teuchos::RCP< Teuchos::SerialDenseVector< int, ScalarType > > &scal)
	Basic contstructor.
virtual	~GmresPolyOp ()
	Destructor.
Operator application method
void	Apply (const MV &x, MV &y, ETrans trans=NOTRANS)
	This routine takes the MV x and applies the polynomial operator phi(OP) to it resulting in the MV y, which is returned.

---

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::GmresPolyOp< ScalarType, MV, OP >

Belos's class for applying the GMRES polynomial operator that is used by the hybrid-GMRES linear solver.

This operator is used as the interface to the matrix polynomial (phi(A)), solution (X), and right-hand side (B) of the linear system phi(A)X = B. Furthermore, it is also the interface to left/right preconditioning of the linear system.

Author:

Heidi Thornquist

Definition at line 71 of file BelosGmresPolyOp.hpp.

---

Constructor & Destructor Documentation

template<class ScalarType, class MV, class OP>

Belos::GmresPolyOp< ScalarType, MV, OP >::GmresPolyOp

(

)

[inline]

Default constructor.

Definition at line 78 of file BelosGmresPolyOp.hpp.

template<class ScalarType, class MV, class OP>

Belos::GmresPolyOp< ScalarType, MV, OP >::GmresPolyOp	(	const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &	problem_in,
		const Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > &	hess,
		const Teuchos::RCP< Teuchos::SerialDenseMatrix< int, ScalarType > > &	comb,
		const Teuchos::RCP< Teuchos::SerialDenseVector< int, ScalarType > > &	scal
	)		[inline]

Basic contstructor.

Definition at line 81 of file BelosGmresPolyOp.hpp.

template<class ScalarType, class MV, class OP>

virtual Belos::GmresPolyOp< ScalarType, MV, OP >::~GmresPolyOp

(

)

[inline, virtual]

Destructor.

Definition at line 92 of file BelosGmresPolyOp.hpp.

---

Member Function Documentation

template<class ScalarType , class MV , class OP >

void Belos::GmresPolyOp< ScalarType, MV, OP >::Apply	(	const MV &	x,
		MV &	y,
		ETrans	trans = NOTRANS
	)

This routine takes the MV x and applies the polynomial operator phi(OP) to it resulting in the MV y, which is returned.

Note:

It is expected that any problem with applying this operator to x will be indicated by an std::exception being thrown.

Definition at line 119 of file BelosGmresPolyOp.hpp.

---

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

• BelosGmresPolyOp.hpp