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

ROL

Implements a preconditioner for the augmented system. More...

#include <ROL_AugmentedSystemPrecOperator.hpp>

Inheritance diagram for ROL::AugmentedSystemPrecOperator< Real >:

Public Member Functions
virtual	~AugmentedSystemPrecOperator ()
	AugmentedSystemPrecOperator (const Ptr< Constraint< Real > > &con, const Ptr< const Vector< Real > > &x)
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_

Detailed Description

template<class Real>
class ROL::AugmentedSystemPrecOperator< Real >

Implements a preconditioner for the augmented system.

Definition at line 26 of file ROL_AugmentedSystemPrecOperator.hpp.

Constructor & Destructor Documentation

◆ ~AugmentedSystemPrecOperator()

template<class Real>

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

inlinevirtual

Definition at line 32 of file ROL_AugmentedSystemPrecOperator.hpp.

◆ AugmentedSystemPrecOperator()

template<class Real>

ROL::AugmentedSystemPrecOperator< Real >::AugmentedSystemPrecOperator	(	const Ptr< Constraint< Real > > &	con,
		const Ptr< const Vector< Real > > &	x )

inline

Definition at line 33 of file ROL_AugmentedSystemPrecOperator.hpp.

References con_, and x_.

Member Function Documentation

◆ apply()

template<class Real>

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

inline

Definition at line 37 of file ROL_AugmentedSystemPrecOperator.hpp.

◆ applyAdjoint()

template<class Real>

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

inline

Definition at line 41 of file ROL_AugmentedSystemPrecOperator.hpp.

◆ applyInverse()

template<class Real>

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

inline

Definition at line 45 of file ROL_AugmentedSystemPrecOperator.hpp.

References con_, ROL::PartitionedVector< Real >::get(), ROL::PartitionedVector< Real >::set(), x_, and zero.

Referenced by applyAdjointInverse().

◆ applyAdjointInverse()

template<class Real>

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

inline

Definition at line 55 of file ROL_AugmentedSystemPrecOperator.hpp.

References applyInverse().

Member Data Documentation

◆ con_

template<class Real>

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

private

Definition at line 28 of file ROL_AugmentedSystemPrecOperator.hpp.

Referenced by applyInverse(), and AugmentedSystemPrecOperator().

◆ x_

template<class Real>

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

private

Definition at line 29 of file ROL_AugmentedSystemPrecOperator.hpp.

Referenced by applyInverse(), and AugmentedSystemPrecOperator().

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

ROL_AugmentedSystemPrecOperator.hpp