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

#include <BelosTFQMRIter.hpp>

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

Public Types
typedef MultiVecTraits < ScalarType, MV >	MVT
typedef OperatorTraits < ScalarType, MV, OP >	OPT
typedef Teuchos::ScalarTraits < ScalarType >	SCT
typedef SCT::magnitudeType	MagnitudeType

Private Member Functions
void	setStateSize ()
	Method for initalizing the state storage needed by TFQMR. More...

Private Attributes
const Teuchos::RCP < LinearProblem< ScalarType, MV, OP > >	lp_
const Teuchos::RCP < OutputManager< ScalarType > >	om_
const Teuchos::RCP< StatusTest < ScalarType, MV, OP > >	stest_
std::vector< ScalarType >	alpha_
std::vector< ScalarType >	rho_
std::vector< ScalarType >	rho_old_
std::vector< MagnitudeType >	tau_
std::vector< MagnitudeType >	cs_
std::vector< MagnitudeType >	theta_
bool	initialized_
bool	stateStorageInitialized_
int	iter_
Teuchos::RCP< MV >	R_
Teuchos::RCP< MV >	W_
Teuchos::RCP< MV >	U_
Teuchos::RCP< MV >	AU_
Teuchos::RCP< MV >	Rtilde_
Teuchos::RCP< MV >	D_
Teuchos::RCP< MV >	V_
Teuchos::RCP< MV >	solnUpdate_

Constructor/Destructor.
	TFQMRIter (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< OutputManager< ScalarType > > &printer, const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &tester, Teuchos::ParameterList &params)
	Belos::TFQMRIter constructor. More...
virtual	~TFQMRIter ()
	Belos::TFQMRIter destructor. More...

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). More...
void	initializeTFQMR (const TFQMRIterState< ScalarType, MV > &newstate)
	Initialize the solver to an iterate, providing a complete state. More...
void	initialize ()
	Initialize the solver with the initial vectors from the linear problem or random data. More...
TFQMRIterState< ScalarType, MV >	getState () const
	Get the current state of the linear solver. More...

Status methods
int	getNumIters () const
	Get the current iteration count. More...
void	resetNumIters (int iter=0)
	Reset the iteration count. More...
Teuchos::RCP< const MV >	getNativeResiduals (std::vector< MagnitudeType > *norms) const
	Get the norms of the residuals native to the solver. More...
Teuchos::RCP< MV >	getCurrentUpdate () const
	Get the current update to the linear system. More...

Accessor methods
const LinearProblem < ScalarType, MV, OP > &	getProblem () const
	Get a constant reference to the linear problem. More...
int	getBlockSize () const
	Get the blocksize to be used by the iterative solver in solving this linear problem. More...
void	setBlockSize (int blockSize)
	Set the blocksize. More...
bool	isInitialized ()
	States whether the solver has been initialized or not. More...

Detailed Description

template<class ScalarType, class MV, class OP>
class Belos::TFQMRIter< 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 vector and x is the corresponding solution.

Author

Heidi Thornquist

Definition at line 95 of file BelosTFQMRIter.hpp.

Member Typedef Documentation

template<class ScalarType , class MV , class OP >

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

Definition at line 100 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

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

Definition at line 101 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

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

Definition at line 102 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

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

Definition at line 103 of file BelosTFQMRIter.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

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

Belos::TFQMRIter constructor.

Definition at line 291 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Belos::TFQMRIter destructor.

Definition at line 115 of file BelosTFQMRIter.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >

void Belos::TFQMRIter< ScalarType, MV, OP >::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 >.

Definition at line 426 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

void Belos::TFQMRIter< ScalarType, MV, OP >::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 363 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

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

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

Definition at line 160 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

TFQMRIterState<ScalarType,MV> Belos::TFQMRIter< ScalarType, MV, OP >::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 173 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Get the current iteration count.

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

Definition at line 192 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Reset the iteration count.

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

Definition at line 195 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP< const MV > Belos::TFQMRIter< ScalarType, MV, OP >::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 315 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::TFQMRIter< ScalarType, MV, OP >::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 >.

Definition at line 205 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

const LinearProblem<ScalarType,MV,OP>& Belos::TFQMRIter< ScalarType, MV, OP >::getProblem ( ) const

inlinevirtual

Get a constant reference to the linear problem.

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

Definition at line 214 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Get the blocksize to be used by the iterative solver in solving this linear problem.

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

Definition at line 217 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

void Belos::TFQMRIter< ScalarType, MV, OP >::setBlockSize ( int  blockSize )

inlinevirtual

Set the blocksize.

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

Definition at line 220 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::TFQMRIter< ScalarType, MV, OP >::isInitialized ( )

inlinevirtual

States whether the solver has been initialized or not.

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

Definition at line 226 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

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

private

Method for initalizing the state storage needed by TFQMR.

Definition at line 328 of file BelosTFQMRIter.hpp.

Member Data Documentation

template<class ScalarType , class MV , class OP >

const Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > Belos::TFQMRIter< ScalarType, MV, OP >::lp_

private

Definition at line 242 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

const Teuchos::RCP<OutputManager<ScalarType> > Belos::TFQMRIter< ScalarType, MV, OP >::om_

private

Definition at line 243 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

const Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::TFQMRIter< ScalarType, MV, OP >::stest_

private

Definition at line 244 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

std::vector<ScalarType> Belos::TFQMRIter< ScalarType, MV, OP >::alpha_

private

Definition at line 252 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

std::vector<ScalarType> Belos::TFQMRIter< ScalarType, MV, OP >::rho_

private

Definition at line 252 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

std::vector<ScalarType> Belos::TFQMRIter< ScalarType, MV, OP >::rho_old_

private

Definition at line 252 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

std::vector<MagnitudeType> Belos::TFQMRIter< ScalarType, MV, OP >::tau_

private

Definition at line 253 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

std::vector<MagnitudeType> Belos::TFQMRIter< ScalarType, MV, OP >::cs_

private

Definition at line 253 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

std::vector<MagnitudeType> Belos::TFQMRIter< ScalarType, MV, OP >::theta_

private

Definition at line 253 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::TFQMRIter< ScalarType, MV, OP >::initialized_

private

Definition at line 261 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::TFQMRIter< ScalarType, MV, OP >::stateStorageInitialized_

private

Definition at line 266 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

int Belos::TFQMRIter< ScalarType, MV, OP >::iter_

private

Definition at line 269 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::TFQMRIter< ScalarType, MV, OP >::R_

private

Definition at line 274 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::TFQMRIter< ScalarType, MV, OP >::W_

private

Definition at line 275 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::TFQMRIter< ScalarType, MV, OP >::U_

private

Definition at line 276 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::TFQMRIter< ScalarType, MV, OP >::AU_

private

Definition at line 276 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::TFQMRIter< ScalarType, MV, OP >::Rtilde_

private

Definition at line 277 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::TFQMRIter< ScalarType, MV, OP >::D_

private

Definition at line 278 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::TFQMRIter< ScalarType, MV, OP >::V_

private

Definition at line 279 of file BelosTFQMRIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::TFQMRIter< ScalarType, MV, OP >::solnUpdate_

private

Definition at line 280 of file BelosTFQMRIter.hpp.

---

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

• BelosTFQMRIter.hpp