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

Accessor methods
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_

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

int	getNumBlocks () const
	Get the maximum number of blocks used by the iterative solver in solving this linear problem.

void	setNumBlocks (int numBlocks)
	Set the maximum number of blocks used by the iterative solver.

int	getRecycledBlocks () const
	Get the maximum number of recycled blocks used by the iterative solver in solving this linear problem.

void	setRecycledBlocks (int recycleBlocks)
	Set the maximum number of recycled blocks used by the iterative solver.

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.

void	setSize (int recycleBlocks, int numBlocks)
	Set the maximum number of blocks used by the iterative solver and the number of recycled vectors.

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

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.

virtual	~RCGIter ()
	Destructor.

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).

void	initialize (RCGIterState< 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.

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 > *) const
	Get the norms of the residuals native to the solver.

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

int	getCurSubspaceDim () const
	Get the dimension of the search subspace used to generate the current solution to the linear problem.

int	getMaxSubspaceDim () const
	Get the maximum dimension allocated for the search subspace.

Additional Inherited Members
Public Member Functions inherited from Belos::Iteration< ScalarType, MV, OP >
	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.

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 145 of file BelosRCGIter.hpp.

Member Typedef Documentation

◆ MVT

template<class ScalarType , class MV , class OP >

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

Definition at line 152 of file BelosRCGIter.hpp.

◆ OPT

template<class ScalarType , class MV , class OP >

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

Definition at line 153 of file BelosRCGIter.hpp.

◆ SCT

template<class ScalarType , class MV , class OP >

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

Definition at line 154 of file BelosRCGIter.hpp.

◆ MagnitudeType

template<class ScalarType , class MV , class OP >

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

Definition at line 155 of file BelosRCGIter.hpp.

Constructor & Destructor Documentation

◆ RCGIter()

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 361 of file BelosRCGIter.hpp.

◆ ~RCGIter()

template<class ScalarType , class MV , class OP >

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

inlinevirtual

Destructor.

Definition at line 173 of file BelosRCGIter.hpp.

Member Function Documentation

◆ iterate()

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 490 of file BelosRCGIter.hpp.

◆ initialize() [1/2]

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 406 of file BelosRCGIter.hpp.

◆ initialize() [2/2]

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 213 of file BelosRCGIter.hpp.

◆ getNumIters()

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 225 of file BelosRCGIter.hpp.

◆ resetNumIters()

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 228 of file BelosRCGIter.hpp.

◆ getNativeResiduals()

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 232 of file BelosRCGIter.hpp.

◆ getCurrentUpdate()

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 240 of file BelosRCGIter.hpp.

◆ getCurSubspaceDim()

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 243 of file BelosRCGIter.hpp.

◆ getMaxSubspaceDim()

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 249 of file BelosRCGIter.hpp.

◆ getProblem()

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 258 of file BelosRCGIter.hpp.

◆ getNumBlocks()

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 261 of file BelosRCGIter.hpp.

◆ setNumBlocks()

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 264 of file BelosRCGIter.hpp.

◆ getRecycledBlocks()

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 267 of file BelosRCGIter.hpp.

◆ setRecycledBlocks()

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 270 of file BelosRCGIter.hpp.

◆ getBlockSize()

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 273 of file BelosRCGIter.hpp.

◆ setBlockSize()

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 276 of file BelosRCGIter.hpp.

◆ setSize()

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 391 of file BelosRCGIter.hpp.

◆ isInitialized()

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 285 of file BelosRCGIter.hpp.

Member Data Documentation

◆ lp_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 298 of file BelosRCGIter.hpp.

◆ om_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 299 of file BelosRCGIter.hpp.

◆ stest_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 300 of file BelosRCGIter.hpp.

◆ numBlocks_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 306 of file BelosRCGIter.hpp.

◆ recycleBlocks_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 309 of file BelosRCGIter.hpp.

◆ initialized_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 317 of file BelosRCGIter.hpp.

◆ curDim_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 320 of file BelosRCGIter.hpp.

◆ iter_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 320 of file BelosRCGIter.hpp.

◆ P_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 326 of file BelosRCGIter.hpp.

◆ Ap_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 329 of file BelosRCGIter.hpp.

◆ r_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 332 of file BelosRCGIter.hpp.

◆ z_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 335 of file BelosRCGIter.hpp.

◆ existU_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 338 of file BelosRCGIter.hpp.

◆ U_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 340 of file BelosRCGIter.hpp.

◆ AU_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 340 of file BelosRCGIter.hpp.

◆ Alpha_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 343 of file BelosRCGIter.hpp.

◆ Beta_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 343 of file BelosRCGIter.hpp.

◆ D_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 343 of file BelosRCGIter.hpp.

◆ Delta_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 346 of file BelosRCGIter.hpp.

◆ LUUTAU_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 349 of file BelosRCGIter.hpp.

◆ ipiv_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 352 of file BelosRCGIter.hpp.

◆ rTz_old_

template<class ScalarType , class MV , class OP >

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

private

Definition at line 355 of file BelosRCGIter.hpp.

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

BelosRCGIter.hpp

Public Types

Accessor methods

Constructors/Destructor

Solver methods

Status methods

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ MVT

◆ OPT

◆ SCT

◆ MagnitudeType

Constructor & Destructor Documentation

◆ RCGIter()

◆ ~RCGIter()

Member Function Documentation

◆ iterate()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ getNumIters()

◆ resetNumIters()

◆ getNativeResiduals()

◆ getCurrentUpdate()

◆ getCurSubspaceDim()

◆ getMaxSubspaceDim()

◆ getProblem()

◆ getNumBlocks()

◆ setNumBlocks()

◆ getRecycledBlocks()

◆ setRecycledBlocks()

◆ getBlockSize()

◆ setBlockSize()

◆ setSize()

◆ isInitialized()

Member Data Documentation

◆ lp_

◆ om_

◆ stest_

◆ numBlocks_

◆ recycleBlocks_

◆ initialized_

◆ curDim_

◆ iter_

◆ P_

◆ Ap_

◆ r_

◆ z_

◆ existU_

◆ U_

◆ AU_

◆ Alpha_

◆ Beta_

◆ D_

◆ Delta_

◆ LUUTAU_

◆ ipiv_

◆ rTz_old_