Thyra  Version of the Day
Related Functions | List of all members

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

#include <Thyra_DefaultIdentityLinearOp_decl.hpp>

Inheritance diagram for Thyra::DefaultIdentityLinearOp< Scalar >:
Inheritance graph
[legend]

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP< const LinearOpBase< Scalar > > identity (const RCP< const VectorSpaceBase< Scalar > > &space, const std::string &label="")
 Create an identity linear operator with given a vector space. More...
 

Constructors/initializers/accessors

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

Overridden from LinearOpBase

RCP< const VectorSpaceBase< Scalar > > range () const
 Returns Teuchos::null if uninitialized. More...
 
RCP< const VectorSpaceBase< Scalar > > domain () const
 Returns Teuchos::null if uninitialized. More...
 
RCP< const LinearOpBase< Scalar > > clone () const
 
bool opSupportedImpl (EOpTransp M_trans) const
 Returns true . 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 DefaultIdentityLinearOp along with the overall dimensions. More...
 

Additional Inherited Members

- Public Member Functions inherited from Thyra::LinearOpBase< Scalar >
bool opSupported (EOpTransp M_trans) const
 Return if the M_trans operation of apply() is supported or not. More...
 
void apply (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
 Apply the linear operator to a multi-vector : Y = alpha*op(M)*X + beta*Y. More...
 
- Protected Member Functions inherited from Thyra::LinearOpBase< Scalar >

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 67 of file Thyra_DefaultIdentityLinearOp_decl.hpp.

Constructor & Destructor Documentation

◆ DefaultIdentityLinearOp() [1/2]

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

Constructs to uninitialized.

Postconditions:

Definition at line 57 of file Thyra_DefaultIdentityLinearOp_def.hpp.

◆ DefaultIdentityLinearOp() [2/2]

template<class Scalar >
Thyra::DefaultIdentityLinearOp< Scalar >::DefaultIdentityLinearOp ( const RCP< const VectorSpaceBase< Scalar > > &  space)

Calls initialize().

Member Function Documentation

◆ initialize()

template<class Scalar >
void Thyra::DefaultIdentityLinearOp< Scalar >::initialize ( const RCP< 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 71 of file Thyra_DefaultIdentityLinearOp_def.hpp.

◆ uninitialize()

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

Set to uninitialized.

Postconditions:

Definition at line 80 of file Thyra_DefaultIdentityLinearOp_def.hpp.

◆ range()

template<class Scalar >
Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultIdentityLinearOp< Scalar >::range ( ) const
virtual

Returns Teuchos::null if uninitialized.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 91 of file Thyra_DefaultIdentityLinearOp_def.hpp.

◆ domain()

template<class Scalar >
Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultIdentityLinearOp< Scalar >::domain ( ) const
virtual

Returns Teuchos::null if uninitialized.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 99 of file Thyra_DefaultIdentityLinearOp_def.hpp.

◆ clone()

template<class Scalar >
Teuchos::RCP< const LinearOpBase< Scalar > > Thyra::DefaultIdentityLinearOp< Scalar >::clone ( ) const
virtual

Reimplemented from Thyra::LinearOpBase< Scalar >.

Definition at line 107 of file Thyra_DefaultIdentityLinearOp_def.hpp.

◆ description()

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

Prints just the name DefaultIdentityLinearOp along with the overall dimensions.

Definition at line 120 of file Thyra_DefaultIdentityLinearOp_def.hpp.

◆ opSupportedImpl()

template<class Scalar >
bool Thyra::DefaultIdentityLinearOp< Scalar >::opSupportedImpl ( EOpTransp  M_trans) const
protectedvirtual

Returns true .

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 139 of file Thyra_DefaultIdentityLinearOp_def.hpp.

◆ applyImpl()

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

Friends And Related Function Documentation

◆ identity()

template<class Scalar >
RCP< const LinearOpBase< Scalar > > identity ( const RCP< const VectorSpaceBase< Scalar > > &  space,
const std::string &  label = "" 
)
related

Create an identity linear operator with given a vector space.


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