Thyra::DefaultAddedLinearOp< Scalar > Class Template Reference

Concrete composite LinearOpBase subclass that creates an implicitly added linear operator out of one or more constituent LinearOpBase objects. More...

#include <Thyra_DefaultAddedLinearOp_decl.hpp>

Inheritance diagram for Thyra::DefaultAddedLinearOp< Scalar >:

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP< LinearOpBase< Scalar > >	nonconstAdd (const RCP< LinearOpBase< Scalar > > &A, const RCP< LinearOpBase< Scalar > > &B, const std::string &label="")
	Form an implicit addition of two linear operators: M = A + B. More...
template<class Scalar >
RCP< const LinearOpBase< Scalar > >	add (const RCP< const LinearOpBase< Scalar > > &A, const RCP< const LinearOpBase< Scalar > > &B, const std::string &label="")
	Form an implicit addition of two linear operators: M = A + B. More...
template<class Scalar >
RCP< LinearOpBase< Scalar > >	nonconstSubtract (const RCP< LinearOpBase< Scalar > > &A, const RCP< LinearOpBase< Scalar > > &B, const std::string &label="")
	Form an implicit subtraction of two linear operators: M = A - B. More...
template<class Scalar >
RCP< const LinearOpBase< Scalar > >	subtract (const RCP< const LinearOpBase< Scalar > > &A, const RCP< const LinearOpBase< Scalar > > &B, const std::string &label="")
	Form an implicit subtraction of two linear operators: M = A - B. More...
Related Functions inherited from Thyra::LinearOpBase< Scalar >
template<class Scalar >
bool	isFullyUninitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Fully Uninitialized" state or not. More...
template<class Scalar >
bool	isPartiallyInitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Partially Initialized" state or not. More...
template<class Scalar >
bool	isFullyInitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Fully Initialized" state or not. More...
template<class Scalar >
bool	opSupported (const LinearOpBase< Scalar > &M, EOpTransp M_trans)
	Determines if an operation is supported for a single scalar type. More...
template<class Scalar >
void	apply (const LinearOpBase< Scalar > &M, const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha=static_cast< Scalar >(1.0), const Scalar beta=static_cast< Scalar >(0.0))
	Non-member function call for M.apply(...). More...
void	apply (const LinearOpBase< double > &M, const EOpTransp M_trans, const MultiVectorBase< double > &X, const Ptr< MultiVectorBase< double > > &Y, const double alpha=1.0, const double beta=0.0)
	Calls apply<double>(...). More...

Constructors/initializers/accessors
	DefaultAddedLinearOp ()
	Constructs to uninitialized. More...
	DefaultAddedLinearOp (const ArrayView< const RCP< LinearOpBase< Scalar > > > &Ops)
	DefaultAddedLinearOp (const ArrayView< const RCP< const LinearOpBase< Scalar > > > &Ops)
void	initialize (const ArrayView< const RCP< LinearOpBase< Scalar > > > &Ops)
	Initialize given a list of non-const linear operators. More...
void	initialize (const ArrayView< const RCP< const LinearOpBase< Scalar > > > &Ops)
	Initialize given a list of const linear operators. More...
void	uninitialize ()
	Set to uninitialized. More...

Overridden from AddedLinearOpBase
int	numOps () const
bool	opIsConst (const int k) const
RCP< LinearOpBase< Scalar > >	getNonconstOp (const int k)
RCP< const LinearOpBase< Scalar > >	getOp (const int k) const

Overridden from LinearOpBase
RCP< const VectorSpaceBase < Scalar > >	range () const
	Returns this->getOp(0).range() if <t>this->numOps() > 0 and returns Teuchos::null otherwise. More...
RCP< const VectorSpaceBase < Scalar > >	domain () const
	Returns this->getOp(this->numOps()-1).domain() if <t>this->numOps() > 0 and returns Teuchos::null otherwise. More...
RCP< const LinearOpBase< Scalar > >	clone () const
bool	opSupportedImpl (EOpTransp M_trans) const
	Returns true only if all constituent operators support M_trans. More...
void	applyImpl (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const

Overridden from Teuchos::Describable
std::string	description () const
	Prints just the name DefaultAddedLinearOp along with the overall dimensions and the number of constituent operators. More...
void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
	Prints the details about the constituent linear operators. More...

Detailed Description

template<class Scalar>
class Thyra::DefaultAddedLinearOp< Scalar >

Concrete composite LinearOpBase subclass that creates an implicitly added linear operator out of one or more constituent LinearOpBase objects.

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

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

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

In other words, this class defines apply() as:

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

Rather than calling the constructor directly, consider using the non-member helper functions described here.

Definition at line 53 of file Thyra_DefaultAddedLinearOp_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Thyra::DefaultAddedLinearOp< Scalar >::DefaultAddedLinearOp

(

)

Constructs to uninitialized.

Postconditions:

• this->numOps()==0

Definition at line 63 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

Thyra::DefaultAddedLinearOp< Scalar >::DefaultAddedLinearOp

(

const ArrayView< const RCP< LinearOpBase< Scalar > > > &

Ops

)

Calls initialize().

Rather than calling this constructor directly, consider using the non-member helper functions described here.

Definition at line 68 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

Thyra::DefaultAddedLinearOp< Scalar >::DefaultAddedLinearOp

(

const ArrayView< const RCP< const LinearOpBase< Scalar > > > &

Ops

)

Calls initialize().

Rather than calling this constructor directly, consider using the non-member helper functions described here.

Definition at line 76 of file Thyra_DefaultAddedLinearOp_def.hpp.

Member Function Documentation

template<class Scalar >

void Thyra::DefaultAddedLinearOp< Scalar >::initialize

(

const ArrayView< const RCP< LinearOpBase< Scalar > > > &

Ops

)

Initialize given a list of non-const linear operators.

Parameters

Ops	[in] Array (length numOps) of constituent linear operators and their aggregated default definitions of the non-transposed operator.

Preconditions:

• numOps > 0
• Ops != NULL
• Ops[k].op().get()!=NULL, for k=0...numOps-1

Postconditions:

• this->numOps()==numOps
• this->getOp(k).op().get()==Ops[k].op().get(), for k=0...numOps-1

Definition at line 84 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

void Thyra::DefaultAddedLinearOp< Scalar >::initialize

(

const ArrayView< const RCP< const LinearOpBase< Scalar > > > &

Ops

)

Initialize given a list of const linear operators.

Parameters

numOps	[in] Number of constituent operators.
Ops	[in] Array (length numOps) of constituent linear operators and their aggregated default definitions of the non-transposed operator.

Preconditions:

• numOps > 0
• Ops != NULL
• Ops[k].op().get()!=NULL, for k=0...numOps-1

Postconditions:

• this->numOps()==numOps
• this->getOp(k).op().get()==Ops[k].op().get(), for k=0...numOps-1

Definition at line 97 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

void Thyra::DefaultAddedLinearOp< Scalar >::uninitialize

(

)

Set to uninitialized.

Postconditions:

• this->numOps()==0

Definition at line 110 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

int Thyra::DefaultAddedLinearOp< Scalar >::numOps ( ) const

virtual

Implements Thyra::AddedLinearOpBase< Scalar >.

Definition at line 121 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

bool Thyra::DefaultAddedLinearOp< Scalar >::opIsConst ( const int  k ) const

virtual

Implements Thyra::AddedLinearOpBase< Scalar >.

Definition at line 128 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

Teuchos::RCP< LinearOpBase< Scalar > > Thyra::DefaultAddedLinearOp< Scalar >::getNonconstOp ( const int  k )

virtual

Implements Thyra::AddedLinearOpBase< Scalar >.

Definition at line 139 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

Teuchos::RCP< const LinearOpBase< Scalar > > Thyra::DefaultAddedLinearOp< Scalar >::getOp ( const int  k ) const

virtual

Implements Thyra::AddedLinearOpBase< Scalar >.

Definition at line 150 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultAddedLinearOp< Scalar >::range ( ) const

virtual

Returns this->getOp(0).range() if <t>this->numOps() > 0 and returns Teuchos::null otherwise.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 164 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultAddedLinearOp< Scalar >::domain ( ) const

virtual

Returns this->getOp(this->numOps()-1).domain() if <t>this->numOps() > 0 and returns Teuchos::null otherwise.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 175 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

Teuchos::RCP< const LinearOpBase< Scalar > > Thyra::DefaultAddedLinearOp< Scalar >::clone ( ) const

virtual

Reimplemented from Thyra::LinearOpBase< Scalar >.

Definition at line 186 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

std::string Thyra::DefaultAddedLinearOp< Scalar >::description ( ) const

virtual

Prints just the name DefaultAddedLinearOp along with the overall dimensions and the number of constituent operators.

Reimplemented from Teuchos::Describable.

Definition at line 196 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

void Thyra::DefaultAddedLinearOp< Scalar >::describe ( Teuchos::FancyOStream &  out, const Teuchos::EVerbosityLevel  verbLevel  ) const

virtual

Prints the details about the constituent linear operators.

This function outputs different levels of detail based on the value passed in for verbLevel:

ToDo: Finish documentation!

Reimplemented from Teuchos::Describable.

Definition at line 207 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

bool Thyra::DefaultAddedLinearOp< Scalar >::opSupportedImpl ( EOpTransp  M_trans ) const

protectedvirtual

Returns true only if all constituent operators support M_trans.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 250 of file Thyra_DefaultAddedLinearOp_def.hpp.

template<class Scalar >

void Thyra::DefaultAddedLinearOp< Scalar >::applyImpl ( const EOpTransp  M_trans, const MultiVectorBase< Scalar > &  X, const Ptr< MultiVectorBase< Scalar > > &  Y, const Scalar  alpha, const Scalar  beta  ) const

protectedvirtual

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 261 of file Thyra_DefaultAddedLinearOp_def.hpp.

Friends And Related Function Documentation

template<class Scalar >

RCP< LinearOpBase< Scalar > > nonconstAdd ( const RCP< LinearOpBase< Scalar > > &  A, const RCP< LinearOpBase< Scalar > > &  B, const std::string &  label = ""  )

related

Form an implicit addition of two linear operators: M = A + B.

template<class Scalar >

RCP< const LinearOpBase< Scalar > > add ( const RCP< const LinearOpBase< Scalar > > &  A, const RCP< const LinearOpBase< Scalar > > &  B, const std::string &  label = ""  )

related

Form an implicit addition of two linear operators: M = A + B.

template<class Scalar >

RCP< LinearOpBase< Scalar > > nonconstSubtract ( const RCP< LinearOpBase< Scalar > > &  A, const RCP< LinearOpBase< Scalar > > &  B, const std::string &  label = ""  )

related

Form an implicit subtraction of two linear operators: M = A - B.

template<class Scalar >

RCP< const LinearOpBase< Scalar > > subtract ( const RCP< const LinearOpBase< Scalar > > &  A, const RCP< const LinearOpBase< Scalar > > &  B, const std::string &  label = ""  )

related

Form an implicit subtraction of two linear operators: M = A - B.

---

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

• Thyra_DefaultAddedLinearOp_decl.hpp
• Thyra_DefaultAddedLinearOp_def.hpp