ROL::BlockOperator< Real > Class Template Reference

Provides the interface to apply a block operator to a partitioned vector. More...

#include <ROL_BlockOperator.hpp>

Inheritance diagram for ROL::BlockOperator< Real >:

Public Member Functions
	BlockOperator ()
	BlockOperator (const ROL::Ptr< OpVec > &blocks)
virtual void	apply (V &Hv, const V &v, Real &tol) const
	Apply 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	applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
	Apply inverse of 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 Types
typedef Vector< Real >	V
typedef PartitionedVector< Real >	PV
typedef LinearOperator< Real >	OP
typedef std::vector< ROL::Ptr < OP > >	OpVec
typedef OpVec::size_type	uint

Private Attributes
ROL::Ptr< OpVec >	blocks_

Detailed Description

template<class Real>
class ROL::BlockOperator< Real >

Provides the interface to apply a block operator to a partitioned vector.

---

Definition at line 27 of file ROL_BlockOperator.hpp.

Member Typedef Documentation

template<class Real >

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

private

Definition at line 29 of file ROL_BlockOperator.hpp.

template<class Real >

typedef PartitionedVector<Real> ROL::BlockOperator< Real >::PV

private

Definition at line 30 of file ROL_BlockOperator.hpp.

template<class Real >

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

private

Definition at line 31 of file ROL_BlockOperator.hpp.

template<class Real >

typedef std::vector<ROL::Ptr<OP> > ROL::BlockOperator< Real >::OpVec

private

Definition at line 33 of file ROL_BlockOperator.hpp.

template<class Real >

typedef OpVec::size_type ROL::BlockOperator< Real >::uint

private

Definition at line 34 of file ROL_BlockOperator.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::BlockOperator< Real >::BlockOperator ( )

inline

Definition at line 41 of file ROL_BlockOperator.hpp.

template<class Real >

ROL::BlockOperator< Real >::BlockOperator ( const ROL::Ptr< OpVec > &  blocks )

inline

Definition at line 42 of file ROL_BlockOperator.hpp.

Member Function Documentation

template<class Real >

virtual void ROL::BlockOperator< Real >::apply ( V &  Hv, const V &  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 44 of file ROL_BlockOperator.hpp.

References ROL::BlockOperator< Real >::blocks_, ROL::PartitionedVector< Real >::get(), and ROL::PartitionedVector< Real >::numVectors().

Member Data Documentation

template<class Real >

ROL::Ptr<OpVec> ROL::BlockOperator< Real >::blocks_

private

Definition at line 38 of file ROL_BlockOperator.hpp.

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

---

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

• ROL_BlockOperator.hpp