Belos Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Private Attributes | List of all members
Belos::BiCGStabIter< ScalarType, MV, OP > Class Template Reference

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

#include <BelosBiCGStabIter.hpp>

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

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_
 
Teuchos::RCP< MV > Rhat_
 
Teuchos::RCP< MV > R_
 
Teuchos::RCP< MV > P_
 
Teuchos::RCP< MV > V_
 
std::vector< ScalarType > rho_old_
 
std::vector< ScalarType > alpha_
 
std::vector< ScalarType > omega_
 

BiCGStabIteration Structures

void axpy (const ScalarType alpha, const MV &A, const std::vector< ScalarType > beta, const MV &B, MV &mv, bool minus=false)
 

Constructors/Destructor

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

Solver methods

void iterate ()
 This method performs BiCGStab 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 initializeBiCGStab (BiCGStabIterationState< 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...
 
BiCGStabIterationState
< 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::BiCGStabIter< ScalarType, MV, OP >

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

Author
Alicia Klinvex

Definition at line 114 of file BelosBiCGStabIter.hpp.

Member Typedef Documentation

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

Definition at line 121 of file BelosBiCGStabIter.hpp.

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

Definition at line 122 of file BelosBiCGStabIter.hpp.

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

Definition at line 123 of file BelosBiCGStabIter.hpp.

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

Definition at line 124 of file BelosBiCGStabIter.hpp.

Constructor & Destructor Documentation

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

BiCGStabIter 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 307 of file BelosBiCGStabIter.hpp.

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

Destructor.

Definition at line 140 of file BelosBiCGStabIter.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP >
void Belos::BiCGStabIter< ScalarType, MV, OP >::iterate ( )
virtual

This method performs BiCGStab 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 BiCGStab 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 451 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BiCGStabIter< ScalarType, MV, OP >::initializeBiCGStab ( BiCGStabIterationState< ScalarType, MV > &  newstate)

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

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

Definition at line 324 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BiCGStabIter< 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 187 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
BiCGStabIterationState<ScalarType,MV> Belos::BiCGStabIter< ScalarType, MV, OP >::getState ( ) const
inline

Get the current state of the linear solver.

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

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

Definition at line 200 of file BelosBiCGStabIter.hpp.

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

Get the current iteration count.

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

Definition at line 219 of file BelosBiCGStabIter.hpp.

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

Reset the iteration count.

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

Definition at line 222 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<const MV> Belos::BiCGStabIter< 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 227 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::BiCGStabIter< 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 233 of file BelosBiCGStabIter.hpp.

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

Get a constant reference to the linear problem.

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

Definition at line 241 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
int Belos::BiCGStabIter< 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 244 of file BelosBiCGStabIter.hpp.

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

Set the blocksize.

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

Definition at line 247 of file BelosBiCGStabIter.hpp.

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

States whether the solver has been initialized or not.

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

Definition at line 253 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
void Belos::BiCGStabIter< ScalarType, MV, OP >::axpy ( const ScalarType  alpha,
const MV &  A,
const std::vector< ScalarType >  beta,
const MV &  B,
MV &  mv,
bool  minus = false 
)
private

Definition at line 619 of file BelosBiCGStabIter.hpp.

Member Data Documentation

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

Definition at line 265 of file BelosBiCGStabIter.hpp.

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

Definition at line 266 of file BelosBiCGStabIter.hpp.

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

Definition at line 267 of file BelosBiCGStabIter.hpp.

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

Definition at line 273 of file BelosBiCGStabIter.hpp.

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

Definition at line 281 of file BelosBiCGStabIter.hpp.

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

Definition at line 284 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::BiCGStabIter< ScalarType, MV, OP >::Rhat_
private

Definition at line 290 of file BelosBiCGStabIter.hpp.

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

Definition at line 293 of file BelosBiCGStabIter.hpp.

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

Definition at line 296 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
Teuchos::RCP<MV> Belos::BiCGStabIter< ScalarType, MV, OP >::V_
private

Definition at line 299 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
std::vector<ScalarType> Belos::BiCGStabIter< ScalarType, MV, OP >::rho_old_
private

Definition at line 301 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
std::vector<ScalarType> Belos::BiCGStabIter< ScalarType, MV, OP >::alpha_
private

Definition at line 301 of file BelosBiCGStabIter.hpp.

template<class ScalarType , class MV , class OP >
std::vector<ScalarType> Belos::BiCGStabIter< ScalarType, MV, OP >::omega_
private

Definition at line 301 of file BelosBiCGStabIter.hpp.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5