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

#include <ROL_PrimalDualPreconditioner.hpp>

+ Inheritance diagram for ROL::PrimalDualPreconditioner< Real >:

Public Member Functions

 PrimalDualPreconditioner (const Teuchos::RCP< Objective< Real > > &obj, const Teuchos::RCP< BoundConstraint< Real > > &con, const Teuchos::RCP< Vector< Real > > &x, const Teuchos::RCP< Vector< Real > > &xlam)
 
 PrimalDualPreconditioner (const Teuchos::RCP< Secant< Real > > &secant, const Teuchos::RCP< Objective< Real > > &obj, const Teuchos::RCP< BoundConstraint< Real > > &con, const Teuchos::RCP< Vector< Real > > &x, const Teuchos::RCP< Vector< Real > > &xlam, bool useSecant=true)
 
void apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply preconditioner. 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...
 

Private Attributes

const Teuchos::RCP< Objective< Real > > obj_
 
const Teuchos::RCP< BoundConstraint< Real > > con_
 
const Teuchos::RCP< Vector< Real > > x_
 
const Teuchos::RCP< Vector< Real > > xlam_
 
Teuchos::RCP< Vector< Real > > v_
 
const Teuchos::RCP< Secant< Real > > secant_
 
bool useSecant_
 
Real eps_
 

Detailed Description

template<class Real>
class ROL::PrimalDualPreconditioner< Real >

Definition at line 55 of file ROL_PrimalDualPreconditioner.hpp.

Constructor & Destructor Documentation

template<class Real >
ROL::PrimalDualPreconditioner< Real >::PrimalDualPreconditioner ( const Teuchos::RCP< Objective< Real > > &  obj,
const Teuchos::RCP< BoundConstraint< Real > > &  con,
const Teuchos::RCP< Vector< Real > > &  x,
const Teuchos::RCP< Vector< Real > > &  xlam 
)
inline

Definition at line 72 of file ROL_PrimalDualPreconditioner.hpp.

template<class Real >
ROL::PrimalDualPreconditioner< Real >::PrimalDualPreconditioner ( const Teuchos::RCP< Secant< Real > > &  secant,
const Teuchos::RCP< Objective< Real > > &  obj,
const Teuchos::RCP< BoundConstraint< Real > > &  con,
const Teuchos::RCP< Vector< Real > > &  x,
const Teuchos::RCP< Vector< Real > > &  xlam,
bool  useSecant = true 
)
inline

Definition at line 81 of file ROL_PrimalDualPreconditioner.hpp.

Member Function Documentation

template<class Real >
void ROL::PrimalDualPreconditioner< Real >::apply ( Vector< Real > &  Hv,
const Vector< Real > &  v,
Real &  tol 
) const
inlinevirtual

Apply preconditioner.

This function applies the preconditioner to a vector.

Parameters
[out]Hvis the output vector.
[in]vis the input vector.
[in]tolis a tolerance for inexact Hessian application.

Implements ROL::LinearOperator< Real >.

Definition at line 98 of file ROL_PrimalDualPreconditioner.hpp.

Member Data Documentation

template<class Real >
const Teuchos::RCP<Objective<Real> > ROL::PrimalDualPreconditioner< Real >::obj_
private

Definition at line 58 of file ROL_PrimalDualPreconditioner.hpp.

template<class Real >
const Teuchos::RCP<BoundConstraint<Real> > ROL::PrimalDualPreconditioner< Real >::con_
private

Definition at line 59 of file ROL_PrimalDualPreconditioner.hpp.

template<class Real >
const Teuchos::RCP<Vector<Real> > ROL::PrimalDualPreconditioner< Real >::x_
private

Definition at line 60 of file ROL_PrimalDualPreconditioner.hpp.

template<class Real >
const Teuchos::RCP<Vector<Real> > ROL::PrimalDualPreconditioner< Real >::xlam_
private

Definition at line 61 of file ROL_PrimalDualPreconditioner.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::PrimalDualPreconditioner< Real >::v_
private

Definition at line 62 of file ROL_PrimalDualPreconditioner.hpp.

template<class Real >
const Teuchos::RCP<Secant<Real> > ROL::PrimalDualPreconditioner< Real >::secant_
private

Definition at line 64 of file ROL_PrimalDualPreconditioner.hpp.

template<class Real >
bool ROL::PrimalDualPreconditioner< Real >::useSecant_
private

Definition at line 66 of file ROL_PrimalDualPreconditioner.hpp.

template<class Real >
Real ROL::PrimalDualPreconditioner< Real >::eps_
private

Definition at line 68 of file ROL_PrimalDualPreconditioner.hpp.


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