ROL: ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK Class Reference

ROL

Inheritance diagram for ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK:

Public Member Functions
	HessianPNK (const Ptr< Objective< Real >> &obj, const Ptr< BoundConstraint< Real >> &bnd, const Ptr< const Vector< Real >> &x, const Ptr< const Vector< Real >> &g, Real eps, const Ptr< Secant< Real >> &secant, bool useSecant, const Ptr< Vector< Real >> &pwa)

void	apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply 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	applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply inverse of 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 Ptr< Objective< Real > >	obj_

const Ptr< BoundConstraint< Real > >	bnd_

const Ptr< const Vector< Real > >	x_

const Ptr< const Vector< Real > >	g_

const Real	eps_

const Ptr< Secant< Real > >	secant_

const bool	useSecant_

const Ptr< Vector< Real > >	v_

Detailed Description

template<typename Real>
class ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK

Definition at line 86 of file ROL_TypeB_NewtonKrylovAlgorithm.hpp.

Constructor & Destructor Documentation

◆ HessianPNK()

template<typename Real >

ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::HessianPNK	(	const Ptr< Objective< Real >> &	obj,
		const Ptr< BoundConstraint< Real >> &	bnd,
		const Ptr< const Vector< Real >> &	x,
		const Ptr< const Vector< Real >> &	g,
		Real	eps,
		const Ptr< Secant< Real >> &	secant,
		bool	useSecant,
		const Ptr< Vector< Real >> &	pwa
	)

inline

Definition at line 97 of file ROL_TypeB_NewtonKrylovAlgorithm.hpp.

Member Function Documentation

◆ apply()

template<typename Real >

void ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::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_TypeB_NewtonKrylovAlgorithm.hpp.

References ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::bnd_, ROL::Vector< Real >::dual(), ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::eps_, ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::g_, ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::obj_, ROL::Vector< Real >::plus(), ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::secant_, ROL::Vector< Real >::set(), ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::useSecant_, ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::v_, and ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::x_.

Member Data Documentation

◆ obj_

template<typename Real >

const Ptr<Objective<Real> > ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::obj_

private

Definition at line 88 of file ROL_TypeB_NewtonKrylovAlgorithm.hpp.

Referenced by ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::apply().

◆ bnd_

template<typename Real >

const Ptr<BoundConstraint<Real> > ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::bnd_

private

Definition at line 89 of file ROL_TypeB_NewtonKrylovAlgorithm.hpp.

Referenced by ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::apply().

◆ x_

template<typename Real >

const Ptr<const Vector<Real> > ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::x_

private

Definition at line 90 of file ROL_TypeB_NewtonKrylovAlgorithm.hpp.

Referenced by ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::apply().

◆ g_

template<typename Real >

const Ptr<const Vector<Real> > ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::g_

private

Definition at line 91 of file ROL_TypeB_NewtonKrylovAlgorithm.hpp.

Referenced by ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::apply().

◆ eps_

template<typename Real >

const Real ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::eps_

private

Definition at line 92 of file ROL_TypeB_NewtonKrylovAlgorithm.hpp.

Referenced by ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::apply().

◆ secant_

template<typename Real >

const Ptr<Secant<Real> > ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::secant_

private

Definition at line 93 of file ROL_TypeB_NewtonKrylovAlgorithm.hpp.

Referenced by ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::apply().

◆ useSecant_

template<typename Real >

const bool ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::useSecant_

private

Definition at line 94 of file ROL_TypeB_NewtonKrylovAlgorithm.hpp.

Referenced by ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::apply().

◆ v_

template<typename Real >

const Ptr<Vector<Real> > ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::v_

private

Definition at line 95 of file ROL_TypeB_NewtonKrylovAlgorithm.hpp.

Referenced by ROL::TypeB::NewtonKrylovAlgorithm< Real >::HessianPNK::apply().

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

ROL_TypeB_NewtonKrylovAlgorithm.hpp