Thyra::BlockedLinearOpBase< Scalar > Class Template Reference

Base interface for linear operators that can be accessed as sub-blocks. More...

#include <Thyra_BlockedLinearOpBase.hpp>

Inheritance diagram for Thyra::BlockedLinearOpBase< Scalar >:

[legend]List of all members.

Public Member Functions
virtual Teuchos::RCP< const ProductVectorSpaceBase< Scalar > >	productRange () const =0
	Return the product space for the range.
virtual Teuchos::RCP< const ProductVectorSpaceBase< Scalar > >	productDomain () const =0
	Return the product space for the domain.
virtual bool	blockExists (const int i, const int j) const =0
	Return if the block (i,j) exists or not.
virtual bool	blockIsConst (const int i, const int j) const =0
	Return if the block (i,j) is const only or not.
virtual Teuchos::RCP< LinearOpBase< Scalar > >	getNonconstBlock (const int i, const int j)=0
	Return a non-const view of the block (i,j) if it exists.
virtual Teuchos::RCP< const LinearOpBase< Scalar > >	getBlock (const int i, const int j) const =0
	Return a const view of the block (i,j) if it exists.

---

Detailed Description

template<class Scalar>
class Thyra::BlockedLinearOpBase< Scalar >

Base interface for linear operators that can be accessed as sub-blocks.

ToDo: Finish Documentation.

Definition at line 50 of file Thyra_BlockedLinearOpBase.hpp.

---

Member Function Documentation

template<class Scalar>

virtual Teuchos::RCP<const ProductVectorSpaceBase<Scalar> > Thyra::BlockedLinearOpBase< Scalar >::productRange

(

)

const [pure virtual]

Return the product space for the range.

A return value of return.get()==NULL is an indication that *this is not fully initialized.

template<class Scalar>

virtual Teuchos::RCP<const ProductVectorSpaceBase<Scalar> > Thyra::BlockedLinearOpBase< Scalar >::productDomain

(

)

const [pure virtual]

Return the product space for the domain.

A return value of return.get()==NULL is an indication that *this is not fully initialized.

template<class Scalar>

virtual bool Thyra::BlockedLinearOpBase< Scalar >::blockExists	(	const int	i,
		const int	j
	)			const [pure virtual]

Return if the block (i,j) exists or not.

Parameters:

	i	[in] Zero-based index for the block row.
	j	[in] Zero-based index for the block column.

Preconditions:

• 0 <= i && i < this->productRange()->numBlocks()
• 0 <= j && j < this->productDomain()->numBlocks()

template<class Scalar>

virtual bool Thyra::BlockedLinearOpBase< Scalar >::blockIsConst	(	const int	i,
		const int	j
	)			const [pure virtual]

Return if the block (i,j) is const only or not.

Parameters:

	i	[in] Zero-based index for the block row.
	j	[in] Zero-based index for the block column.

Preconditions:

• 0 <= i && i < this->productRange()->numBlocks()
• 0 <= j && j < this->productDomain()->numBlocks()

template<class Scalar>

virtual Teuchos::RCP<LinearOpBase<Scalar> > Thyra::BlockedLinearOpBase< Scalar >::getNonconstBlock	(	const int	i,
		const int	j
	)			[pure virtual]

Return a non-const view of the block (i,j) if it exists.

Parameters:

	i	[in] Zero-based index for the block row.
	j	[in] Zero-based index for the block column.

Preconditions:

• this->blockIsConst(i,j)==false
• 0 <= i && i < this->productRange()->numBlocks()
• 0 <= j && j < this->productDomain()->numBlocks()

Postconditions:

• [this->blockExists(i,j)==true] return.get()!=NULL
• [this->blockExists(i,j)==false] return.get()==NULL

template<class Scalar>

virtual Teuchos::RCP<const LinearOpBase<Scalar> > Thyra::BlockedLinearOpBase< Scalar >::getBlock	(	const int	i,
		const int	j
	)			const [pure virtual]

Return a const view of the block (i,j) if it exists.

Parameters:

	i	[in] Zero-based index for the block row.
	j	[in] Zero-based index for the block column.

Preconditions:

• 0 <= i && i < this->productRange()->numBlocks()
• 0 <= j && j < this->productDomain()->numBlocks()

Postconditions:

• [this->blockExists(i,j)==true] return.get()!=NULL
• [this->blockExists(i,j)==false] return.get()==NULL

---

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

• Thyra_BlockedLinearOpBase.hpp

---