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

ROL

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

Public Member Functions
	PrecondNK (const ROL::Ptr< Objective< Real > > &obj, const ROL::Ptr< 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 ROL::Ptr< Objective< Real > >	obj_

const ROL::Ptr< Vector< Real > >	x_

Detailed Description

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

Definition at line 66 of file ROL_NewtonKrylovStep.hpp.

Constructor & Destructor Documentation

template<class Real >

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

inline

Definition at line 71 of file ROL_NewtonKrylovStep.hpp.

Member Function Documentation

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 73 of file ROL_NewtonKrylovStep.hpp.

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

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 76 of file ROL_NewtonKrylovStep.hpp.

References ROL::NewtonKrylovStep< Real >::PrecondNK::obj_, and ROL::NewtonKrylovStep< Real >::PrecondNK::x_.

Member Data Documentation

template<class Real >

const ROL::Ptr<Objective<Real> > ROL::NewtonKrylovStep< Real >::PrecondNK::obj_

private

Definition at line 68 of file ROL_NewtonKrylovStep.hpp.

Referenced by ROL::NewtonKrylovStep< Real >::PrecondNK::applyInverse().

template<class Real >

const ROL::Ptr<Vector<Real> > ROL::NewtonKrylovStep< Real >::PrecondNK::x_

private

Definition at line 69 of file ROL_NewtonKrylovStep.hpp.

Referenced by ROL::NewtonKrylovStep< Real >::PrecondNK::applyInverse().

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

ROL_NewtonKrylovStep.hpp