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

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

#include <BelosCGIter.hpp>

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

 CGIter (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)
 CGIter constructor with linear problem, solver utilities, and parameter list of solver options.
virtual ~CGIter ()
 Destructor.
Solver methods

void iterate ()
 This method performs CG 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 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.
bool isInitialized ()
 States whether the solver has been initialized or not.

Detailed Description

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

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

Author:
Teri Barth and Heidi Thornquist

Definition at line 65 of file BelosCGIter.hpp.


Member Typedef Documentation

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

Definition at line 72 of file BelosCGIter.hpp.

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

Definition at line 73 of file BelosCGIter.hpp.

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

Definition at line 74 of file BelosCGIter.hpp.

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

Definition at line 75 of file BelosCGIter.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Belos::CGIter< ScalarType, MV, OP >::CGIter ( 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 
) [inline]

CGIter 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 246 of file BelosCGIter.hpp.

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

Destructor.

Definition at line 91 of file BelosCGIter.hpp.


Member Function Documentation

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

This method performs CG 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 CG 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 353 of file BelosCGIter.hpp.

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

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

The CGIter 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 298 of file BelosCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::CGIter< 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 131 of file BelosCGIter.hpp.

template<class ScalarType , class MV , class OP >
CGIterationState<ScalarType,MV> Belos::CGIter< 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 143 of file BelosCGIter.hpp.

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

Get the current iteration count.

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

Definition at line 159 of file BelosCGIter.hpp.

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

Reset the iteration count.

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

Definition at line 162 of file BelosCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<const MV> Belos::CGIter< 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 166 of file BelosCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::CGIter< 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 171 of file BelosCGIter.hpp.

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

Get a constant reference to the linear problem.

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

Definition at line 179 of file BelosCGIter.hpp.

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

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

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

Definition at line 182 of file BelosCGIter.hpp.

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

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

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

Definition at line 185 of file BelosCGIter.hpp.

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

States whether the solver has been initialized or not.

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

Definition at line 191 of file BelosCGIter.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:05:09 2011 for Belos by  doxygen 1.6.3