ROL
Public Member Functions | Private Attributes | List of all members
ROL::Krylov< Real > Class Template Referenceabstract

Provides definitions for Krylov solvers. More...

#include <ROL_Krylov.hpp>

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

Public Member Functions

virtual ~Krylov (void)
 
 Krylov (Real absTol=1.e-4, Real relTol=1.e-2, unsigned maxit=100)
 
virtual void run (Vector< Real > &x, LinearOperator< Real > &A, const Vector< Real > &b, LinearOperator< Real > &M, int &iter, int &flag)=0
 
void resetAbsoluteTolerance (const Real absTol) const
 
void resetRelativeTolerance (const Real relTol) const
 
void resetMaximumIteration (const unsigned maxit)
 
Real getAbsoluteTolerance (void) const
 
Real getRelativeTolerance (void) const
 
unsigned getMaximumIteration (void) const
 

Private Attributes

Real absTol_
 
Real relTol_
 
unsigned maxit_
 

Detailed Description

template<class Real>
class ROL::Krylov< Real >

Provides definitions for Krylov solvers.

Definition at line 57 of file ROL_Krylov.hpp.

Constructor & Destructor Documentation

template<class Real >
virtual ROL::Krylov< Real >::~Krylov ( void  )
inlinevirtual

Definition at line 64 of file ROL_Krylov.hpp.

template<class Real >
ROL::Krylov< Real >::Krylov ( Real  absTol = 1.e-4,
Real  relTol = 1.e-2,
unsigned  maxit = 100 
)
inline

Definition at line 66 of file ROL_Krylov.hpp.

References ROL::Krylov< Real >::run().

Member Function Documentation

template<class Real >
virtual void ROL::Krylov< Real >::run ( Vector< Real > &  x,
LinearOperator< Real > &  A,
const Vector< Real > &  b,
LinearOperator< Real > &  M,
int &  iter,
int &  flag 
)
pure virtual
template<class Real >
void ROL::Krylov< Real >::resetAbsoluteTolerance ( const Real  absTol) const
inline

Definition at line 73 of file ROL_Krylov.hpp.

template<class Real >
void ROL::Krylov< Real >::resetRelativeTolerance ( const Real  relTol) const
inline

Definition at line 76 of file ROL_Krylov.hpp.

template<class Real >
void ROL::Krylov< Real >::resetMaximumIteration ( const unsigned  maxit)
inline

Definition at line 79 of file ROL_Krylov.hpp.

template<class Real >
Real ROL::Krylov< Real >::getAbsoluteTolerance ( void  ) const
inline

Definition at line 82 of file ROL_Krylov.hpp.

References ROL::Krylov< Real >::absTol_.

template<class Real >
Real ROL::Krylov< Real >::getRelativeTolerance ( void  ) const
inline

Definition at line 85 of file ROL_Krylov.hpp.

References ROL::Krylov< Real >::relTol_.

template<class Real >
unsigned ROL::Krylov< Real >::getMaximumIteration ( void  ) const
inline

Definition at line 88 of file ROL_Krylov.hpp.

References ROL::Krylov< Real >::maxit_.

Member Data Documentation

template<class Real >
Real ROL::Krylov< Real >::absTol_
private

Definition at line 59 of file ROL_Krylov.hpp.

Referenced by ROL::Krylov< Real >::getAbsoluteTolerance().

template<class Real >
Real ROL::Krylov< Real >::relTol_
private

Definition at line 60 of file ROL_Krylov.hpp.

Referenced by ROL::Krylov< Real >::getRelativeTolerance().

template<class Real >
unsigned ROL::Krylov< Real >::maxit_
private

Definition at line 61 of file ROL_Krylov.hpp.

Referenced by ROL::Krylov< Real >::getMaximumIteration().


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