ROL
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
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< 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 84 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

Definition at line 95 of file ROL_ProjectedNewtonKrylovStep.hpp.

References bnd_, eps_, g_, obj_, useSecant_, v_, and x_.

◆ 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

Definition at line 103 of file ROL_ProjectedNewtonKrylovStep.hpp.

References bnd_, eps_, g_, secant_, useSecant_, v_, and x_.

Member Function Documentation

◆ apply()

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

◆ applyInverse()

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

Member Data Documentation

◆ obj_

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

Definition at line 86 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by applyInverse(), and PrecondPNK().

◆ secant_

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

Definition at line 87 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by applyInverse(), and PrecondPNK().

◆ bnd_

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

Definition at line 88 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by applyInverse(), PrecondPNK(), and PrecondPNK().

◆ x_

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

Definition at line 89 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by applyInverse(), PrecondPNK(), and PrecondPNK().

◆ g_

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

Definition at line 90 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by applyInverse(), PrecondPNK(), and PrecondPNK().

◆ v_

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

Definition at line 91 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by applyInverse(), PrecondPNK(), and PrecondPNK().

◆ eps_

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

Definition at line 92 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by applyInverse(), PrecondPNK(), and PrecondPNK().

◆ useSecant_

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

Definition at line 93 of file ROL_ProjectedNewtonKrylovStep.hpp.

Referenced by applyInverse(), PrecondPNK(), and PrecondPNK().


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