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)
 
 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 Attributes

Real absTol_
 
Real relTol_
 
unsigned maxit_
 

Detailed Description

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

Provides definitions for Krylov solvers.

Definition at line 58 of file ROL_Krylov.hpp.

Constructor & Destructor Documentation

◆ ~Krylov()

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

Definition at line 65 of file ROL_Krylov.hpp.

◆ Krylov() [1/2]

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

Definition at line 67 of file ROL_Krylov.hpp.

References absTol_, maxit_, and relTol_.

Referenced by ROL::ConjugateGradients< Real >::ConjugateGradients(), ROL::ConjugateResiduals< Real >::ConjugateResiduals(), ROL::GMRES< Real >::GMRES(), and ROL::details::MINRES< Real >::MINRES().

◆ Krylov() [2/2]

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

Definition at line 70 of file ROL_Krylov.hpp.

References absTol_, maxit_, and relTol_.

Member Function Documentation

◆ run()

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

Implemented in ROL::ConjugateGradients< Real >, ROL::ConjugateResiduals< Real >, ROL::details::MINRES< Real >, and ROL::GMRES< Real >.

◆ resetAbsoluteTolerance()

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

Definition at line 82 of file ROL_Krylov.hpp.

References absTol_.

◆ resetRelativeTolerance()

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

Definition at line 85 of file ROL_Krylov.hpp.

References relTol_.

◆ resetMaximumIteration()

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

Definition at line 88 of file ROL_Krylov.hpp.

References maxit_.

◆ getAbsoluteTolerance()

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

Definition at line 91 of file ROL_Krylov.hpp.

References absTol_.

Referenced by ROL::ConjugateGradients< Real >::run(), ROL::ConjugateResiduals< Real >::run(), ROL::details::MINRES< Real >::run(), and ROL::GMRES< Real >::run().

◆ getRelativeTolerance()

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

Definition at line 94 of file ROL_Krylov.hpp.

References relTol_.

Referenced by ROL::ConjugateGradients< Real >::run(), ROL::ConjugateResiduals< Real >::run(), ROL::details::MINRES< Real >::run(), and ROL::GMRES< Real >::run().

◆ getMaximumIteration()

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

Definition at line 97 of file ROL_Krylov.hpp.

References maxit_.

Referenced by ROL::GMRES< Real >::GMRES(), ROL::ConjugateGradients< Real >::run(), ROL::ConjugateResiduals< Real >::run(), ROL::details::MINRES< Real >::run(), and ROL::GMRES< Real >::run().

Member Data Documentation

◆ absTol_

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

Definition at line 60 of file ROL_Krylov.hpp.

Referenced by getAbsoluteTolerance(), Krylov(), Krylov(), and resetAbsoluteTolerance().

◆ relTol_

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

Definition at line 61 of file ROL_Krylov.hpp.

Referenced by getRelativeTolerance(), Krylov(), Krylov(), and resetRelativeTolerance().

◆ maxit_

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

Definition at line 62 of file ROL_Krylov.hpp.

Referenced by getMaximumIteration(), Krylov(), Krylov(), and resetMaximumIteration().

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