ROL::Krylov< Real > Class Template Reference

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 (Teuchos::ParameterList &parlist)
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

~Krylov()

template<class Real >

virtual ROL::Krylov< Real >::~Krylov ( void  )

inlinevirtual

Definition at line 64 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 66 of file ROL_Krylov.hpp.

Krylov() [2/2]

template<class Real >

ROL::Krylov< Real >::Krylov ( Teuchos::ParameterList &  parlist )

inline

Definition at line 69 of file ROL_Krylov.hpp.

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

Member Function Documentation

run()

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

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

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

resetAbsoluteTolerance()

template<class Real >

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

inline

Definition at line 80 of file ROL_Krylov.hpp.

resetRelativeTolerance()

template<class Real >

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

inline

Definition at line 83 of file ROL_Krylov.hpp.

resetMaximumIteration()

template<class Real >

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

inline

Definition at line 86 of file ROL_Krylov.hpp.

getAbsoluteTolerance()

template<class Real >

Real ROL::Krylov< Real >::getAbsoluteTolerance ( void  ) const

inline

Definition at line 89 of file ROL_Krylov.hpp.

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

getRelativeTolerance()

template<class Real >

Real ROL::Krylov< Real >::getRelativeTolerance ( void  ) const

inline

Definition at line 92 of file ROL_Krylov.hpp.

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

getMaximumIteration()

template<class Real >

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

inline

Definition at line 95 of file ROL_Krylov.hpp.

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

Member Data Documentation

absTol_

template<class Real >

Real ROL::Krylov< Real >::absTol_

private

Definition at line 59 of file ROL_Krylov.hpp.

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

relTol_

template<class Real >

Real ROL::Krylov< Real >::relTol_

private

Definition at line 60 of file ROL_Krylov.hpp.

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

maxit_

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:

• ROL_Krylov.hpp