#include <BelosFGCRODRIter.hpp>

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

[legend]

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

typedef OperatorTraits< ScalarType, MV, OP >	OPT

typedef DenseMatTraits< ScalarType, DM >	DMT

typedef Teuchos::ScalarTraits< ScalarType >	SCT

typedef SCT::magnitudeType	MagnitudeType

Public Member Functions
	FGCRODRIter (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP, DM > > &problem, const Teuchos::RCP< OutputManager< ScalarType > > &printer, const Teuchos::RCP< StatusTest< ScalarType, MV, OP, DM > > &tester, const Teuchos::RCP< MatOrthoManager< ScalarType, MV, OP, DM > > &ortho, Teuchos::ParameterList &params)

virtual	~FGCRODRIter ()

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

void	initialize (GCRODRIterState< ScalarType, MV, DM > &newstate)

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

GCRODRIterState< ScalarType, MV, DM >	getState () const

int	getNumIters () const
	Get the current iteration count.

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

Teuchos::RCP< const MV >	getNativeResiduals (std::vector< MagnitudeType > *norms) const

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

void	updateLSQR (int dim=-1)

int	getCurSubspaceDim () const

int	getMaxSubspaceDim () const

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

int	getNumBlocks () const

void	setNumBlocks (int numBlocks)

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 to be used by the iterative solver in solving this linear problem.

void	setSize (int recycledBlocks, int numBlocks)

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

Public Member Functions inherited from Belos::GCRODRIteration< ScalarType, MV, OP, DM >
virtual	~GCRODRIteration ()

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.

Detailed Description

template<class ScalarType, class MV, class OP, class DM = DefaultDenseMatrix<int, ScalarType>>
class Belos::FGCRODRIter< ScalarType, MV, OP, DM >

Definition at line 34 of file BelosFGCRODRIter.hpp.

Member Typedef Documentation

◆ MVT

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

Definition at line 36 of file BelosFGCRODRIter.hpp.

◆ OPT

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

Definition at line 37 of file BelosFGCRODRIter.hpp.

◆ DMT

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

typedef DenseMatTraits<ScalarType,DM> Belos::FGCRODRIter< ScalarType, MV, OP, DM >::DMT

Definition at line 38 of file BelosFGCRODRIter.hpp.

◆ SCT

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

Definition at line 39 of file BelosFGCRODRIter.hpp.

◆ MagnitudeType

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

Definition at line 40 of file BelosFGCRODRIter.hpp.

Constructor & Destructor Documentation

◆ FGCRODRIter()

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

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

Definition at line 155 of file BelosFGCRODRIter.hpp.

◆ ~FGCRODRIter()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

inlinevirtual

Definition at line 48 of file BelosFGCRODRIter.hpp.

Member Function Documentation

◆ iterate()

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

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

virtual

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

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

Definition at line 356 of file BelosFGCRODRIter.hpp.

◆ initialize() [1/2]

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

void Belos::FGCRODRIter< ScalarType, MV, OP, DM >::initialize ( GCRODRIterState< ScalarType, MV, DM > & newstate )

virtual

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

Definition at line 309 of file BelosFGCRODRIter.hpp.

◆ initialize() [2/2]

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

void Belos::FGCRODRIter< 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 54 of file BelosFGCRODRIter.hpp.

◆ getState()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

GCRODRIterState< ScalarType, MV, DM > Belos::FGCRODRIter< ScalarType, MV, OP, DM >::getState ( ) const

inlinevirtual

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

Definition at line 59 of file BelosFGCRODRIter.hpp.

◆ getNumIters()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

inlinevirtual

Get the current iteration count.

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

Definition at line 72 of file BelosFGCRODRIter.hpp.

◆ resetNumIters()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

inlinevirtual

Reset the iteration count to iter.

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

Definition at line 74 of file BelosFGCRODRIter.hpp.

◆ getNativeResiduals()

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

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

Definition at line 289 of file BelosFGCRODRIter.hpp.

◆ getCurrentUpdate()

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

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

virtual

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 the computation of the current update.

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

Definition at line 214 of file BelosFGCRODRIter.hpp.

◆ updateLSQR()

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

void Belos::FGCRODRIter< ScalarType, MV, OP, DM >::updateLSQR ( int dim = -1 )

virtual

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

Definition at line 464 of file BelosFGCRODRIter.hpp.

◆ getCurSubspaceDim()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

inlinevirtual

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

Definition at line 83 of file BelosFGCRODRIter.hpp.

◆ getMaxSubspaceDim()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

inlinevirtual

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

Definition at line 88 of file BelosFGCRODRIter.hpp.

◆ getProblem()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

inlinevirtual

Get a constant reference to the linear problem.

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

Definition at line 90 of file BelosFGCRODRIter.hpp.

◆ getNumBlocks()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

inline

Definition at line 94 of file BelosFGCRODRIter.hpp.

◆ setNumBlocks()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

inline

Definition at line 96 of file BelosFGCRODRIter.hpp.

◆ getBlockSize()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

inlinevirtual

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

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

Definition at line 100 of file BelosFGCRODRIter.hpp.

◆ setBlockSize()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

inlinevirtual

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

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

Definition at line 102 of file BelosFGCRODRIter.hpp.

◆ setSize()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

void Belos::FGCRODRIter< ScalarType, MV, OP, DM >::setSize	(	int	recycledBlocks,
		int	numBlocks
	)

inlinevirtual

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

Definition at line 109 of file BelosFGCRODRIter.hpp.

◆ isInitialized()

template<class ScalarType , class MV , class OP , class DM = DefaultDenseMatrix<int, ScalarType>>

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

inlinevirtual

States whether the solver has been initialized or not.

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

Definition at line 122 of file BelosFGCRODRIter.hpp.

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

BelosFGCRODRIter.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ MVT

◆ OPT

◆ DMT

◆ SCT

◆ MagnitudeType

Constructor & Destructor Documentation

◆ FGCRODRIter()

◆ ~FGCRODRIter()

Member Function Documentation

◆ iterate()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ getState()

◆ getNumIters()

◆ resetNumIters()

◆ getNativeResiduals()

◆ getCurrentUpdate()

◆ updateLSQR()

◆ getCurSubspaceDim()

◆ getMaxSubspaceDim()

◆ getProblem()

◆ getNumBlocks()

◆ setNumBlocks()

◆ getBlockSize()

◆ setBlockSize()

◆ setSize()

◆ isInitialized()