ROL: ROL::AugmentedSystemOperator< Real > Class Template Reference

ROL

Apply the augmented system operator. More...

#include <ROL_AugmentedSystemOperator.hpp>

Inheritance diagram for ROL::AugmentedSystemOperator< Real >:

Public Member Functions
virtual	~AugmentedSystemOperator ()
	AugmentedSystemOperator (const Ptr< Constraint< Real > > &con, const Ptr< const Vector< Real > > &x, const Real delta=0.0)
void	apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
void	applyAdjoint (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
void	applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
void	applyAdjointInverse (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 Ptr< Constraint< Real > >	con_
const Ptr< const Vector< Real > >	x_
const Real	delta_

Detailed Description

template<class Real>
class ROL::AugmentedSystemOperator< Real >

Apply the augmented system operator.

Definition at line 26 of file ROL_AugmentedSystemOperator.hpp.

Constructor & Destructor Documentation

◆ ~AugmentedSystemOperator()

template<class Real>

virtual ROL::AugmentedSystemOperator< Real >::~AugmentedSystemOperator ( )

inlinevirtual

Definition at line 33 of file ROL_AugmentedSystemOperator.hpp.

◆ AugmentedSystemOperator()

template<class Real>

ROL::AugmentedSystemOperator< Real >::AugmentedSystemOperator	(	const Ptr< Constraint< Real > > &	con,
		const Ptr< const Vector< Real > > &	x,
		const Real	delta = 0.0 )

inline

Definition at line 34 of file ROL_AugmentedSystemOperator.hpp.

References con_, delta_, and x_.

Member Function Documentation

◆ apply()

template<class Real>

void ROL::AugmentedSystemOperator< Real >::apply	(	Vector< Real > &	Hv,
		const Vector< Real > &	v,
		Real &	tol ) const

inline

Definition at line 39 of file ROL_AugmentedSystemOperator.hpp.

References con_, delta_, ROL::PartitionedVector< Real >::dual(), ROL::PartitionedVector< Real >::get(), and x_.

Referenced by applyAdjoint().

◆ applyAdjoint()

template<class Real>

void ROL::AugmentedSystemOperator< Real >::applyAdjoint	(	Vector< Real > &	Hv,
		const Vector< Real > &	v,
		Real &	tol ) const

inline

Definition at line 55 of file ROL_AugmentedSystemOperator.hpp.

References apply().

◆ applyInverse()

template<class Real>

void ROL::AugmentedSystemOperator< Real >::applyInverse	(	Vector< Real > &	Hv,
		const Vector< Real > &	v,
		Real &	tol ) const

inline

Definition at line 59 of file ROL_AugmentedSystemOperator.hpp.

◆ applyAdjointInverse()

template<class Real>

void ROL::AugmentedSystemOperator< Real >::applyAdjointInverse	(	Vector< Real > &	Hv,
		const Vector< Real > &	v,
		Real &	tol ) const

inline

Definition at line 63 of file ROL_AugmentedSystemOperator.hpp.

Member Data Documentation

◆ con_

template<class Real>

const Ptr<Constraint<Real> > ROL::AugmentedSystemOperator< Real >::con_

private

Definition at line 28 of file ROL_AugmentedSystemOperator.hpp.

Referenced by apply(), and AugmentedSystemOperator().

◆ x_

template<class Real>

const Ptr<const Vector<Real> > ROL::AugmentedSystemOperator< Real >::x_

private

Definition at line 29 of file ROL_AugmentedSystemOperator.hpp.

Referenced by apply(), and AugmentedSystemOperator().

◆ delta_

template<class Real>

const Real ROL::AugmentedSystemOperator< Real >::delta_

private

Definition at line 30 of file ROL_AugmentedSystemOperator.hpp.

Referenced by apply(), and AugmentedSystemOperator().

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

ROL_AugmentedSystemOperator.hpp