ROL
ROL::NewtonKrylovStep< Real >::PrecondNK Class Reference
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
void applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
Public Member Functions inherited from ROL::ROL::LinearOperator< Real >
virtual ~LinearOperator ()
virtual void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 Update linear operator.
virtual void apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const =0
 Apply linear operator.
virtual void applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply inverse of linear operator.
virtual void applyAdjoint (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply adjoint of linear operator.
virtual void applyAdjointInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply adjoint of the inverse linear operator.

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

◆ PrecondNK()

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.

References obj_, and x_.

Member Function Documentation

◆ apply()

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

◆ applyInverse()

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

Definition at line 76 of file ROL_NewtonKrylovStep.hpp.

References obj_, and x_.

Member Data Documentation

◆ obj_

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 applyInverse(), and PrecondNK().

◆ x_

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 applyInverse(), and PrecondNK().


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