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

Provides definitions of the Conjugate Gradient solver. More...

#include <ROL_ConjugateGradients.hpp>

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

Public Member Functions

 ConjugateGradients (Real absTol=1.e-4, Real relTol=1.e-2, unsigned maxit=100, bool useInexact=false)
 
void run (Vector< Real > &x, LinearOperator< Real > &A, const Vector< Real > &b, LinearOperator< Real > &M, int &iter, int &flag)
 
- 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)
 
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

bool isInitialized_
 
bool useInexact_
 
Teuchos::RCP< Vector< Real > > r_
 
Teuchos::RCP< Vector< Real > > v_
 
Teuchos::RCP< Vector< Real > > p_
 
Teuchos::RCP< Vector< Real > > Ap_
 

Detailed Description

template<class Real>
class ROL::ConjugateGradients< Real >

Provides definitions of the Conjugate Gradient solver.

Definition at line 59 of file ROL_ConjugateGradients.hpp.

Constructor & Destructor Documentation

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

Definition at line 69 of file ROL_ConjugateGradients.hpp.

Member Function Documentation

template<class Real >
void ROL::ConjugateGradients< Real >::run ( Vector< Real > &  x,
LinearOperator< Real > &  A,
const Vector< Real > &  b,
LinearOperator< Real > &  M,
int &  iter,
int &  flag 
)
inlinevirtual

Member Data Documentation

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

Definition at line 61 of file ROL_ConjugateGradients.hpp.

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

Definition at line 62 of file ROL_ConjugateGradients.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::ConjugateGradients< Real >::r_
private

Definition at line 63 of file ROL_ConjugateGradients.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::ConjugateGradients< Real >::v_
private

Definition at line 64 of file ROL_ConjugateGradients.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::ConjugateGradients< Real >::p_
private

Definition at line 65 of file ROL_ConjugateGradients.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::ConjugateGradients< Real >::Ap_
private

Definition at line 66 of file ROL_ConjugateGradients.hpp.


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