ROL
Public Member Functions | Private Types | Private Attributes | List of all members
ROL::GMRES< Real > Class Template Reference

Preconditioned GMRES solver. More...

#include <ROL_GMRES.hpp>

+ Inheritance diagram for ROL::GMRES< Real >:

Public Member Functions

 GMRES (ROL::ParameterList &parlist)
 
Real run (Vector< Real > &x, LinearOperator< Real > &A, const Vector< Real > &b, LinearOperator< Real > &M, int &iter, int &flag)
 
void enableOutput (std::ostream &outStream)
 
void disableOutput ()
 
- Public Member Functions inherited from ROL::Krylov< Real >
virtual ~Krylov (void)
 
 Krylov (Real absTol=1.e-4, Real relTol=1.e-2, unsigned maxit=100)
 
 Krylov (ROL::ParameterList &parlist)
 
void resetAbsoluteTolerance (const Real absTol)
 
void resetRelativeTolerance (const Real relTol)
 
void resetMaximumIteration (const unsigned maxit)
 
Real getAbsoluteTolerance (void) const
 
Real getRelativeTolerance (void) const
 
unsigned getMaximumIteration (void) const
 

Private Types

typedef LA::Matrix< Real > SDMatrix
 
typedef LA::Vector< Real > SDVector
 

Private Attributes

ROL::Ptr< Vector< Real > > r_
 
ROL::Ptr< Vector< Real > > z_
 
ROL::Ptr< Vector< Real > > w_
 
ROL::Ptr< SDMatrix > H_
 
ROL::Ptr< SDVector > cs_
 
ROL::Ptr< SDVector > sn_
 
ROL::Ptr< SDVector > s_
 
ROL::Ptr< SDVector > y_
 
ROL::Ptr< SDVector > cnorm_
 
ROL::Ptr< std::vector< Real > > res_
 
bool isInitialized_
 
bool useInexact_
 
bool useInitialGuess_
 
bool printIters_
 
ROL::Ptr< std::ostream > outStream_
 
ROL::LAPACK< int, Real > lapack_
 

Detailed Description

template<class Real>
class ROL::GMRES< Real >

Preconditioned GMRES solver.

Definition at line 26 of file ROL_GMRES.hpp.

Member Typedef Documentation

template<class Real >
typedef LA::Matrix<Real> ROL::GMRES< Real >::SDMatrix
private

Definition at line 28 of file ROL_GMRES.hpp.

template<class Real >
typedef LA::Vector<Real> ROL::GMRES< Real >::SDVector
private

Definition at line 29 of file ROL_GMRES.hpp.

Constructor & Destructor Documentation

template<class Real >
ROL::GMRES< Real >::GMRES ( ROL::ParameterList &  parlist)
inline

Definition at line 56 of file ROL_GMRES.hpp.

References ROL::GMRES< Real >::cnorm_, ROL::GMRES< Real >::cs_, ROL::Krylov< Real >::getMaximumIteration(), ROL::GMRES< Real >::H_, ROL::GMRES< Real >::res_, ROL::GMRES< Real >::s_, ROL::GMRES< Real >::sn_, ROL::GMRES< Real >::useInexact_, ROL::GMRES< Real >::useInitialGuess_, ROL::GMRES< Real >::y_, and zero.

Member Function Documentation

template<class Real >
Real ROL::GMRES< Real >::run ( Vector< Real > &  x,
LinearOperator< Real > &  A,
const Vector< Real > &  b,
LinearOperator< Real > &  M,
int &  iter,
int &  flag 
)
inlinevirtual

Implements ROL::Krylov< Real >.

Definition at line 79 of file ROL_GMRES.hpp.

References ROL::LinearOperator< Real >::apply(), ROL::LinearOperator< Real >::applyInverse(), ROL::Vector< Real >::clone(), ROL::GMRES< Real >::cnorm_, ROL::GMRES< Real >::cs_, ROL::Krylov< Real >::getAbsoluteTolerance(), ROL::Krylov< Real >::getMaximumIteration(), ROL::Krylov< Real >::getRelativeTolerance(), ROL::GMRES< Real >::H_, ROL::GMRES< Real >::isInitialized_, ROL::GMRES< Real >::lapack_, ROL::GMRES< Real >::outStream_, ROL::Vector< Real >::plus(), ROL::GMRES< Real >::printIters_, ROL::GMRES< Real >::r_, ROL::GMRES< Real >::res_, ROL::GMRES< Real >::s_, ROL::GMRES< Real >::sn_, ROL::GMRES< Real >::useInexact_, ROL::GMRES< Real >::useInitialGuess_, ROL::GMRES< Real >::w_, ROL::GMRES< Real >::y_, ROL::GMRES< Real >::z_, zero, and ROL::Vector< Real >::zero().

template<class Real >
void ROL::GMRES< Real >::enableOutput ( std::ostream &  outStream)
inline

Definition at line 232 of file ROL_GMRES.hpp.

References ROL::GMRES< Real >::outStream_, and ROL::GMRES< Real >::printIters_.

template<class Real >
void ROL::GMRES< Real >::disableOutput ( )
inline

Definition at line 237 of file ROL_GMRES.hpp.

References ROL::GMRES< Real >::printIters_.

Member Data Documentation

template<class Real >
ROL::Ptr<Vector<Real> > ROL::GMRES< Real >::r_
private

Definition at line 33 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::run().

template<class Real >
ROL::Ptr<Vector<Real> > ROL::GMRES< Real >::z_
private

Definition at line 34 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::run().

template<class Real >
ROL::Ptr<Vector<Real> > ROL::GMRES< Real >::w_
private

Definition at line 35 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::run().

template<class Real >
ROL::Ptr<SDMatrix> ROL::GMRES< Real >::H_
private

Definition at line 37 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::GMRES(), and ROL::GMRES< Real >::run().

template<class Real >
ROL::Ptr<SDVector> ROL::GMRES< Real >::cs_
private

Definition at line 38 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::GMRES(), and ROL::GMRES< Real >::run().

template<class Real >
ROL::Ptr<SDVector> ROL::GMRES< Real >::sn_
private

Definition at line 39 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::GMRES(), and ROL::GMRES< Real >::run().

template<class Real >
ROL::Ptr<SDVector> ROL::GMRES< Real >::s_
private

Definition at line 40 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::GMRES(), and ROL::GMRES< Real >::run().

template<class Real >
ROL::Ptr<SDVector> ROL::GMRES< Real >::y_
private

Definition at line 41 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::GMRES(), and ROL::GMRES< Real >::run().

template<class Real >
ROL::Ptr<SDVector> ROL::GMRES< Real >::cnorm_
private

Definition at line 42 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::GMRES(), and ROL::GMRES< Real >::run().

template<class Real >
ROL::Ptr<std::vector<Real> > ROL::GMRES< Real >::res_
private

Definition at line 44 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::GMRES(), and ROL::GMRES< Real >::run().

template<class Real >
bool ROL::GMRES< Real >::isInitialized_
private

Definition at line 46 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::run().

template<class Real >
bool ROL::GMRES< Real >::useInexact_
private

Definition at line 47 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::GMRES(), and ROL::GMRES< Real >::run().

template<class Real >
bool ROL::GMRES< Real >::useInitialGuess_
private

Definition at line 48 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::GMRES(), and ROL::GMRES< Real >::run().

template<class Real >
bool ROL::GMRES< Real >::printIters_
private

Definition at line 49 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::disableOutput(), ROL::GMRES< Real >::enableOutput(), and ROL::GMRES< Real >::run().

template<class Real >
ROL::Ptr<std::ostream> ROL::GMRES< Real >::outStream_
private

Definition at line 50 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::enableOutput(), and ROL::GMRES< Real >::run().

template<class Real >
ROL::LAPACK<int,Real> ROL::GMRES< Real >::lapack_
private

Definition at line 52 of file ROL_GMRES.hpp.

Referenced by ROL::GMRES< Real >::run().

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