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

This class implements the RCG iteration, where a single-std::vector Krylov subspace is constructed. More...

#include <BelosRCGIter.hpp>

Inheritance diagram for Belos::RCGIter< 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 Attributes
const Teuchos::RCP < LinearProblem< ScalarType, MV, OP > >	lp_
const Teuchos::RCP < OutputManager< ScalarType > >	om_
const Teuchos::RCP< StatusTest < ScalarType, MV, OP > >	stest_
int	numBlocks_
int	recycleBlocks_
bool	initialized_
int	curDim_
int	iter_
Teuchos::RCP< MV >	P_
Teuchos::RCP< MV >	Ap_
Teuchos::RCP< MV >	r_
Teuchos::RCP< MV >	z_
bool	existU_
Teuchos::RCP< MV >	U_
Teuchos::RCP< MV >	AU_
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > >	Alpha_
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > >	Beta_
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > >	D_
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > >	Delta_
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > >	LUUTAU_
Teuchos::RCP< std::vector< int > >	ipiv_
Teuchos::RCP < Teuchos::SerialDenseMatrix < int, ScalarType > >	rTz_old_

Constructors/Destructor
	RCGIter (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)
	RCGIter constructor with linear problem, solver utilities, and parameter list of solver options. More...
virtual	~RCGIter ()
	Destructor. More...

Solver methods
void	iterate ()
	This method performs RCG iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown). More...
void	initialize (RCGIterState< 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...

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 > *) 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...
int	getCurSubspaceDim () const
	Get the dimension of the search subspace used to generate the current solution to the linear problem. More...
int	getMaxSubspaceDim () const
	Get the maximum dimension allocated for the search subspace. More...

Accessor methods
const LinearProblem < ScalarType, MV, OP > &	getProblem () const
	Get a constant reference to the linear problem. More...
int	getNumBlocks () const
	Get the maximum number of blocks used by the iterative solver in solving this linear problem. More...
void	setNumBlocks (int numBlocks)
	Set the maximum number of blocks used by the iterative solver. More...
int	getRecycledBlocks () const
	Get the maximum number of recycled blocks used by the iterative solver in solving this linear problem. More...
void	setRecycledBlocks (int recycleBlocks)
	Set the maximum number of recycled blocks used by the iterative solver. 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...
void	setSize (int recycleBlocks, int numBlocks)
	Set the maximum number of blocks used by the iterative solver and the number of recycled vectors. More...
bool	isInitialized ()
	States whether the solver has been initialized or not. More...

Detailed Description

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

This class implements the RCG iteration, where a single-std::vector Krylov subspace is constructed.

Author

Michael Parks and Heidi Thornquist

Definition at line 113 of file BelosRCGIter.hpp.

Member Typedef Documentation

template<class ScalarType , class MV , class OP >

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

Definition at line 120 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

Definition at line 121 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

Definition at line 122 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

Definition at line 123 of file BelosRCGIter.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >

Belos::RCGIter< ScalarType, MV, OP >::RCGIter	(	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
	)

RCGIter constructor with linear problem, solver utilities, and parameter list of solver options.

This constructor takes pointers required by the linear solver, in addition to a parameter list of options for the linear solver. These options include the following:

• "Num Blocks" - an int specifying the maximum number of blocks allocated for the solver basis. Default: 25
• "Restart Timers" = a bool specifying whether the timers should be restarted each time iterate() is called. Default: false

Definition at line 329 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Destructor.

Definition at line 141 of file BelosRCGIter.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >

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

virtual

This method performs RCG 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 RCG iterations until the status test evaluates as Passed, at which point the method returns to the caller.

The status test is queried at the beginning of the iteration.

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

Definition at line 458 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

void Belos::RCGIter< ScalarType, MV, OP >::initialize

(

RCGIterState< ScalarType, MV > &

newstate

)

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

The RCGIter contains a certain amount of state, consisting of the current residual, preconditioned residual, and decent direction.

initialize() gives the user the opportunity to manually set these, although only the current unpreconditioned residual is required.

Postcondition

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

Note

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

Definition at line 374 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

void Belos::RCGIter< 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 181 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Get the current iteration count.

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

Definition at line 193 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Reset the iteration count.

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

Definition at line 196 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

inline

Get the norms of the residuals native to the solver.

Returns

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

Definition at line 200 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Get the current update to the linear system.

Note

Some solvers, like GMRES, do not compute updates to the solution every iteration. This method forces its computation. Other solvers, like CG and RCG update the solution each iteration, so this method will return a zero std::vector indicating that the linear problem contains the current solution.

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

Definition at line 208 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

int Belos::RCGIter< ScalarType, MV, OP >::getCurSubspaceDim ( ) const

inline

Get the dimension of the search subspace used to generate the current solution to the linear problem.

Definition at line 211 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

int Belos::RCGIter< ScalarType, MV, OP >::getMaxSubspaceDim ( ) const

inline

Get the maximum dimension allocated for the search subspace.

Definition at line 217 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Get a constant reference to the linear problem.

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

Definition at line 226 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

int Belos::RCGIter< ScalarType, MV, OP >::getNumBlocks ( ) const

inline

Get the maximum number of blocks used by the iterative solver in solving this linear problem.

Definition at line 229 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

void Belos::RCGIter< ScalarType, MV, OP >::setNumBlocks ( int  numBlocks )

inline

Set the maximum number of blocks used by the iterative solver.

Definition at line 232 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

int Belos::RCGIter< ScalarType, MV, OP >::getRecycledBlocks ( ) const

inline

Get the maximum number of recycled blocks used by the iterative solver in solving this linear problem.

Definition at line 235 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

void Belos::RCGIter< ScalarType, MV, OP >::setRecycledBlocks ( int  recycleBlocks )

inline

Set the maximum number of recycled blocks used by the iterative solver.

Definition at line 238 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

int Belos::RCGIter< 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 241 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Set the blocksize.

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

Definition at line 244 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

void Belos::RCGIter< ScalarType, MV, OP >::setSize	(	int	recycleBlocks,
		int	numBlocks
	)

Set the maximum number of blocks used by the iterative solver and the number of recycled vectors.

Definition at line 359 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

inlinevirtual

States whether the solver has been initialized or not.

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

Definition at line 253 of file BelosRCGIter.hpp.

Member Data Documentation

template<class ScalarType , class MV , class OP >

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

private

Definition at line 266 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 267 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 268 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

int Belos::RCGIter< ScalarType, MV, OP >::numBlocks_

private

Definition at line 274 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

int Belos::RCGIter< ScalarType, MV, OP >::recycleBlocks_

private

Definition at line 277 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 285 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

int Belos::RCGIter< ScalarType, MV, OP >::curDim_

private

Definition at line 288 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 288 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::RCGIter< ScalarType, MV, OP >::P_

private

Definition at line 294 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::RCGIter< ScalarType, MV, OP >::Ap_

private

Definition at line 297 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::RCGIter< ScalarType, MV, OP >::r_

private

Definition at line 300 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<MV> Belos::RCGIter< ScalarType, MV, OP >::z_

private

Definition at line 303 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

bool Belos::RCGIter< ScalarType, MV, OP >::existU_

private

Definition at line 306 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 308 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

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

private

Definition at line 308 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::Alpha_

private

Definition at line 311 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::Beta_

private

Definition at line 311 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::D_

private

Definition at line 311 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::Delta_

private

Definition at line 314 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::LUUTAU_

private

Definition at line 317 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<std::vector<int> > Belos::RCGIter< ScalarType, MV, OP >::ipiv_

private

Definition at line 320 of file BelosRCGIter.hpp.

template<class ScalarType , class MV , class OP >

Teuchos::RCP<Teuchos::SerialDenseMatrix<int,ScalarType> > Belos::RCGIter< ScalarType, MV, OP >::rTz_old_

private

Definition at line 323 of file BelosRCGIter.hpp.

---

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

• BelosRCGIter.hpp