Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType > Class Template Reference

Stub implementation of BlockCGIter, for ScalarType types for which Teuchos::LAPACK does NOT have a valid implementation. More...

#include <BelosBlockCGIter.hpp>

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

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

 BlockCGIter (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &, const Teuchos::RCP< OutputManager< ScalarType > > &, const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &, const Teuchos::RCP< MatOrthoManager< ScalarType, MV, OP > > &, Teuchos::ParameterList &)
 
virtual ~BlockCGIter ()
 
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). More...
 
void initializeCG (CGIterationState< ScalarType, MV > &)
 Initialize the solver to an iterate, providing a complete state. More...
 
void initialize ()
 Initialize the solver with the initial vectors from the linear problem or random data. More...
 
CGIterationState< ScalarType, MV > getState () const
 Get the current state of the linear solver. More...
 
int getNumIters () const
 Get the current iteration count. More...
 
void resetNumIters (int iter=0)
 Reset the iteration count to iter. More...
 
Teuchos::RCP< const MV > getNativeResiduals (std::vector< MagnitudeType > *) const
 
Teuchos::RCP< MV > getCurrentUpdate () const
 Get the current update to the linear system. More...
 
const LinearProblem
< ScalarType, MV, OP > & 		getProblem () const
 Get a constant reference to the linear problem. More...
 
int getBlockSize () const
 Get the blocksize to be used by the iterative solver in solving this linear problem. More...
 
void setBlockSize (int blockSize)
 Set the blocksize to be used by the iterative solver in solving this linear problem. More...
 
bool isInitialized ()
 States whether the solver has been initialized or not. More...
 
void setDoCondEst (bool val)
 Sets whether or not to store the diagonal for condition estimation. More...
 
- Public Member Functions inherited from Belos::CGIteration< ScalarType, MV, OP >
virtual Teuchos::ArrayView
< typename
Teuchos::ScalarTraits
< ScalarType >::magnitudeType > 		getDiag ()=0
 Gets the diagonal for condition estimation. More...
 
virtual Teuchos::ArrayView
< typename
Teuchos::ScalarTraits
< ScalarType >::magnitudeType > 		getOffDiag ()=0
 Gets the off-diagonal for condition estimation. More...
 
- Public Member Functions inherited from Belos::Iteration< ScalarType, MV, OP >
 Iteration ()
 Default Constructor. More...
 
virtual ~Iteration ()
 Destructor. More...
 
virtual Teuchos::RCP< const MV > getNativeResiduals (std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > *norms) const =0
 Get the residuals native to the solver. More...
 

Detailed Description

template<class ScalarType, class MV, class OP, const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
class Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >

Stub implementation of BlockCGIter, for ScalarType types for which Teuchos::LAPACK does NOT have a valid implementation.

Implementation of the block preconditioned Conjugate Gradient (CG) iteration.

Author
Teri Barth and Heidi Thornquist

Definition at line 83 of file BelosBlockCGIter.hpp.

Member Typedef Documentation

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
typedef MultiVecTraits<ScalarType,MV> Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::MVT

Definition at line 85 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
typedef OperatorTraits<ScalarType,MV,OP> Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::OPT

Definition at line 86 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
typedef Teuchos::ScalarTraits<ScalarType> Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::SCT

Definition at line 87 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
typedef SCT::magnitudeType Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::MagnitudeType

Definition at line 88 of file BelosBlockCGIter.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::BlockCGIter ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  ,
const Teuchos::RCP< OutputManager< ScalarType > > &  ,
const Teuchos::RCP< StatusTest< ScalarType, MV, OP > > &  ,
const Teuchos::RCP< MatOrthoManager< ScalarType, MV, OP > > &  ,
Teuchos::ParameterList &   
)
inline

Definition at line 90 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
virtual Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::~BlockCGIter ( )
inlinevirtual

Definition at line 99 of file BelosBlockCGIter.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
void Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::iterate ( )
inlinevirtual

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

Definition at line 101 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
void Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::initializeCG ( CGIterationState< ScalarType, MV > &  newstate)
inlinevirtual

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

The CGIteration 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 105 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
void Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::initialize ( )
inlinevirtual

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

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

Definition at line 109 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
CGIterationState<ScalarType,MV> Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::getState ( ) const
inlinevirtual

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 113 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
int Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::getNumIters ( ) const
inlinevirtual

Get the current iteration count.

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

Definition at line 117 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
void Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::resetNumIters ( int  iter = 0)
inlinevirtual

Reset the iteration count to iter.

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

Definition at line 121 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
Teuchos::RCP<const MV> Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::getNativeResiduals ( std::vector< MagnitudeType > *  ) const
inline

Definition at line 126 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
Teuchos::RCP<MV> Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::getCurrentUpdate ( ) const
inlinevirtual

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

Definition at line 130 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
const LinearProblem<ScalarType,MV,OP>& Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::getProblem ( ) const
inlinevirtual

Get a constant reference to the linear problem.

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

Definition at line 134 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
int Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::getBlockSize ( ) const
inlinevirtual

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

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

Definition at line 138 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
void Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::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 >.

Definition at line 142 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
bool Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::isInitialized ( )
inlinevirtual

States whether the solver has been initialized or not.

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

Definition at line 146 of file BelosBlockCGIter.hpp.

template<class ScalarType , class MV , class OP , const bool lapackSupportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value>
void Belos::BlockCGIter< ScalarType, MV, OP, lapackSupportsScalarType >::setDoCondEst ( bool  val)
inlinevirtual

Sets whether or not to store the diagonal for condition estimation.

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

Definition at line 150 of file BelosBlockCGIter.hpp.

The documentation for this class was generated from the following file:
Generated on Wed Apr 24 2024 09:29:06 for Belos by doxygen 1.8.5