Belos Version of the Day
Public Types
Belos::BlockCGIter< ScalarType, MV, OP > Class Template Reference

This class implements the block, preconditioned Conjugate Gradient (CG) iteration. More...

#include <BelosBlockCGIter.hpp>

Inheritance diagram for Belos::BlockCGIter< ScalarType, MV, OP >:
Inheritance graph
[legend]

List of all members.

Public Types

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

Public Member Functions

Constructors/Destructor
 BlockCGIter (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< OutputManager< ScalarType > > &printer, const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &tester, const Teuchos::RCP< MatOrthoManager< ScalarType, MV, OP > > &ortho, Teuchos::ParameterList &params)
 BlockCGIter constructor with linear problem, solver utilities, and parameter list of solver options.
virtual ~BlockCGIter ()
 Destructor.
Solver methods
void iterate ()
 This method performs BlockCG iterations until the status test indicates the need to stop or an error occurs (in which case, an std::exception is thrown).
void initializeCG (CGIterationState< 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.
CGIterationState< 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 > *norms) const
 Get the norms of the residuals native to the solver.
Teuchos::RCP< MV > getCurrentUpdate () const
 Get the current update to the linear system.
Accessor methods
const LinearProblem
< ScalarType, MV, OP > & 
getProblem () const
 Get a constant reference to the linear problem.
int getBlockSize () const
 Get the block size to be used by the iterative solver in solving this linear problem.
void setBlockSize (int blockSize)
 Set the block size to be used by the iterative solver in solving this linear problem.
bool isInitialized ()
 States whether the solver has been initialized or not.

Detailed Description

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

This class implements the block, preconditioned Conjugate Gradient (CG) iteration.

Author:
Teri Barth and Heidi Thornquist

Definition at line 81 of file BelosBlockCGIter.hpp.


Member Typedef Documentation

template<class ScalarType , class MV , class OP >
typedef MultiVecTraits<ScalarType,MV> Belos::BlockCGIter< ScalarType, MV, OP >::MVT

Definition at line 88 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
typedef OperatorTraits<ScalarType,MV,OP> Belos::BlockCGIter< ScalarType, MV, OP >::OPT

Definition at line 89 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
typedef Teuchos::ScalarTraits<ScalarType> Belos::BlockCGIter< ScalarType, MV, OP >::SCT

Definition at line 90 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
typedef SCT::magnitudeType Belos::BlockCGIter< ScalarType, MV, OP >::MagnitudeType

Definition at line 91 of file BelosBlockCGIter.hpp.


Constructor & Destructor Documentation

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

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

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

Definition at line 267 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
virtual Belos::BlockCGIter< ScalarType, MV, OP >::~BlockCGIter ( ) [inline, virtual]

Destructor.

Definition at line 108 of file BelosBlockCGIter.hpp.


Member Function Documentation

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP >::iterate ( ) [virtual]

This method performs BlockCG 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 BlockCG 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 412 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP >::initializeCG ( CGIterationState< ScalarType, MV >  newstate) [virtual]

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

The BlockCGIter 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.

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

Definition at line 350 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP >::initialize ( ) [inline, virtual]

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

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

Definition at line 148 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
CGIterationState<ScalarType,MV> Belos::BlockCGIter< ScalarType, MV, OP >::getState ( ) const [inline, virtual]

Get the current state of the linear solver.

The data is only valid if isInitialized() == true.

Returns:
A CGIterationState object containing const pointers to the current solver state.

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

Definition at line 160 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
int Belos::BlockCGIter< ScalarType, MV, OP >::getNumIters ( ) const [inline, virtual]

Get the current iteration count.

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

Definition at line 176 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP >::resetNumIters ( int  iter = 0) [inline, virtual]

Reset the iteration count.

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

Definition at line 179 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<const MV> Belos::BlockCGIter< ScalarType, MV, OP >::getNativeResiduals ( std::vector< MagnitudeType > *  norms) 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 183 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::BlockCGIter< ScalarType, MV, OP >::getCurrentUpdate ( ) const [inline, virtual]

Get the current update to the linear system.

Note:
This method returns a null pointer because the linear problem is current.

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

Definition at line 188 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
const LinearProblem<ScalarType,MV,OP>& Belos::BlockCGIter< ScalarType, MV, OP >::getProblem ( ) const [inline, virtual]

Get a constant reference to the linear problem.

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

Definition at line 196 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
int Belos::BlockCGIter< ScalarType, MV, OP >::getBlockSize ( ) const [inline, virtual]

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

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

Definition at line 199 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BlockCGIter< ScalarType, MV, OP >::setBlockSize ( int  blockSize) [virtual]

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

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

Definition at line 324 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::BlockCGIter< ScalarType, MV, OP >::isInitialized ( ) [inline, virtual]

States whether the solver has been initialized or not.

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

Definition at line 205 of file BelosBlockCGIter.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines