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

ROL

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)
virtual void	apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
virtual void	applyInverse (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 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.

autotoc_md28

Definition at line 25 of file ROL_BlockOperator2Determinant.hpp.

Member Typedef Documentation

◆ V

template<class Real>

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

private

Definition at line 27 of file ROL_BlockOperator2Determinant.hpp.

◆ OP

template<class Real>

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

private

Definition at line 28 of file ROL_BlockOperator2Determinant.hpp.

Constructor & Destructor Documentation

◆ BlockOperator2Determinant()

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.

References A_, B_, C_, D_, and scratch_.

Member Function Documentation

◆ update()

template<class Real>

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

inlinevirtual

Definition at line 45 of file ROL_BlockOperator2Determinant.hpp.

References A_, B_, C_, and D_.

◆ apply()

template<class Real>

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

inlinevirtual

Definition at line 53 of file ROL_BlockOperator2Determinant.hpp.

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

◆ applyInverse()

template<class Real>

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

inlinevirtual

Definition at line 61 of file ROL_BlockOperator2Determinant.hpp.

Member Data Documentation

◆ A_

template<class Real>

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

private

Definition at line 32 of file ROL_BlockOperator2Determinant.hpp.

Referenced by apply(), BlockOperator2Determinant(), and update().

◆ B_

template<class Real>

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

private

Definition at line 32 of file ROL_BlockOperator2Determinant.hpp.

Referenced by apply(), BlockOperator2Determinant(), and update().

◆ C_

template<class Real>

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

private

Definition at line 32 of file ROL_BlockOperator2Determinant.hpp.

Referenced by apply(), BlockOperator2Determinant(), and update().

◆ D_

template<class Real>

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

private

Definition at line 32 of file ROL_BlockOperator2Determinant.hpp.

Referenced by apply(), BlockOperator2Determinant(), and update().

◆ scratch_

template<class Real>

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

private

Definition at line 33 of file ROL_BlockOperator2Determinant.hpp.

Referenced by apply(), and BlockOperator2Determinant().

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

ROL_BlockOperator2Determinant.hpp