ROL
Public Member Functions | Private Attributes | List of all members
ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK Class Reference
+ Inheritance diagram for ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK:

Public Member Functions

 PrecondPNK (const ROL::Ptr< Objective< Real > > &obj, const ROL::Ptr< BoundConstraint< Real > > &bnd, const ROL::Ptr< Vector< Real > > &x, const ROL::Ptr< Vector< Real > > &g, Real eps=0)
 
 PrecondPNK (const ROL::Ptr< Secant< Real > > &secant, const ROL::Ptr< BoundConstraint< Real > > &bnd, const ROL::Ptr< Vector< Real > > &x, const ROL::Ptr< Vector< Real > > &g, Real eps=0)
 
void apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply linear operator.
 
void applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply inverse of linear operator.
 
- 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.
 
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< Secant< Real > > secant_
 
const ROL::Ptr< BoundConstraint< Real > > bnd_
 
const ROL::Ptr< Vector< Real > > x_
 
const ROL::Ptr< Vector< Real > > g_
 
ROL::Ptr< Vector< Real > > v_
 
Real eps_
 
const bool useSecant_
 

Detailed Description

template<class Real>
class ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK

Definition at line 118 of file ROL_ProjectedNewtonKrylovStep.hpp.

Constructor & Destructor Documentation

◆ PrecondPNK() [1/2]

template<class Real >
ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::PrecondPNK ( const ROL::Ptr< Objective< Real > > & obj,
const ROL::Ptr< BoundConstraint< Real > > & bnd,
const ROL::Ptr< Vector< Real > > & x,
const ROL::Ptr< Vector< Real > > & g,
Real eps = 0 )
inline

◆ PrecondPNK() [2/2]

template<class Real >
ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::PrecondPNK ( const ROL::Ptr< Secant< Real > > & secant,
const ROL::Ptr< BoundConstraint< Real > > & bnd,
const ROL::Ptr< Vector< Real > > & x,
const ROL::Ptr< Vector< Real > > & g,
Real eps = 0 )
inline

Member Function Documentation

◆ apply()

template<class Real >
void ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::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]Hvis the output vector.
[in]vis the input vector.
[in]tolis a tolerance for inexact linear operator application.

Implements ROL::LinearOperator< Real >.

Definition at line 145 of file ROL_ProjectedNewtonKrylovStep.hpp.

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

◆ applyInverse()

template<class Real >
void ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::applyInverse ( Vector< Real > & Hv,
const Vector< Real > & v,
Real & tol ) const
inlinevirtual

Member Data Documentation

◆ obj_

template<class Real >
const ROL::Ptr<Objective<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::obj_
private

◆ secant_

template<class Real >
const ROL::Ptr<Secant<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::secant_
private

◆ bnd_

template<class Real >
const ROL::Ptr<BoundConstraint<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::bnd_
private

◆ x_

template<class Real >
const ROL::Ptr<Vector<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::x_
private

◆ g_

template<class Real >
const ROL::Ptr<Vector<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::g_
private

◆ v_

template<class Real >
ROL::Ptr<Vector<Real> > ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::v_
private

◆ eps_

template<class Real >
Real ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::eps_
private

◆ useSecant_

template<class Real >
const bool ROL::ProjectedNewtonKrylovStep< Real >::PrecondPNK::useSecant_
private

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