Belos::RCGSolMgr< ScalarType, MV, OP, supportsScalarType > Class Template Reference

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

#include <BelosRCGSolMgr.hpp>

Inheritance diagram for Belos::RCGSolMgr< ScalarType, MV, OP, supportsScalarType >:

Public Member Functions
	RCGSolMgr ()
	RCGSolMgr (const Teuchos::RCP< LinearProblem< ScalarType, MV, OP > > &problem, const Teuchos::RCP< Teuchos::ParameterList > &pl)
virtual	~RCGSolMgr ()
Teuchos::RCP< SolverManager < ScalarType, MV, OP > >	clone () const override
	clone for Inverted Injection (DII) More...

Detailed Description

template<class ScalarType, class MV, class OP, const bool supportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value && ! Teuchos::ScalarTraits<ScalarType>::isComplex>
class Belos::RCGSolMgr< ScalarType, MV, OP, supportsScalarType >

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 , where each matrix 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.

Examples:

epetra/example/RCG/RCGEpetraExFile.cpp, and tpetra/example/RCG/RCGTpetraExFile.cpp.

Definition at line 115 of file BelosRCGSolMgr.hpp.

Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP , const bool supportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value && ! Teuchos::ScalarTraits<ScalarType>::isComplex>

Belos::RCGSolMgr< ScalarType, MV, OP, supportsScalarType >::RCGSolMgr ( )

inline

Definition at line 127 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP , const bool supportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value && ! Teuchos::ScalarTraits<ScalarType>::isComplex>

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

inline

Definition at line 130 of file BelosRCGSolMgr.hpp.

template<class ScalarType , class MV , class OP , const bool supportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value && ! Teuchos::ScalarTraits<ScalarType>::isComplex>

virtual Belos::RCGSolMgr< ScalarType, MV, OP, supportsScalarType >::~RCGSolMgr ( )

inlinevirtual

Definition at line 134 of file BelosRCGSolMgr.hpp.

Member Function Documentation

template<class ScalarType , class MV , class OP , const bool supportsScalarType = Belos::Details::LapackSupportsScalar<ScalarType>::value && ! Teuchos::ScalarTraits<ScalarType>::isComplex>

Teuchos::RCP<SolverManager<ScalarType, MV, OP> > Belos::RCGSolMgr< ScalarType, MV, OP, supportsScalarType >::clone ( ) const

inlineoverride

clone for Inverted Injection (DII)

Definition at line 137 of file BelosRCGSolMgr.hpp.

---

The documentation for this class was generated from the following file:

• BelosRCGSolMgr.hpp