Thyra::DefaultZeroLinearOp< Scalar > Class Template Reference
[Development of linear Abstract Numerical Algorithms (ANAs) (Client Support)]

Represents a zero linear operator M = 0. More...

#include <Thyra_DefaultZeroLinearOp_decl.hpp>

Inheritance diagram for Thyra::DefaultZeroLinearOp< Scalar >:

Inheritance graph
[legend]
List of all members.

Constructors/initializers/accessors

 DefaultZeroLinearOp ()
 Construct to uninitialized.
 DefaultZeroLinearOp (const RCP< const VectorSpaceBase< Scalar > > &range, const RCP< const VectorSpaceBase< Scalar > > &domain)
void initialize (const RCP< const VectorSpaceBase< Scalar > > &range, const RCP< const VectorSpaceBase< Scalar > > &domain)
 Initialize given a list of non-const linear operators.
void uninitialize ()
 Set to uninitialized.

Overridden from LinearOpBase

RCP< const VectorSpaceBase<
Scalar > > 
range () const
 Returns Teuchos::null if uninitialized.
RCP< const VectorSpaceBase<
Scalar > > 
domain () const
 Returns Teuchos::null if uninitialized.
RCP< const LinearOpBase< Scalar > > clone () const
 

Overridden from Teuchos::Describable

std::string description () const
 Prints just the name DefaultZeroLinearOp along with the overall dimensions.

Overridden from LinearOpBase

bool opSupportedImpl (EOpTransp M_trans) const
 Returns true .
void applyImpl (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
 

Related Functions

(Note that these are not member functions.)

RCP< const LinearOpBase< Scalar > > zero (const RCP< const VectorSpaceBase< Scalar > > &range, const RCP< const VectorSpaceBase< Scalar > > &domain)
 Create a zero linear operator with given range and domain spaces.

Detailed Description

template<class Scalar>
class Thyra::DefaultZeroLinearOp< Scalar >

Represents a zero linear operator M = 0.

This class implements:

 y = alpha*op(M)*x + beta*y

 =>

 y = beta*y

 

Definition at line 56 of file Thyra_DefaultZeroLinearOp_decl.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Thyra::DefaultZeroLinearOp< Scalar >::DefaultZeroLinearOp (  ) 

Construct to uninitialized.

Postconditions:

Definition at line 44 of file Thyra_DefaultZeroLinearOp_def.hpp.

template<class Scalar>
Thyra::DefaultZeroLinearOp< Scalar >::DefaultZeroLinearOp ( const RCP< const VectorSpaceBase< Scalar > > &  range,
const RCP< const VectorSpaceBase< Scalar > > &  domain 
)

Calls initialize().

Definition at line 49 of file Thyra_DefaultZeroLinearOp_def.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::DefaultZeroLinearOp< Scalar >::initialize ( const RCP< const VectorSpaceBase< Scalar > > &  range,
const RCP< const VectorSpaceBase< Scalar > > &  domain 
)

Initialize given a list of non-const linear operators.

Parameters:
range [in] Range vector space.
range [in] Domain vector space.
Preconditions:

Postconditions:

Definition at line 59 of file Thyra_DefaultZeroLinearOp_def.hpp.

template<class Scalar>
void Thyra::DefaultZeroLinearOp< Scalar >::uninitialize (  ) 

Set to uninitialized.

Postconditions:

Definition at line 70 of file Thyra_DefaultZeroLinearOp_def.hpp.

template<class Scalar>
RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultZeroLinearOp< Scalar >::range (  )  const [virtual]

Returns Teuchos::null if uninitialized.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 82 of file Thyra_DefaultZeroLinearOp_def.hpp.

template<class Scalar>
RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultZeroLinearOp< Scalar >::domain (  )  const [virtual]

Returns Teuchos::null if uninitialized.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 90 of file Thyra_DefaultZeroLinearOp_def.hpp.

template<class Scalar>
RCP< const LinearOpBase< Scalar > > Thyra::DefaultZeroLinearOp< Scalar >::clone (  )  const [virtual]

Reimplemented from Thyra::LinearOpBase< Scalar >.

Definition at line 98 of file Thyra_DefaultZeroLinearOp_def.hpp.

template<class Scalar>
std::string Thyra::DefaultZeroLinearOp< Scalar >::description (  )  const [virtual]

Prints just the name DefaultZeroLinearOp along with the overall dimensions.

Reimplemented from Teuchos::Describable.

Definition at line 111 of file Thyra_DefaultZeroLinearOp_def.hpp.

template<class Scalar>
bool Thyra::DefaultZeroLinearOp< Scalar >::opSupportedImpl ( EOpTransp  M_trans  )  const [protected, virtual]

Returns true .

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 131 of file Thyra_DefaultZeroLinearOp_def.hpp.

template<class Scalar>
void Thyra::DefaultZeroLinearOp< Scalar >::applyImpl ( const EOpTransp  M_trans,
const MultiVectorBase< Scalar > &  X,
const Ptr< MultiVectorBase< Scalar > > &  Y,
const Scalar  alpha,
const Scalar  beta 
) const [protected, virtual]

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 138 of file Thyra_DefaultZeroLinearOp_def.hpp.


Friends And Related Function Documentation

template<class Scalar>
RCP< const LinearOpBase< Scalar > > zero ( const RCP< const VectorSpaceBase< Scalar > > &  range,
const RCP< const VectorSpaceBase< Scalar > > &  domain 
) [related]

Create a zero linear operator with given range and domain spaces.

Definition at line 160 of file Thyra_DefaultZeroLinearOp_def.hpp.


The documentation for this class was generated from the following files:
Generated on Tue Jul 13 09:26:36 2010 for Thyra by  doxygen 1.4.7