Belos Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Attributes | List of all members
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]

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

void setDoCondEst (bool val)
 Sets whether or not to store the diagonal for condition estimation. More...
 
Teuchos::ArrayView< MagnitudeType > getDiag ()
 Gets the diagonal for condition estimation. More...
 
Teuchos::ArrayView< MagnitudeType > getOffDiag ()
 Gets the off-diagonal for condition estimation. More...
 
- Public Member Functions inherited from Belos::CGIteration< ScalarType, MV, OP >
- 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...
 

Private Attributes

const Teuchos::RCP
< LinearProblem< ScalarType,
MV, OP > > 		lp_
 
const Teuchos::RCP
< OutputManager< ScalarType > > 		om_
 
const Teuchos::RCP< StatusTest
< ScalarType, MV, OP > > 		stest_
 
int numRHS_
 
bool initialized_
 
int iter_
 
bool assertPositiveDefiniteness_
 
Teuchos::ArrayRCP< MagnitudeType > diag_
 
Teuchos::ArrayRCP< MagnitudeType > offdiag_
 
ScalarType pAp_old_
 
ScalarType beta_old_
 
ScalarType rHz_old2_
 
int numEntriesForCondEst_
 
bool doCondEst_
 
Teuchos::RCP< MV > R_
 
Teuchos::RCP< MV > Z_
 
Teuchos::RCP< MV > P_
 
Teuchos::RCP< MV > AP_
 

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. More...
 
virtual ~PseudoBlockCGIter ()
 Destructor. More...
 

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). More...
 
void initializeCG (CGIterationState< ScalarType, MV > &newstate)
 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...
 

Status methods

int getNumIters () const
 Get the current iteration count. More...
 
void resetNumIters (int iter=0)
 Reset the iteration count. More...
 
Teuchos::RCP< const MV > getNativeResiduals (std::vector< MagnitudeType > *) const
 Get the norms of the residuals native to the solver. More...
 
Teuchos::RCP< MV > getCurrentUpdate () const
 Get the current update to the linear system. More...
 

Accessor methods

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. More...
 
bool isInitialized ()
 States whether the solver has been initialized or not. More...
 

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 48 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 55 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 56 of file BelosPseudoBlockCGIter.hpp.

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

Definition at line 57 of file BelosPseudoBlockCGIter.hpp.

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

Definition at line 58 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 274 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
virtual Belos::PseudoBlockCGIter< ScalarType, MV, OP >::~PseudoBlockCGIter ( )
inlinevirtual

Destructor.

Definition at line 74 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 378 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 294 of file BelosPseudoBlockCGIter.hpp.

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

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

template<class ScalarType , class MV , class OP >
int Belos::PseudoBlockCGIter< ScalarType, MV, OP >::getNumIters ( ) const
inlinevirtual

Get the current iteration count.

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

Definition at line 150 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::PseudoBlockCGIter< ScalarType, MV, OP >::resetNumIters ( int  iter = 0)
inlinevirtual

Reset the iteration count.

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

Definition at line 153 of file BelosPseudoBlockCGIter.hpp.

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

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::PseudoBlockCGIter< ScalarType, MV, OP >::getCurrentUpdate ( ) const
inlinevirtual

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

template<class ScalarType , class MV , class OP >
const LinearProblem<ScalarType,MV,OP>& Belos::PseudoBlockCGIter< ScalarType, MV, OP >::getProblem ( ) const
inlinevirtual

Get a constant reference to the linear problem.

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

Definition at line 170 of file BelosPseudoBlockCGIter.hpp.

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

template<class ScalarType , class MV , class OP >
void Belos::PseudoBlockCGIter< ScalarType, MV, OP >::setBlockSize ( int  blockSize)
inlinevirtual

Set the blocksize.

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

Definition at line 176 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::PseudoBlockCGIter< ScalarType, MV, OP >::isInitialized ( )
inlinevirtual

States whether the solver has been initialized or not.

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

Definition at line 182 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::PseudoBlockCGIter< ScalarType, MV, OP >::setDoCondEst ( bool  val)
inlinevirtual

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

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

Definition at line 187 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::ArrayView<MagnitudeType> Belos::PseudoBlockCGIter< ScalarType, MV, OP >::getDiag ( )
inlinevirtual

Gets the diagonal for condition estimation.

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

Definition at line 192 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::ArrayView<MagnitudeType> Belos::PseudoBlockCGIter< ScalarType, MV, OP >::getOffDiag ( )
inlinevirtual

Gets the off-diagonal for condition estimation.

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

Definition at line 205 of file BelosPseudoBlockCGIter.hpp.

Member Data Documentation

template<class ScalarType , class MV , class OP >
const Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > Belos::PseudoBlockCGIter< ScalarType, MV, OP >::lp_
private

Definition at line 224 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
const Teuchos::RCP<OutputManager<ScalarType> > Belos::PseudoBlockCGIter< ScalarType, MV, OP >::om_
private

Definition at line 225 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
const Teuchos::RCP<StatusTest<ScalarType,MV,OP> > Belos::PseudoBlockCGIter< ScalarType, MV, OP >::stest_
private

Definition at line 226 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
int Belos::PseudoBlockCGIter< ScalarType, MV, OP >::numRHS_
private

Definition at line 232 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::PseudoBlockCGIter< ScalarType, MV, OP >::initialized_
private

Definition at line 240 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
int Belos::PseudoBlockCGIter< ScalarType, MV, OP >::iter_
private

Definition at line 243 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::PseudoBlockCGIter< ScalarType, MV, OP >::assertPositiveDefiniteness_
private

Definition at line 246 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::ArrayRCP<MagnitudeType> Belos::PseudoBlockCGIter< ScalarType, MV, OP >::diag_
private

Definition at line 249 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::ArrayRCP<MagnitudeType> Belos::PseudoBlockCGIter< ScalarType, MV, OP >::offdiag_
private

Definition at line 249 of file BelosPseudoBlockCGIter.hpp.

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

Definition at line 250 of file BelosPseudoBlockCGIter.hpp.

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

Definition at line 250 of file BelosPseudoBlockCGIter.hpp.

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

Definition at line 250 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
int Belos::PseudoBlockCGIter< ScalarType, MV, OP >::numEntriesForCondEst_
private

Definition at line 251 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
bool Belos::PseudoBlockCGIter< ScalarType, MV, OP >::doCondEst_
private

Definition at line 252 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::PseudoBlockCGIter< ScalarType, MV, OP >::R_
private

Definition at line 258 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::PseudoBlockCGIter< ScalarType, MV, OP >::Z_
private

Definition at line 261 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::PseudoBlockCGIter< ScalarType, MV, OP >::P_
private

Definition at line 264 of file BelosPseudoBlockCGIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::PseudoBlockCGIter< ScalarType, MV, OP >::AP_
private

Definition at line 267 of file BelosPseudoBlockCGIter.hpp.

The documentation for this class was generated from the following file:
Generated on Fri Dec 20 2024 09:24:56 for Belos Package Browser (Single Doxygen Collection) by   doxygen 1.8.5