ROL
Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
ROL::SemismoothNewtonProjection< Real > Class Template Reference

#include <ROL_SemismoothNewtonProjection.hpp>

Inheritance diagram for ROL::SemismoothNewtonProjection< Real >:

Classes

class  Jacobian
class  Precond

Public Member Functions

 SemismoothNewtonProjection (const Vector< Real > &xprim, const Vector< Real > &xdual, const Ptr< BoundConstraint< Real > > &bnd, const Ptr< Constraint< Real > > &con, const Vector< Real > &mul, const Vector< Real > &res)
 SemismoothNewtonProjection (const Vector< Real > &xprim, const Vector< Real > &xdual, const Ptr< BoundConstraint< Real > > &bnd, const Ptr< Constraint< Real > > &con, const Vector< Real > &mul, const Vector< Real > &res, ParameterList &list)
void project (Vector< Real > &x, std::ostream &stream=std::cout) override
Public Member Functions inherited from ROL::PolyhedralProjection< Real >
virtual ~PolyhedralProjection ()
 PolyhedralProjection (const Ptr< BoundConstraint< Real > > &bnd)
 PolyhedralProjection (const Vector< Real > &xprim, const Vector< Real > &xdual, const Ptr< BoundConstraint< Real > > &bnd, const Ptr< Constraint< Real > > &con, const Vector< Real > &mul, const Vector< Real > &res)
const Ptr< Constraint< Real > > getLinearConstraint (void) const
const Ptr< BoundConstraint< Real > > getBoundConstraint (void) const
const Ptr< Vector< Real > > getMultiplier (void) const
const Ptr< Vector< Real > > getResidual (void) const

Private Member Functions

Real residual (Vector< Real > &r, const Vector< Real > &y) const
void solve_newton_system (Vector< Real > &s, const Vector< Real > &r, const Vector< Real > &y, const Real mu, const Real rho, int &iter, int &flag) const
void update_primal (Vector< Real > &y, const Vector< Real > &x, const Vector< Real > &lam) const
void project_ssn (Vector< Real > &x, Vector< Real > &lam, Vector< Real > &dlam, std::ostream &stream=std::cout) const
Real compute_tolerance () const

Private Attributes

int dim_
Ptr< Krylov< Real > > krylov_
Ptr< Vector< Real > > xnew_
Ptr< Vector< Real > > lnew_
Ptr< Vector< Real > > dlam_
Real DEFAULT_atol_
Real DEFAULT_rtol_
Real DEFAULT_stol_
Real DEFAULT_decr_
Real DEFAULT_factor_
Real DEFAULT_regscale_
Real DEFAULT_errscale_
int DEFAULT_maxit_
int DEFAULT_lstype_
int DEFAULT_verbosity_
bool DEFAULT_useproj_
Real atol_
Real rtol_
Real stol_
Real decr_
Real factor_
Real regscale_
Real errscale_
Real ctol_
int maxit_
int lstype_
int verbosity_
bool useproj_

Additional Inherited Members

Protected Attributes inherited from ROL::PolyhedralProjection< Real >
const Ptr< BoundConstraint< Real > > bnd_
const Ptr< Constraint< Real > > con_
Ptr< Vector< Real > > xprim_
Ptr< Vector< Real > > xdual_
Ptr< Vector< Real > > mul_
Ptr< Vector< Real > > res_

Detailed Description

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

Definition at line 20 of file ROL_SemismoothNewtonProjection.hpp.

Constructor & Destructor Documentation

◆ SemismoothNewtonProjection() [1/2]

template<typename Real>
ROL::SemismoothNewtonProjection< Real >::SemismoothNewtonProjection ( const Vector< Real > & xprim,
const Vector< Real > & xdual,
const Ptr< BoundConstraint< Real > > & bnd,
const Ptr< Constraint< Real > > & con,
const Vector< Real > & mul,
const Vector< Real > & res )

Definition at line 16 of file ROL_SemismoothNewtonProjection_Def.hpp.

References atol_, ROL::Vector< Real >::clone(), compute_tolerance(), ctol_, decr_, DEFAULT_atol_, DEFAULT_decr_, DEFAULT_errscale_, DEFAULT_factor_, DEFAULT_lstype_, DEFAULT_maxit_, DEFAULT_regscale_, DEFAULT_rtol_, DEFAULT_stol_, DEFAULT_useproj_, DEFAULT_verbosity_, dim_, ROL::Vector< Real >::dimension(), dlam_, errscale_, factor_, krylov_, ROL::KrylovFactory(), lnew_, lstype_, maxit_, ROL::PolyhedralProjection< Real >::PolyhedralProjection(), regscale_, ROL::ROL_EPSILON(), rtol_, stol_, useproj_, verbosity_, and xnew_.

◆ SemismoothNewtonProjection() [2/2]

template<typename Real>
ROL::SemismoothNewtonProjection< Real >::SemismoothNewtonProjection ( const Vector< Real > & xprim,
const Vector< Real > & xdual,
const Ptr< BoundConstraint< Real > > & bnd,
const Ptr< Constraint< Real > > & con,
const Vector< Real > & mul,
const Vector< Real > & res,
ParameterList & list )

Definition at line 62 of file ROL_SemismoothNewtonProjection_Def.hpp.

References atol_, ROL::Vector< Real >::clone(), compute_tolerance(), ctol_, decr_, DEFAULT_atol_, DEFAULT_decr_, DEFAULT_errscale_, DEFAULT_factor_, DEFAULT_lstype_, DEFAULT_maxit_, DEFAULT_regscale_, DEFAULT_rtol_, DEFAULT_stol_, DEFAULT_useproj_, DEFAULT_verbosity_, dim_, ROL::Vector< Real >::dimension(), dlam_, errscale_, factor_, krylov_, ROL::KrylovFactory(), lnew_, lstype_, maxit_, ROL::PolyhedralProjection< Real >::PolyhedralProjection(), regscale_, ROL::ROL_EPSILON(), rtol_, stol_, useproj_, verbosity_, and xnew_.

Member Function Documentation

◆ project()

template<typename Real>
void ROL::SemismoothNewtonProjection< Real >::project ( Vector< Real > & x,
std::ostream & stream = std::cout )
overridevirtual

Reimplemented from ROL::PolyhedralProjection< Real >.

Definition at line 119 of file ROL_SemismoothNewtonProjection_Def.hpp.

References ROL::PolyhedralProjection< Real >::bnd_, ROL::PolyhedralProjection< Real >::con_, dlam_, ROL::PolyhedralProjection< Real >::mul_, and project_ssn().

◆ residual()

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::residual ( Vector< Real > & r,
const Vector< Real > & y ) const
private

Definition at line 129 of file ROL_SemismoothNewtonProjection_Def.hpp.

References ROL::PolyhedralProjection< Real >::con_, ROL::Vector< Real >::norm(), ROL::ROL_EPSILON(), and ROL::Temp.

Referenced by compute_tolerance(), and project_ssn().

◆ solve_newton_system()

template<typename Real>
void ROL::SemismoothNewtonProjection< Real >::solve_newton_system ( Vector< Real > & s,
const Vector< Real > & r,
const Vector< Real > & y,
const Real mu,
const Real rho,
int & iter,
int & flag ) const
private

Definition at line 137 of file ROL_SemismoothNewtonProjection_Def.hpp.

References ROL::PolyhedralProjection< Real >::bnd_, ROL::PolyhedralProjection< Real >::con_, krylov_, ROL::PolyhedralProjection< Real >::xdual_, and ROL::PolyhedralProjection< Real >::xprim_.

Referenced by project_ssn().

◆ update_primal()

template<typename Real>
void ROL::SemismoothNewtonProjection< Real >::update_primal ( Vector< Real > & y,
const Vector< Real > & x,
const Vector< Real > & lam ) const
private

Definition at line 150 of file ROL_SemismoothNewtonProjection_Def.hpp.

References ROL::PolyhedralProjection< Real >::bnd_, ROL::PolyhedralProjection< Real >::con_, ROL::Vector< Real >::plus(), ROL::ROL_EPSILON(), ROL::Vector< Real >::set(), ROL::Temp, and ROL::PolyhedralProjection< Real >::xdual_.

Referenced by project_ssn().

◆ project_ssn()

template<typename Real>
void ROL::SemismoothNewtonProjection< Real >::project_ssn ( Vector< Real > & x,
Vector< Real > & lam,
Vector< Real > & dlam,
std::ostream & stream = std::cout ) const
private

Definition at line 162 of file ROL_SemismoothNewtonProjection_Def.hpp.

References ROL::Vector< Real >::apply(), ROL::Vector< Real >::axpy(), ctol_, decr_, ROL::Vector< Real >::dot(), errscale_, factor_, lnew_, lstype_, maxit_, regscale_, ROL::PolyhedralProjection< Real >::res_, residual(), ROL::Vector< Real >::set(), solve_newton_system(), stol_, update_primal(), useproj_, verbosity_, xnew_, and zero.

Referenced by project().

◆ compute_tolerance()

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::compute_tolerance ( ) const
private

Definition at line 260 of file ROL_SemismoothNewtonProjection_Def.hpp.

References atol_, ROL::PolyhedralProjection< Real >::bnd_, ROL::PolyhedralProjection< Real >::res_, residual(), ROL::ROL_INF(), and rtol_.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

Member Data Documentation

◆ dim_

template<typename Real>
int ROL::SemismoothNewtonProjection< Real >::dim_
private

Definition at line 22 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ krylov_

template<typename Real>
Ptr<Krylov<Real> > ROL::SemismoothNewtonProjection< Real >::krylov_
private

Definition at line 23 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), SemismoothNewtonProjection(), and solve_newton_system().

◆ xnew_

template<typename Real>
Ptr<Vector<Real> > ROL::SemismoothNewtonProjection< Real >::xnew_
private

Definition at line 24 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ lnew_

template<typename Real>
Ptr<Vector<Real> > ROL::SemismoothNewtonProjection< Real >::lnew_
private

Definition at line 24 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ dlam_

template<typename Real>
Ptr<Vector<Real> > ROL::SemismoothNewtonProjection< Real >::dlam_
private

Definition at line 24 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ DEFAULT_atol_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::DEFAULT_atol_
private

Definition at line 26 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ DEFAULT_rtol_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::DEFAULT_rtol_
private

Definition at line 26 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ DEFAULT_stol_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::DEFAULT_stol_
private

Definition at line 26 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ DEFAULT_decr_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::DEFAULT_decr_
private

Definition at line 27 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ DEFAULT_factor_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::DEFAULT_factor_
private

Definition at line 27 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ DEFAULT_regscale_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::DEFAULT_regscale_
private

Definition at line 27 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ DEFAULT_errscale_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::DEFAULT_errscale_
private

Definition at line 27 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ DEFAULT_maxit_

template<typename Real>
int ROL::SemismoothNewtonProjection< Real >::DEFAULT_maxit_
private

Definition at line 28 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ DEFAULT_lstype_

template<typename Real>
int ROL::SemismoothNewtonProjection< Real >::DEFAULT_lstype_
private

Definition at line 28 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ DEFAULT_verbosity_

template<typename Real>
int ROL::SemismoothNewtonProjection< Real >::DEFAULT_verbosity_
private

Definition at line 28 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ DEFAULT_useproj_

template<typename Real>
bool ROL::SemismoothNewtonProjection< Real >::DEFAULT_useproj_
private

Definition at line 29 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ atol_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::atol_
private

Definition at line 31 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by compute_tolerance(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ rtol_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::rtol_
private

Definition at line 31 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by compute_tolerance(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ stol_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::stol_
private

Definition at line 31 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ decr_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::decr_
private

Definition at line 31 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ factor_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::factor_
private

Definition at line 31 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ regscale_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::regscale_
private

Definition at line 31 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ errscale_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::errscale_
private

Definition at line 31 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ ctol_

template<typename Real>
Real ROL::SemismoothNewtonProjection< Real >::ctol_
private

Definition at line 31 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ maxit_

template<typename Real>
int ROL::SemismoothNewtonProjection< Real >::maxit_
private

Definition at line 32 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ lstype_

template<typename Real>
int ROL::SemismoothNewtonProjection< Real >::lstype_
private

Definition at line 32 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ verbosity_

template<typename Real>
int ROL::SemismoothNewtonProjection< Real >::verbosity_
private

Definition at line 32 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

◆ useproj_

template<typename Real>
bool ROL::SemismoothNewtonProjection< Real >::useproj_
private

Definition at line 33 of file ROL_SemismoothNewtonProjection.hpp.

Referenced by project_ssn(), SemismoothNewtonProjection(), and SemismoothNewtonProjection().

The documentation for this class was generated from the following files:
Generated by doxygen 1.15.0