ROL: ROL::ROL::Krylov< Real > Class Template Reference

ROL

Loading...

Searching...

No Matches

#include <ROL_Constraint_SerialSimOpt.hpp>

Inheritance diagram for ROL::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::ROL::Krylov< Real >

Definition at line 24 of file ROL_Constraint_SerialSimOpt.hpp.

Constructor & Destructor Documentation

◆ ~Krylov()

template<class Real>

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

inlinevirtual

Definition at line 31 of file ROL_Constraint_SerialSimOpt.hpp.

◆ Krylov() [1/2]

template<class Real>

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

inline

Definition at line 33 of file ROL_Constraint_SerialSimOpt.hpp.

Referenced by ROL::BiCGSTAB< Real >::BiCGSTAB(), ROL::BiCGSTAB< Real >::BiCGSTAB(), 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::ROL::Krylov< Real >::Krylov ( ROL::ParameterList & parlist )

inline

Definition at line 36 of file ROL_Constraint_SerialSimOpt.hpp.

Member Function Documentation

◆ run()

template<class Real>

virtual Real ROL::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::ROL::BiCGSTAB< Real >, ROL::ROL::ConjugateGradients< Real >, ROL::ROL::ConjugateResiduals< Real >, ROL::ROL::details::MINRES< Real >, ROL::ROL::GMRES< Real >, and ROL::ROL::MINRES< Real >.

◆ resetAbsoluteTolerance()

template<class Real>

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

inline

Definition at line 48 of file ROL_Constraint_SerialSimOpt.hpp.

◆ resetRelativeTolerance()

template<class Real>

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

inline

Definition at line 51 of file ROL_Constraint_SerialSimOpt.hpp.

◆ resetMaximumIteration()

template<class Real>

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

inline

Definition at line 54 of file ROL_Constraint_SerialSimOpt.hpp.

◆ getAbsoluteTolerance()

template<class Real>

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

inline

Definition at line 57 of file ROL_Constraint_SerialSimOpt.hpp.

◆ getRelativeTolerance()

template<class Real>

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

inline

Definition at line 60 of file ROL_Constraint_SerialSimOpt.hpp.

◆ getMaximumIteration()

template<class Real>

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

inline

Definition at line 63 of file ROL_Constraint_SerialSimOpt.hpp.

Member Data Documentation

◆ absTol_

template<class Real>

Real ROL::ROL::Krylov< Real >::absTol_

private

Definition at line 26 of file ROL_Constraint_SerialSimOpt.hpp.

◆ relTol_

template<class Real>

Real ROL::ROL::Krylov< Real >::relTol_

private

Definition at line 27 of file ROL_Constraint_SerialSimOpt.hpp.

◆ maxit_

template<class Real>

unsigned ROL::ROL::Krylov< Real >::maxit_

private

Definition at line 28 of file ROL_Constraint_SerialSimOpt.hpp.

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

ROL_Constraint_SerialSimOpt.hpp