Thyra::AddedLinearOpBase< Scalar > Class Template Reference

Interface class for implicitly added linear operators. More...

#include <Thyra_AddedLinearOpBase.hpp>

Inheritance diagram for Thyra::AddedLinearOpBase< Scalar >:

[legend]List of all members.

Pure virtual functions that must be overridden by subclasses
virtual int	numOps () const =0
	Returns the number of constituent operators.
virtual bool	opIsConst (const int k) const =0
	Determine if the kth constituent operator is const-only or not.
virtual Teuchos::RCP< LinearOpBase< Scalar > >	getNonconstOp (const int k)=0
	Return the kth non-constant constituent operator.
virtual Teuchos::RCP< const LinearOpBase< Scalar > >	getOp (const int k) const =0
	Return the kth constant constituent operator.

---

Detailed Description

template<class Scalar>
class Thyra::AddedLinearOpBase< Scalar >

Interface class for implicitly added linear operators.

This interface represents a added linear operator M of the form:

 M = Op[0] + Op[1] + ... + Op[numOps-1]
 

where Op[] is an array of numOps LinearOpBase objects. Of course the operator M is not constructed explicitly but instead just applies the constituent linear operators accordingly using temporaries.

In other words, subclasses define apply() as:

 y = alpha*M*x + beta*y
   = alpha * ( Op[0] * x + Op[1] * x + ...  + Op[numOps-1] * x ) + beta * y
 

Definition at line 60 of file Thyra_AddedLinearOpBase.hpp.

---

Member Function Documentation

template<class Scalar>

virtual int Thyra::AddedLinearOpBase< Scalar >::numOps

(

)

const [pure virtual]

Returns the number of constituent operators.

A return value of 0 indicates that this is not fully initialized.

template<class Scalar>

virtual bool Thyra::AddedLinearOpBase< Scalar >::opIsConst

(

const int

k

)

const [pure virtual]

Determine if the kth constituent operator is const-only or not.

Parameters:

k

[in] The zero-based index of the constituent operator to return.

Preconditions:

• 0 <= k < this->numOps()

template<class Scalar>

virtual Teuchos::RCP<LinearOpBase<Scalar> > Thyra::AddedLinearOpBase< Scalar >::getNonconstOp

(

const int

k

)

[pure virtual]

Return the kth non-constant constituent operator.

Parameters:

k

[in] The zero-based index of the constituent operator to return.

Preconditions:

• 0 <= k < this->numOps()
• this->opIsConst(k)==false

template<class Scalar>

virtual Teuchos::RCP<const LinearOpBase<Scalar> > Thyra::AddedLinearOpBase< Scalar >::getOp

(

const int

k

)

const [pure virtual]

Return the kth constant constituent operator.

Parameters:

k

[in] The zero-based index of the constituent operator to return.

Preconditions:

• 0 <= k < this->numOps()

---

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

• Thyra_AddedLinearOpBase.hpp

---