Belos Package Browser (Single Doxygen Collection) Development
Public Member Functions | Private Types | Static Private Attributes
Belos::RCGSolMgr< ScalarType, MV, OP, scalarTypeIsComplex > Class Template Reference

Implementation of the RCG (Recycling Conjugate Gradient) iterative linear solver. More...

#include <BelosRCGSolMgr.hpp>

List of all members.

Public Member Functions

 RCGSolMgr ()
 RCGSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
virtual ~RCGSolMgr ()

Private Types

typedef
Details::RealSolverManager
< ScalarType, MV, OP,
isComplex
base_type

Static Private Attributes

static const bool isComplex = Teuchos::ScalarTraits<ScalarType>::isComplex

Detailed Description

template<class ScalarType, class MV, class OP, const bool scalarTypeIsComplex = Teuchos::ScalarTraits<ScalarType>::isComplex>
class Belos::RCGSolMgr< ScalarType, MV, OP, scalarTypeIsComplex >

Implementation of the RCG (Recycling Conjugate Gradient) iterative linear solver.

Author:
Michael Parks and Heidi Thornquist

Summary

This class implements the GCRODR (Recycling GMRES) iterative linear solver. This solver is suited for solving sequences of related linear systems $A_i x_i = b_i$, where each matrix $A_i$ is symmetric positive definite.

ScalarType must be real

This RCG implementation currently only supports real-valued (not complex-valued) ScalarType types. You may check whether ScalarType is complex using the following code:

if (Teuchos::ScalarTraits<ScalarType>::isComplex) {
  // ScalarType is complex valued.
} else {
  // ScalarType is real valued.
}

This is not a limitation of the RCG method itself, just of the current implementation. If there is sufficient interest, we can remedy this deficiency. For now, if you attempt to invoke the constructor when ScalarType is complex, the constructor will throw an exception. This is why this class inherits from Details::RealSolverManager. RCGSolMgr can still compile if ScalarType is complex, but you will not be able to construct a RCGSolMgr instance in that case, due to the aforementioned run-time error that the constructor raises. We do this so that the class will still compile, whether ScalarType is real or complex. This helps make SolverFactory valid to compile, whether ScalarType is real or complex.

Definition at line 153 of file BelosRCGSolMgr.hpp.


Member Typedef Documentation

template<class ScalarType , class MV , class OP , const bool scalarTypeIsComplex = Teuchos::ScalarTraits<ScalarType>::isComplex>
typedef Details::RealSolverManager<ScalarType, MV, OP, isComplex> Belos::RCGSolMgr< ScalarType, MV, OP, scalarTypeIsComplex >::base_type [private]

Definition at line 158 of file BelosRCGSolMgr.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP , const bool scalarTypeIsComplex = Teuchos::ScalarTraits<ScalarType>::isComplex>
Belos::RCGSolMgr< ScalarType, MV, OP, scalarTypeIsComplex >::RCGSolMgr ( ) [inline]

Definition at line 161 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP , const bool scalarTypeIsComplex = Teuchos::ScalarTraits<ScalarType>::isComplex>
Belos::RCGSolMgr< ScalarType, MV, OP, scalarTypeIsComplex >::RCGSolMgr ( const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &  problem,
const Teuchos::RCP< Teuchos::ParameterList > &  pl 
) [inline]

Definition at line 164 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP , const bool scalarTypeIsComplex = Teuchos::ScalarTraits<ScalarType>::isComplex>
virtual Belos::RCGSolMgr< ScalarType, MV, OP, scalarTypeIsComplex >::~RCGSolMgr ( ) [inline, virtual]

Definition at line 168 of file BelosRCGSolMgr.hpp.


Member Data Documentation

template<class ScalarType , class MV , class OP , const bool scalarTypeIsComplex = Teuchos::ScalarTraits<ScalarType>::isComplex>
const bool Belos::RCGSolMgr< ScalarType, MV, OP, scalarTypeIsComplex >::isComplex = Teuchos::ScalarTraits<ScalarType>::isComplex [static, private]

Definition at line 157 of file BelosRCGSolMgr.hpp.


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