Provides the interface to compute optimization steps with projected inexact Newton's method using line search. More...

#include <ROL_NewtonKrylov_U.hpp>

Inheritance diagram for ROL::NewtonKrylov_U< Real >:

Classes
class	HessianNK
class	PrecondNK

Public Member Functions
	NewtonKrylov_U (ParameterList &parlist)
	Constructor.
	NewtonKrylov_U (ParameterList &parlist, const Ptr< Krylov< Real > > &krylov, const Ptr< Secant< Real > > &secant, const bool computeObj=true)
	Constructor.
void	compute (Vector< Real > &s, Real &snorm, Real &sdotg, int &iter, int &flag, const Vector< Real > &x, const Vector< Real > &g, Objective< Real > &obj) override
void	update (const Vector< Real > &x, const Vector< Real > &s, const Vector< Real > &gold, const Vector< Real > &gnew, const Real snorm, const int iter) override
std::string	printName (void) const override
Public Member Functions inherited from ROL::DescentDirection_U< Real >
virtual	~DescentDirection_U ()
virtual void	initialize (const Vector< Real > &x, const Vector< Real > &g)

Private Attributes
Ptr< Secant< Real > >	secant_
	Secant object (used for quasi-Newton).
Ptr< Krylov< Real > >	krylov_
	Krylov solver object (used for inexact Newton).
Ptr< LinearOperator< Real > >	precond_
EKrylov	ekv_
ESecant	esec_
bool	useSecantPrecond_
	Whether or not a secant approximation is used for preconditioning inexact Newton.
std::string	krylovName_
std::string	secantName_

Detailed Description

template<typename Real>
class ROL::NewtonKrylov_U< Real >

Provides the interface to compute optimization steps with projected inexact Newton's method using line search.

Definition at line 29 of file ROL_NewtonKrylov_U.hpp.

Constructor & Destructor Documentation

◆ NewtonKrylov_U() [1/2]

template<typename Real>

ROL::NewtonKrylov_U< Real >::NewtonKrylov_U ( ParameterList & parlist )

inline

Constructor.

Standard constructor to build a NewtonKrylovStep object. Algorithmic specifications are passed in through a ROL::ParameterList.

Parameters

[in] parlist is a parameter list containing algorithmic specifications

Definition at line 80 of file ROL_NewtonKrylov_U.hpp.

References ekv_, esec_, krylov_, ROL::KrylovFactory(), krylovName_, precond_, secant_, ROL::SecantFactory(), secantName_, ROL::StringToEKrylov(), ROL::StringToESecant(), and useSecantPrecond_.

◆ NewtonKrylov_U() [2/2]

template<typename Real>

ROL::NewtonKrylov_U< Real >::NewtonKrylov_U	(	ParameterList &	parlist,
		const Ptr< Krylov< Real > > &	krylov,
		const Ptr< Secant< Real > > &	secant,
		const bool	computeObj = true )

inline

Constructor.

Constructor to build a NewtonKrylovStep object with user-defined secant and Krylov objects. Algorithmic specifications are passed in through a ROL::ParameterList.

Parameters

[in]	parlist	is a parameter list containing algorithmic specifications
[in]	krylov	is a user-defined Krylov object
[in]	secant	is a user-defined secant object

Definition at line 108 of file ROL_NewtonKrylov_U.hpp.

References ekv_, esec_, krylov_, ROL::KRYLOV_USERDEFINED, ROL::KrylovFactory(), krylovName_, precond_, secant_, ROL::SECANT_USERDEFINED, ROL::SecantFactory(), secantName_, ROL::StringToEKrylov(), ROL::StringToESecant(), and useSecantPrecond_.

Member Function Documentation

◆ compute()

template<typename Real>

void ROL::NewtonKrylov_U< Real >::compute	(	Vector< Real > &	s,
		Real &	snorm,
		Real &	sdotg,
		int &	iter,
		int &	flag,
		const Vector< Real > &	x,
		const Vector< Real > &	g,
		Objective< Real > &	obj )

inlineoverridevirtual

Implements ROL::DescentDirection_U< Real >.

Definition at line 141 of file ROL_NewtonKrylov_U.hpp.

References ROL::Vector< Real >::apply(), ROL::Vector< Real >::dual(), krylov_, ROL::Vector< Real >::norm(), ROL::Vector< Real >::scale(), ROL::Vector< Real >::set(), and useSecantPrecond_.

◆ update()

template<typename Real>

void ROL::NewtonKrylov_U< Real >::update	(	const Vector< Real > &	x,
		const Vector< Real > &	s,
		const Vector< Real > &	gold,
		const Vector< Real > &	gnew,
		const Real	snorm,
		const int	iter )