ROL::BlockOperator2Determinant< Real > Class Template Reference

Provides the interface to the block determinant of a 2x2 block operator

More...

#include <ROL_BlockOperator2Determinant.hpp>

Inheritance diagram for ROL::BlockOperator2Determinant< Real >:

Public Member Functions
	BlockOperator2Determinant (ROL::Ptr< OP > &A, ROL::Ptr< OP > &B, ROL::Ptr< OP > &C, ROL::Ptr< OP > &D, ROL::Ptr< V > &scratch)
virtual void	update (const Vector< Real > &x, bool flag=true, int iter=-1)
	Update linear operator. More...
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	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 Types
typedef Vector< Real >	V
typedef LinearOperator< Real >	OP

Private Attributes
ROL::Ptr< OP >	A_
ROL::Ptr< OP >	B_
ROL::Ptr< OP >	C_
ROL::Ptr< OP >	D_
ROL::Ptr< V >	scratch_

Detailed Description

template<class Real>
class ROL::BlockOperator2Determinant< Real >

Provides the interface to the block determinant of a 2x2 block operator

Definition at line 25 of file ROL_BlockOperator2Determinant.hpp.

Member Typedef Documentation

template<class Real >

typedef Vector<Real> ROL::BlockOperator2Determinant< Real >::V

private

Definition at line 27 of file ROL_BlockOperator2Determinant.hpp.

template<class Real >

typedef LinearOperator<Real> ROL::BlockOperator2Determinant< Real >::OP

private

Definition at line 28 of file ROL_BlockOperator2Determinant.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::BlockOperator2Determinant< Real >::BlockOperator2Determinant ( ROL::Ptr< OP > &  A, ROL::Ptr< OP > &  B, ROL::Ptr< OP > &  C, ROL::Ptr< OP > &  D, ROL::Ptr< V > &  scratch  )

inline

Definition at line 37 of file ROL_BlockOperator2Determinant.hpp.

Member Function Documentation

template<class Real >

virtual void ROL::BlockOperator2Determinant< Real >::update ( const Vector< Real > &  x, bool  flag = true, int  iter = -1  )

inlinevirtual

Update linear operator.

This function updates the linear operator at new iterations.

Parameters

[in]	x	is the new iterate.
[in]	flag	is true if the iterate has changed.
[in]	iter	is the outer algorithm iterations count.

Reimplemented from ROL::LinearOperator< Real >.

Definition at line 45 of file ROL_BlockOperator2Determinant.hpp.

References ROL::BlockOperator2Determinant< Real >::A_, ROL::BlockOperator2Determinant< Real >::B_, ROL::BlockOperator2Determinant< Real >::C_, and ROL::BlockOperator2Determinant< Real >::D_.

template<class Real >

virtual void ROL::BlockOperator2Determinant< 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 53 of file ROL_BlockOperator2Determinant.hpp.

References ROL::BlockOperator2Determinant< Real >::A_, ROL::Vector< Real >::axpy(), ROL::BlockOperator2Determinant< Real >::B_, ROL::BlockOperator2Determinant< Real >::C_, ROL::BlockOperator2Determinant< Real >::D_, and ROL::BlockOperator2Determinant< Real >::scratch_.

template<class Real >

virtual void ROL::BlockOperator2Determinant< 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 61 of file ROL_BlockOperator2Determinant.hpp.

Member Data Documentation

template<class Real >

ROL::Ptr<OP> ROL::BlockOperator2Determinant< Real >::A_

private

Definition at line 32 of file ROL_BlockOperator2Determinant.hpp.

Referenced by ROL::BlockOperator2Determinant< Real >::apply(), and ROL::BlockOperator2Determinant< Real >::update().

template<class Real >

ROL::Ptr<OP> ROL::BlockOperator2Determinant< Real >::B_

private

Definition at line 32 of file ROL_BlockOperator2Determinant.hpp.

Referenced by ROL::BlockOperator2Determinant< Real >::apply(), and ROL::BlockOperator2Determinant< Real >::update().

template<class Real >

ROL::Ptr<OP> ROL::BlockOperator2Determinant< Real >::C_

private

Definition at line 32 of file ROL_BlockOperator2Determinant.hpp.

Referenced by ROL::BlockOperator2Determinant< Real >::apply(), and ROL::BlockOperator2Determinant< Real >::update().

template<class Real >

ROL::Ptr<OP> ROL::BlockOperator2Determinant< Real >::D_

private

Definition at line 32 of file ROL_BlockOperator2Determinant.hpp.

Referenced by ROL::BlockOperator2Determinant< Real >::apply(), and ROL::BlockOperator2Determinant< Real >::update().

template<class Real >

ROL::Ptr<V> ROL::BlockOperator2Determinant< Real >::scratch_

private

Definition at line 33 of file ROL_BlockOperator2Determinant.hpp.

Referenced by ROL::BlockOperator2Determinant< Real >::apply().

---

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

• ROL_BlockOperator2Determinant.hpp