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

This class implements the preconditioned transpose-free QMR algorithm for solving non-Hermitian linear systems of equations Ax = b, where b is the right-hand side std::vector and x is the corresponding solution. More...

#include <BelosTFQMR.hpp>

List of all members.

Public Types
typedef MultiVecTraits< ScalarType, MV >	MVT
typedef OperatorTraits< ScalarType, MV, OP >	OPT
typedef Teuchos::ScalarTraits< ScalarType >	SCT
typedef SCT::magnitudeType	MagnitudeType
Public Member Functions
Constructor/Destructor.
	TFQMR (const RCP< LinearProblem< ScalarType, MV, OP > > &lp, const RCP< StatusTest< ScalarType, MV, OP > > &stest, const RCP< OutputManager< ScalarType > > &om, const RCP< ParameterList > &pl=Teuchos::null)
	BelosTFQMR constructor.
virtual	~TFQMR ()
	BelosTFQMR destructor.
Accessor methods
int	GetNumIters () const
	Get the iteration count for the current linear system.
int	GetNumRestarts () const
	Get the restart count of the iteration method for the current linear system [not valid for TFQMR].
RCP< const MV >	GetNativeResiduals (std::vector< MagnitudeType > *normvec) const
	Get the solvers native residual for the current linear system.
RCP< MV >	GetCurrentSoln ()
	Get the actual residual std::vector for the current linear system.
RCP< LinearProblem< ScalarType, MV, OP > >	GetLinearProblem () const
	Get a constant reference to the current linear problem.
RCP< StatusTest< ScalarType, MV, OP > >	GetStatusTest () const
Solver application method.
void	Solve ()
	This method uses the iterative method to compute approximate solutions to the original problem. This method can return unconverged if the maximum number of iterations is reached, or numerical breakdown is observed.
Overridden from Teuchos::Describable
std::string	description () const
	Method to return description of the block GMRES solver.

---

Detailed Description

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

This class implements the preconditioned transpose-free QMR algorithm for solving non-Hermitian linear systems of equations Ax = b, where b is the right-hand side std::vector and x is the corresponding solution.

Author:

Heidi Thornquist

Definition at line 72 of file BelosTFQMR.hpp.

---

Member Typedef Documentation

template<class ScalarType, class MV, class OP>

typedef MultiVecTraits<ScalarType,MV> Belos::TFQMR< ScalarType, MV, OP >::MVT

Definition at line 77 of file BelosTFQMR.hpp.

template<class ScalarType, class MV, class OP>

typedef OperatorTraits<ScalarType,MV,OP> Belos::TFQMR< ScalarType, MV, OP >::OPT

Definition at line 78 of file BelosTFQMR.hpp.

template<class ScalarType, class MV, class OP>

typedef Teuchos::ScalarTraits<ScalarType> Belos::TFQMR< ScalarType, MV, OP >::SCT

Definition at line 79 of file BelosTFQMR.hpp.

template<class ScalarType, class MV, class OP>

typedef SCT::magnitudeType Belos::TFQMR< ScalarType, MV, OP >::MagnitudeType

Definition at line 80 of file BelosTFQMR.hpp.

---

Constructor & Destructor Documentation

template<class ScalarType, class MV, class OP>

Belos::TFQMR< ScalarType, MV, OP >::TFQMR	(	const RCP< LinearProblem< ScalarType, MV, OP > > &	lp,
		const RCP< StatusTest< ScalarType, MV, OP > > &	stest,
		const RCP< OutputManager< ScalarType > > &	om,
		const RCP< ParameterList > &	pl = Teuchos::null
	)

BelosTFQMR constructor.

Definition at line 189 of file BelosTFQMR.hpp.

template<class ScalarType, class MV, class OP>

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

(

)

[inline, virtual]

BelosTFQMR destructor.

Definition at line 93 of file BelosTFQMR.hpp.

---

Member Function Documentation

template<class ScalarType, class MV, class OP>

int Belos::TFQMR< ScalarType, MV, OP >::GetNumIters

(

)

const [inline]

Get the iteration count for the current linear system.

Definition at line 100 of file BelosTFQMR.hpp.

template<class ScalarType, class MV, class OP>

int Belos::TFQMR< ScalarType, MV, OP >::GetNumRestarts

(

)

const [inline]

Get the restart count of the iteration method for the current linear system [not valid for TFQMR].

Definition at line 103 of file BelosTFQMR.hpp.

template<class ScalarType, class MV, class OP>

RCP< const MV > Belos::TFQMR< ScalarType, MV, OP >::GetNativeResiduals

(

std::vector< MagnitudeType > *

normvec

)

const

Get the solvers native residual for the current linear system.

Note:

The memory for the residual MultiVec must be handled by the calling routine.

Definition at line 209 of file BelosTFQMR.hpp.

template<class ScalarType, class MV, class OP>

RCP<MV> Belos::TFQMR< ScalarType, MV, OP >::GetCurrentSoln

(

)

[inline]

Get the actual residual std::vector for the current linear system.

This may force the solver to compute a current residual for its linear system. For TFQMR, this method is not useful since the linear problem manager always has the current solution.

Definition at line 116 of file BelosTFQMR.hpp.

template<class ScalarType, class MV, class OP>

RCP<LinearProblem<ScalarType,MV,OP> > Belos::TFQMR< ScalarType, MV, OP >::GetLinearProblem

(

)

const [inline]

Get a constant reference to the current linear problem.

This may include a current solution, if the solver has recently restarted or completed.

Definition at line 121 of file BelosTFQMR.hpp.

template<class ScalarType, class MV, class OP>

RCP<StatusTest<ScalarType,MV,OP> > Belos::TFQMR< ScalarType, MV, OP >::GetStatusTest

(

)

const [inline]

Definition at line 123 of file BelosTFQMR.hpp.

template<class ScalarType, class MV, class OP>

void Belos::TFQMR< ScalarType, MV, OP >::Solve

(

)

This method uses the iterative method to compute approximate solutions to the original problem. This method can return unconverged if the maximum number of iterations is reached, or numerical breakdown is observed.

Definition at line 220 of file BelosTFQMR.hpp.

template<class ScalarType, class MV, class OP>

std::string Belos::TFQMR< ScalarType, MV, OP >::description

(

)

const

Method to return description of the block GMRES solver.

Definition at line 423 of file BelosTFQMR.hpp.

---

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

• BelosTFQMR.hpp

---