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

Represents a identity linear operator M = I. More...

#include <Thyra_DefaultIdentityLinearOpDecl.hpp>

Inheritance diagram for Thyra::DefaultIdentityLinearOp< Scalar >:

[legend]
List of all members.

Constructors/initializers/accessors

 DefaultIdentityLinearOp ()
 Constructs to uninitialized.
 DefaultIdentityLinearOp (const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &space)
void initialize (const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &space)
 Initialize given a list of non-const linear operators.
void uninitialize ()
 Set to uninitialized.

Overridden from LinearOpBase

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

Overridden from Teuchos::Describable

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

Overridden from SingleScalarLinearOpBase

bool opSupported (ETransp M_trans) const
 Returns true .
void apply (const ETransp 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::RefCountPtr< const
LinearOpBase< Scalar > > 
identity (const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &space)
 Create an identity linear operator with given a vector space.

Detailed Description

template<class Scalar>
class Thyra::DefaultIdentityLinearOp< Scalar >

Represents a identity linear operator M = I.

This class implements:


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

 =>

 y = alpha*x + beta*y

 

Definition at line 56 of file Thyra_DefaultIdentityLinearOpDecl.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Thyra::DefaultIdentityLinearOp< Scalar >::DefaultIdentityLinearOp  ) 
 

Constructs to uninitialized.

Postconditions:

Definition at line 41 of file Thyra_DefaultIdentityLinearOp.hpp.

template<class Scalar>
Thyra::DefaultIdentityLinearOp< Scalar >::DefaultIdentityLinearOp const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &  space  ) 
 

Calls initialize().

Definition at line 45 of file Thyra_DefaultIdentityLinearOp.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::DefaultIdentityLinearOp< Scalar >::initialize const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &  space  ) 
 

Initialize given a list of non-const linear operators.

Parameters:
range [in] Range vector space.
range [in] Domain vector space.
Preconditions:
  • range.get()!=NULL
  • domain.get()!=NULL

Postconditions:

Definition at line 53 of file Thyra_DefaultIdentityLinearOp.hpp.

template<class Scalar>
void Thyra::DefaultIdentityLinearOp< Scalar >::uninitialize  ) 
 

Set to uninitialized.

Postconditions:

Definition at line 61 of file Thyra_DefaultIdentityLinearOp.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > Thyra::DefaultIdentityLinearOp< Scalar >::range  )  const
 

Returns Teuchos::null if uninitialized.

Definition at line 70 of file Thyra_DefaultIdentityLinearOp.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > Thyra::DefaultIdentityLinearOp< Scalar >::domain  )  const
 

Returns Teuchos::null if uninitialized.

Definition at line 77 of file Thyra_DefaultIdentityLinearOp.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const LinearOpBase< Scalar > > Thyra::DefaultIdentityLinearOp< Scalar >::clone  )  const
 

Definition at line 84 of file Thyra_DefaultIdentityLinearOp.hpp.

template<class Scalar>
std::string Thyra::DefaultIdentityLinearOp< Scalar >::description  )  const
 

Prints just the name DefaultIdentityLinearOp along with the overall dimensions.

Definition at line 95 of file Thyra_DefaultIdentityLinearOp.hpp.

template<class Scalar>
bool Thyra::DefaultIdentityLinearOp< Scalar >::opSupported ETransp  M_trans  )  const [protected, virtual]
 

Returns true .

Implements Thyra::SingleScalarLinearOpBase< Scalar >.

Definition at line 111 of file Thyra_DefaultIdentityLinearOp.hpp.

template<class Scalar>
void Thyra::DefaultIdentityLinearOp< Scalar >::apply const ETransp  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 117 of file Thyra_DefaultIdentityLinearOp.hpp.


Friends And Related Function Documentation

template<class Scalar>
Teuchos::RefCountPtr< const LinearOpBase< Scalar > > identity const Teuchos::RefCountPtr< const VectorSpaceBase< Scalar > > &  space  )  [related]
 

Create an identity linear operator with given a vector space.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:32:33 2008 for Thyra Operator/Vector Support by doxygen 1.3.9.1