ROL::NewtonKrylovStep< Real >::PrecondNK Class Reference

Inheritance diagram for ROL::NewtonKrylovStep< Real >::PrecondNK:

Public Member Functions
	PrecondNK (const Teuchos::RCP< Objective< Real > > &obj, const Teuchos::RCP< Vector< Real > > &x)
void	apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply linear operator. More...
void	applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply inverse of linear operator. More...
Public Member Functions inherited from ROL::LinearOperator< Real >
virtual	~LinearOperator ()
virtual void	update (const Vector< Real > &x, bool flag=true, int iter=-1)
	Update linear operator. More...
virtual void	applyAdjoint (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply adjoint of linear operator. More...
virtual void	applyAdjointInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply adjoint of the inverse linear operator. More...

Private Attributes
const Teuchos::RCP< Objective< Real > >	obj_
const Teuchos::RCP< Vector< Real > >	x_

Detailed Description

template<class Real>
class ROL::NewtonKrylovStep< Real >::PrecondNK

Definition at line 100 of file ROL_NewtonKrylovStep.hpp.

Constructor & Destructor Documentation

PrecondNK()

template<class Real >

ROL::NewtonKrylovStep< Real >::PrecondNK::PrecondNK ( const Teuchos::RCP< Objective< Real > > &  obj, const Teuchos::RCP< Vector< Real > > &  x  )

inline

Definition at line 105 of file ROL_NewtonKrylovStep.hpp.

Member Function Documentation

apply()

template<class Real >

void ROL::NewtonKrylovStep< Real >::PrecondNK::apply ( Vector< Real > &  Hv, const Vector< Real > &  v, Real &  tol  ) const

inlinevirtual

Apply linear operator.

This function applies the linear operator to a vector.

Parameters

[out]	Hv	is the output vector.
[in]	v	is the input vector.
[in]	tol	is a tolerance for inexact linear operator application.

Implements ROL::LinearOperator< Real >.

Definition at line 107 of file ROL_NewtonKrylovStep.hpp.

References ROL::Vector< Real >::dual(), and ROL::Vector< Real >::set().

applyInverse()

template<class Real >

void ROL::NewtonKrylovStep< Real >::PrecondNK::applyInverse ( Vector< Real > &  Hv, const Vector< Real > &  v, Real &  tol  ) const

inlinevirtual

Apply inverse of linear operator.

This function applies the inverse of linear operator to a vector.

Parameters

[out]	Hv	is the output vector.
[in]	v	is the input vector.
[in]	tol	is a tolerance for inexact linear operator application.

Reimplemented from ROL::LinearOperator< Real >.

Definition at line 110 of file ROL_NewtonKrylovStep.hpp.

Member Data Documentation

obj_

template<class Real >

const Teuchos::RCP<Objective<Real> > ROL::NewtonKrylovStep< Real >::PrecondNK::obj_

private

Definition at line 102 of file ROL_NewtonKrylovStep.hpp.

x_

template<class Real >

const Teuchos::RCP<Vector<Real> > ROL::NewtonKrylovStep< Real >::PrecondNK::x_

private

Definition at line 103 of file ROL_NewtonKrylovStep.hpp.

---

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

• ROL_NewtonKrylovStep.hpp