This class implements the pseudo-block BiCGStab iteration, where the basic BiCGStab algorithm is performed on all of the linear systems simultaneously. More...

#include <BelosBiCGStabIter.hpp>

Inheritance diagram for Belos::BiCGStabIter< 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

typedef Teuchos::ScalarTraits< MagnitudeType >	MT

Public Member Functions
Constructors/Destructor
	BiCGStabIter (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)
	BiCGStabIter constructor with linear problem, solver utilities, and parameter list of solver options.

virtual	~BiCGStabIter ()
	Destructor.

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

void	initializeBiCGStab (BiCGStabIterationState< 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.

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

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

bool	breakdownDetected ()
	Has breakdown been detected in any 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::BiCGStabIter< ScalarType, MV, OP, DM >

This class implements the pseudo-block BiCGStab iteration, where the basic BiCGStab algorithm is performed on all of the linear systems simultaneously.

Author: Alicia Klinvex

Definition at line 79 of file BelosBiCGStabIter.hpp.

Member Typedef Documentation

◆ MVT

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

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

Definition at line 86 of file BelosBiCGStabIter.hpp.

◆ OPT

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

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

Definition at line 87 of file BelosBiCGStabIter.hpp.

◆ SCT

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

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

Definition at line 88 of file BelosBiCGStabIter.hpp.

◆ MagnitudeType

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

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

Definition at line 89 of file BelosBiCGStabIter.hpp.

◆ MT

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

typedef Teuchos::ScalarTraits<MagnitudeType> Belos::BiCGStabIter< ScalarType, MV, OP, DM >::MT

Definition at line 90 of file BelosBiCGStabIter.hpp.

Constructor & Destructor Documentation

◆ BiCGStabIter()

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

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

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

Definition at line 279 of file BelosBiCGStabIter.hpp.

◆ ~BiCGStabIter()

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

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

inlinevirtual

Destructor.

Definition at line 106 of file BelosBiCGStabIter.hpp.

Member Function Documentation

◆ iterate()

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

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

virtual

This method performs BiCGStab iterations on each linear system 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 BiCGStab 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, DM >.

Definition at line 427 of file BelosBiCGStabIter.hpp.

◆ initializeBiCGStab()

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

void Belos::BiCGStabIter< ScalarType, MV, OP, DM >::initializeBiCGStab ( BiCGStabIterationState< ScalarType, MV > & newstate )

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

The BiCGStabIter contains a certain amount of state, consisting of the current direction vectors and residuals.

initialize() gives the user the opportunity to manually set these, although this must be done with caution, abiding by the rules given below.

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.