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

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

#include <Thyra_DefaultZeroLinearOpDecl.hpp>

Inheritance diagram for Thyra::DefaultZeroLinearOp< Scalar >:

Inheritance graph
[legend]
List of all members.

Constructors/initializers/accessors

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

Overridden from LinearOpBase

Teuchos::RCP< const VectorSpaceBase<
Scalar > > 
range () const
 Returns Teuchos::null if uninitialized.
Teuchos::RCP< const VectorSpaceBase<
Scalar > > 
domain () const
 Returns Teuchos::null if uninitialized.
Teuchos::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 SingleScalarLinearOpBase

bool opSupported (EOpTransp M_trans) const
 Returns true .
void apply (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, MultiVectorBase< Scalar > *Y, const Scalar alpha, const Scalar beta) const
 

Related Functions

(Note that these are not member functions.)

Teuchos::RCP< const LinearOpBase<
Scalar > > 
zero (const Teuchos::RCP< const VectorSpaceBase< Scalar > > &range, const Teuchos::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_DefaultZeroLinearOpDecl.hpp.


Constructor & Destructor Documentation

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

Constructs to uninitialized.

Postconditions:

Definition at line 41 of file Thyra_DefaultZeroLinearOp.hpp.

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

Calls initialize().

Definition at line 45 of file Thyra_DefaultZeroLinearOp.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::DefaultZeroLinearOp< Scalar >::initialize ( const Teuchos::RCP< const VectorSpaceBase< Scalar > > &  range,
const Teuchos::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 54 of file Thyra_DefaultZeroLinearOp.hpp.

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

Set to uninitialized.

Postconditions:

Definition at line 64 of file Thyra_DefaultZeroLinearOp.hpp.

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

Returns Teuchos::null if uninitialized.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 74 of file Thyra_DefaultZeroLinearOp.hpp.

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

Returns Teuchos::null if uninitialized.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 81 of file Thyra_DefaultZeroLinearOp.hpp.

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

Reimplemented from Thyra::LinearOpBase< Scalar >.

Definition at line 88 of file Thyra_DefaultZeroLinearOp.hpp.

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

Prints just the name DefaultZeroLinearOp along with the overall dimensions.

Reimplemented from Thyra::LinearOpDefaultBase< Scalar >.

Definition at line 99 of file Thyra_DefaultZeroLinearOp.hpp.

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

Returns true .

Implements Thyra::SingleScalarLinearOpBase< Scalar >.

Definition at line 116 of file Thyra_DefaultZeroLinearOp.hpp.

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

Implements Thyra::SingleScalarLinearOpBase< Scalar >.

Definition at line 122 of file Thyra_DefaultZeroLinearOp.hpp.


Friends And Related Function Documentation

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

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

Definition at line 142 of file Thyra_DefaultZeroLinearOp.hpp.


The documentation for this class was generated from the following files:
Generated on Wed May 12 21:42:33 2010 for Thyra Operator/Vector Support by  doxygen 1.4.7