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

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

#include <BelosPseudoBlockCGIter.hpp>

Inheritance diagram for Belos::PseudoBlockCGIter< 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
 PseudoBlockCGIter (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)
 PseudoBlockCGIter constructor with linear problem, solver utilities, and parameter list of solver options.
virtual ~PseudoBlockCGIter ()
 Destructor.
Solver methods
void iterate ()
 This method performs CG 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 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.
bool isInitialized ()
 States whether the solver has been initialized or not.

Detailed Description

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

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

Author:
Heidi Thornquist

Definition at line 81 of file BelosPseudoBlockCGIter.hpp.


Member Typedef Documentation

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

Definition at line 88 of file BelosPseudoBlockCGIter.hpp.

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

Definition at line 89 of file BelosPseudoBlockCGIter.hpp.

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

Definition at line 90 of file BelosPseudoBlockCGIter.hpp.

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

Definition at line 91 of file BelosPseudoBlockCGIter.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Belos::PseudoBlockCGIter< ScalarType, MV, OP >::PseudoBlockCGIter ( 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 
)

PseudoBlockCGIter 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 268 of file BelosPseudoBlockCGIter.hpp.

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

Destructor.

Definition at line 107 of file BelosPseudoBlockCGIter.hpp.


Member Function Documentation

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

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

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

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

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

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 286 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::PseudoBlockCGIter< 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 154 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
CGIterationState<ScalarType,MV> Belos::PseudoBlockCGIter< 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 167 of file BelosPseudoBlockCGIter.hpp.

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

Get the current iteration count.

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

Definition at line 183 of file BelosPseudoBlockCGIter.hpp.

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

Reset the iteration count.

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

Definition at line 186 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<const MV> Belos::PseudoBlockCGIter< 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 190 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::PseudoBlockCGIter< 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 195 of file BelosPseudoBlockCGIter.hpp.

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

Get a constant reference to the linear problem.

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

Definition at line 203 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
int Belos::PseudoBlockCGIter< 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 206 of file BelosPseudoBlockCGIter.hpp.

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

Set the blocksize.

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

Definition at line 209 of file BelosPseudoBlockCGIter.hpp.

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

States whether the solver has been initialized or not.

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

Definition at line 215 of file BelosPseudoBlockCGIter.hpp.


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