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

ROL

A simple wrapper which allows application of constraint Jacobians through the LinearOperator interface. More...

#include <ROL_LinearOperatorFromEqualityConstraint.hpp>

Inheritance diagram for ROL::LinearOperatorFromEqualityConstraint< Real >:

Public Member Functions
	LinearOperatorFromEqualityConstraint (const Teuchos::RCP< const Vector< Real > > &x, const Teuchos::RCP< EqualityConstraint< Real > > &con)

virtual	~LinearOperatorFromEqualityConstraint ()

virtual void	apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply linear operator. More...

virtual void	applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply inverse of linear operator. 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	applyAdjoint (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply adjoint of linear operator. More...

virtual void	applyAdjointInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply adjoint of the inverse linear operator. More...

Private Attributes
const Teuchos::RCP< const Vector< Real > >	x_

Teuchos::RCP< EqualityConstraint< Real > >	con_

Detailed Description

template<class Real>
class ROL::LinearOperatorFromEqualityConstraint< Real >

A simple wrapper which allows application of constraint Jacobians through the LinearOperator interface.

Definition at line 63 of file ROL_LinearOperatorFromEqualityConstraint.hpp.

Constructor & Destructor Documentation

◆ LinearOperatorFromEqualityConstraint()

template<class Real >

ROL::LinearOperatorFromEqualityConstraint< Real >::LinearOperatorFromEqualityConstraint	(	const Teuchos::RCP< const Vector< Real > > &	x,
		const Teuchos::RCP< EqualityConstraint< Real > > &	con
	)

inline

Definition at line 71 of file ROL_LinearOperatorFromEqualityConstraint.hpp.

◆ ~LinearOperatorFromEqualityConstraint()

template<class Real >

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

inlinevirtual

Definition at line 76 of file ROL_LinearOperatorFromEqualityConstraint.hpp.

Member Function Documentation

◆ apply()

template<class Real >

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

inlinevirtual

Apply linear operator.

This function applies the linear operator to a vector.

Parameters

[out]	Hv	is the output vector.
[in]	v	is the input vector.
[in]	tol	is a tolerance for inexact linear operator application.

Implements ROL::LinearOperator< Real >.

Definition at line 78 of file ROL_LinearOperatorFromEqualityConstraint.hpp.

◆ applyInverse()

template<class Real >

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

inlinevirtual

Apply inverse of linear operator.

This function applies the inverse of linear operator to a vector.

Parameters

[out]	Hv	is the output vector.
[in]	v	is the input vector.
[in]	tol	is a tolerance for inexact linear operator application.

Reimplemented from ROL::LinearOperator< Real >.

Definition at line 83 of file ROL_LinearOperatorFromEqualityConstraint.hpp.

References ROL::Vector< Real >::set().

Member Data Documentation

◆ x_

template<class Real >

const Teuchos::RCP<const Vector<Real> > ROL::LinearOperatorFromEqualityConstraint< Real >::x_

private

Definition at line 65 of file ROL_LinearOperatorFromEqualityConstraint.hpp.

◆ con_

template<class Real >

Teuchos::RCP<EqualityConstraint<Real> > ROL::LinearOperatorFromEqualityConstraint< Real >::con_

private

Definition at line 66 of file ROL_LinearOperatorFromEqualityConstraint.hpp.

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

ROL_LinearOperatorFromEqualityConstraint.hpp