Thyra::ScaledAdjointLinearOpBase< Scalar > Class Template Reference

Base class for LinearOpBase decorator subclasses that wrap a LinearOpBase object and adds on an extra scaling factor and/or a new transpose enum. More...

#include <Thyra_ScaledAdjointLinearOpBaseDecl.hpp>

Inheritance diagram for Thyra::ScaledAdjointLinearOpBase< Scalar >:

[legend]List of all members.

Pure virtual functions to be overridden in subclasses
virtual Scalar	overallScalar () const =0
	Return the overall scale factor.
virtual EOpTransp	overallTransp () const =0
	Return the overall transpose (adjoint) enum.
virtual Teuchos::RCP< LinearOpBase< Scalar > >	getNonconstOrigOp ()=0
	Return the non-const original linear operator origOp.
virtual Teuchos::RCP< const LinearOpBase< Scalar > >	getOrigOp () const =0
	Return the const original linear operator origOp.

---

Detailed Description

template<class Scalar>
class Thyra::ScaledAdjointLinearOpBase< Scalar >

Base class for LinearOpBase decorator subclasses that wrap a LinearOpBase object and adds on an extra scaling factor and/or a new transpose enum.

This interface class represents a scaled, adjointed (transposed) linear operator M of the form:

  M = scalar * op(Op)

where Op is another LinearOpBase object, scalar is a Scalar, and the operation op(Op) is specified by a EOpTransp and is given as op(Op) = Op (NOTRANS), or op(Op) = Op^T (TRANS), or op(Op) = Op^H (CONJTRANS).

Definition at line 58 of file Thyra_ScaledAdjointLinearOpBaseDecl.hpp.

---

Member Function Documentation

template<class Scalar>

virtual Scalar Thyra::ScaledAdjointLinearOpBase< Scalar >::overallScalar

(

)

const [pure virtual]

Return the overall scale factor.

template<class Scalar>

virtual EOpTransp Thyra::ScaledAdjointLinearOpBase< Scalar >::overallTransp

(

)

const [pure virtual]

Return the overall transpose (adjoint) enum.

template<class Scalar>

virtual Teuchos::RCP<LinearOpBase<Scalar> > Thyra::ScaledAdjointLinearOpBase< Scalar >::getNonconstOrigOp

(

)

[pure virtual]

Return the non-const original linear operator origOp.

Note that *this is only guaranteed to be fully modified once the returned RCP goes away.

template<class Scalar>

virtual Teuchos::RCP<const LinearOpBase<Scalar> > Thyra::ScaledAdjointLinearOpBase< Scalar >::getOrigOp

(

)

const [pure virtual]

Return the const original linear operator origOp.

---

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

• Thyra_ScaledAdjointLinearOpBaseDecl.hpp

---