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)
 
virtual Real run (Vector< Real > &x, LinearOperator< Real > &A, const Vector< Real > &b, LinearOperator< Real > &M, int &iter, int &flag)=0
 
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< SDMatrixH_
 
ROL::Ptr< SDVectorcs_
 
ROL::Ptr< SDVectorsn_
 
ROL::Ptr< SDVectors_
 
ROL::Ptr< SDVectory_
 
ROL::Ptr< SDVectorcnorm_
 
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 60 of file ROL_GMRES.hpp.

Member Typedef Documentation

◆ SDMatrix

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

Definition at line 62 of file ROL_GMRES.hpp.

◆ SDVector

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

Definition at line 63 of file ROL_GMRES.hpp.

Constructor & Destructor Documentation

◆ GMRES()

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

Member Function Documentation

◆ run()

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

◆ enableOutput()

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

◆ disableOutput()

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

Definition at line 271 of file ROL_GMRES.hpp.

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

Member Data Documentation

◆ r_

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

Definition at line 67 of file ROL_GMRES.hpp.

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

◆ z_

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

Definition at line 68 of file ROL_GMRES.hpp.

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

◆ w_

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

Definition at line 69 of file ROL_GMRES.hpp.

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

◆ H_

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

Definition at line 71 of file ROL_GMRES.hpp.

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

◆ cs_

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

Definition at line 72 of file ROL_GMRES.hpp.

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

◆ sn_

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

Definition at line 73 of file ROL_GMRES.hpp.

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

◆ s_

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

Definition at line 74 of file ROL_GMRES.hpp.

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

◆ y_

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

Definition at line 75 of file ROL_GMRES.hpp.

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

◆ cnorm_

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

Definition at line 76 of file ROL_GMRES.hpp.

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

◆ res_

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

Definition at line 78 of file ROL_GMRES.hpp.

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

◆ isInitialized_

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

Definition at line 80 of file ROL_GMRES.hpp.

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

◆ useInexact_

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

Definition at line 81 of file ROL_GMRES.hpp.

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

◆ useInitialGuess_

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

Definition at line 82 of file ROL_GMRES.hpp.

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

◆ printIters_

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

◆ outStream_

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

Definition at line 84 of file ROL_GMRES.hpp.

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

◆ lapack_

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

Definition at line 86 of file ROL_GMRES.hpp.

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


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