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 vector and x is the corresponding solution. More...

#include <BelosTFQMRIter.hpp>

Inheritance diagram for Belos::TFQMRIter< ScalarType, MV, OP, DM >:

[legend]

Public Types
typedef MultiVecTraits< ScalarType, MV, DM >	MVT

typedef OperatorTraits< ScalarType, MV, OP >	OPT

typedef Teuchos::ScalarTraits< ScalarType >	SCT

typedef SCT::magnitudeType	MagnitudeType

Public Member Functions
Constructor/Destructor.
	TFQMRIter (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP, DM > > &problem, const Teuchos::RCP< OutputManager< ScalarType > > &printer, const Teuchos::RCP< StatusTest< ScalarType, MV, OP, DM > > &tester, Teuchos::ParameterList &params)
	Belos::TFQMRIter constructor.

virtual	~TFQMRIter ()
	Belos::TFQMRIter destructor.

Solver methods
void	iterate ()
	This method performs TFQMR iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).

void	initializeTFQMR (const TFQMRIterState< ScalarType, MV > &newstate)
	Initialize the solver to an iterate, providing a complete state.

void	initialize ()
	Initialize the solver with the initial vectors from the linear problem or random data.

TFQMRIterState< ScalarType, MV >	getState () const
	Get the current state of the linear solver.

Status methods
int	getNumIters () const
	Get the current iteration count.

void	resetNumIters (int iter=0)
	Reset the iteration count.

Teuchos::RCP< const MV >	getNativeResiduals (std::vector< MagnitudeType > *norms) const
	Get the norms of the residuals native to the solver.

Teuchos::RCP< MV >	getCurrentUpdate () const
	Get the current update to the linear system.

Public Member Functions inherited from Belos::Iteration< ScalarType, MV, OP, DM >
	Iteration ()
	Default Constructor.

virtual	~Iteration ()
	Destructor.

virtual Teuchos::RCP< const MV >	getNativeResiduals (std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > *norms) const=0
	Get the residuals native to the solver.

Accessor methods
const LinearProblem< ScalarType, MV, OP, DM > &	getProblem () const
	Get a constant reference to the linear problem.

int	getBlockSize () const
	Get the blocksize to be used by the iterative solver in solving this linear problem.

void	setBlockSize (int blockSize)
	Set the blocksize.

bool	isInitialized ()
	States whether the solver has been initialized or not.

Detailed Description

template<class ScalarType, class MV, class OP, class DM>
class Belos::TFQMRIter< ScalarType, MV, OP, DM >

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 vector and x is the corresponding solution.

  \ingroup belos_solver_framework

Author: Heidi Thornquist

Definition at line 92 of file BelosTFQMRIter.hpp.

Member Typedef Documentation

◆ MVT

template<class ScalarType , class MV , class OP , class DM >

typedef MultiVecTraits<ScalarType,MV,DM> Belos::TFQMRIter< ScalarType, MV, OP, DM >::MVT

Definition at line 97 of file BelosTFQMRIter.hpp.

◆ OPT

template<class ScalarType , class MV , class OP , class DM >

typedef OperatorTraits<ScalarType,MV,OP> Belos::TFQMRIter< ScalarType, MV, OP, DM >::OPT

Definition at line 98 of file BelosTFQMRIter.hpp.

◆ SCT

template<class ScalarType , class MV , class OP , class DM >

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

Definition at line 99 of file BelosTFQMRIter.hpp.

◆ MagnitudeType

template<class ScalarType , class MV , class OP , class DM >

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

Definition at line 100 of file BelosTFQMRIter.hpp.

Constructor & Destructor Documentation

◆ TFQMRIter()

template<class ScalarType , class MV , class OP , class DM >

Belos::TFQMRIter< ScalarType, MV, OP, DM >::TFQMRIter	(	const Teuchos::RCP< LinearProblem< ScalarType, MV, OP, DM > > &	problem,
		const Teuchos::RCP< OutputManager< ScalarType > > &	printer,
		const Teuchos::RCP< StatusTest< ScalarType, MV, OP, DM > > &	tester,
		Teuchos::ParameterList &	params
	)

Belos::TFQMRIter constructor.

Definition at line 287 of file BelosTFQMRIter.hpp.

◆ ~TFQMRIter()

template<class ScalarType , class MV , class OP , class DM >

virtual Belos::TFQMRIter< ScalarType, MV, OP, DM >::~TFQMRIter ( )

inlinevirtual

Belos::TFQMRIter destructor.

Definition at line 112 of file BelosTFQMRIter.hpp.

Member Function Documentation

◆ iterate()

template<class ScalarType , class MV , class OP , class DM >

void Belos::TFQMRIter< ScalarType, MV, OP, DM >::iterate ( )

virtual

This method performs TFQMR iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).

iterate() will first determine whether the solver is initialized; if not, it will call initialize() using default arguments. After initialization, the solver performs TFQMR iterations until the status test evaluates as Passed, at which point the method returns to the caller.

Implements Belos::Iteration< ScalarType, MV, OP, DM >.

Definition at line 422 of file BelosTFQMRIter.hpp.

◆ initializeTFQMR()

template<class ScalarType , class MV , class OP , class DM >

void Belos::TFQMRIter< ScalarType, MV, OP, DM >::initializeTFQMR ( const TFQMRIterState< ScalarType, MV > & newstate )

Initialize the solver to an iterate, providing a complete state.

The TFQMRIter contains a certain amount of state, consisting of the current Krylov basis and the associated Hessenberg matrix.

initialize() gives the user the opportunity to manually set these, although this must be done with caution, abiding by the rules given below. All notions of orthogonality and orthonormality are derived from the inner product specified by the orthogonalization manager.

Postcondition: isInitialized() == true (see post-conditions of isInitialize())

The user has the option of specifying any component of the state using initialize(). However, these arguments are assumed to match the post-conditions specified under isInitialized(). Any necessary component of the state not given to initialize() will be generated.

Note: For any pointer in newstate which directly points to the multivectors in the solver, the data is not copied.

Definition at line 359 of file BelosTFQMRIter.hpp.

◆ initialize()

template<class ScalarType , class MV , class OP , class DM >

void Belos::TFQMRIter< ScalarType, MV, OP, DM >::initialize ( )

inlinevirtual

Initialize the solver with the initial vectors from the linear problem or random data.

Implements Belos::Iteration< ScalarType, MV, OP, DM >.

Definition at line 157 of file BelosTFQMRIter.hpp.

◆ getState()

template<class ScalarType , class MV , class OP , class DM >

TFQMRIterState< ScalarType, MV > Belos::TFQMRIter< ScalarType, MV, OP, DM >::getState ( ) const

inline

Get the current state of the linear solver.

The data is only valid if isInitialized() == true.

Returns: A TFQMRIterState object containing const pointers to the current solver state.

Definition at line 170 of file BelosTFQMRIter.hpp.

◆ getNumIters()

template<class ScalarType , class MV , class OP , class DM >

int Belos::TFQMRIter< ScalarType, MV, OP, DM >::getNumIters ( ) const

inlinevirtual

Get the current iteration count.

Implements Belos::Iteration< ScalarType, MV, OP, DM >.

Definition at line 189 of file BelosTFQMRIter.hpp.

◆ resetNumIters()

template<class ScalarType , class MV , class OP , class DM >

void Belos::TFQMRIter< ScalarType, MV, OP, DM >::resetNumIters ( int iter = 0 )

inlinevirtual

Reset the iteration count.

Implements Belos::Iteration< ScalarType, MV, OP, DM >.

Definition at line 192 of file BelosTFQMRIter.hpp.

◆ getNativeResiduals()

template<class ScalarType , class MV , class OP , class DM >

Teuchos::RCP< const MV > Belos::TFQMRIter< ScalarType, MV, OP, DM >::getNativeResiduals ( std::vector< MagnitudeType > * norms ) const

Get the norms of the residuals native to the solver.

Returns: A std::vector of length blockSize containing the native residuals.

Definition at line 311 of file BelosTFQMRIter.hpp.

◆ getCurrentUpdate()

template<class ScalarType , class MV , class OP , class DM >

Teuchos::RCP< MV > Belos::TFQMRIter< ScalarType, MV, OP, DM >::getCurrentUpdate ( ) const

inlinevirtual

Get the current update to the linear system.

Note: This method returns the accumulated update to the solution instead of updating the linear problem, since it may incur an additional preconditioner application each iteration.

Implements Belos::Iteration< ScalarType, MV, OP, DM >.

Definition at line 202 of file BelosTFQMRIter.hpp.