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

#include <Thyra_DefaultIdentityLinearOp_decl.hpp>

Inheritance diagram for Thyra::DefaultIdentityLinearOp< Scalar >:

[legend]

Related Symbols
(Note that these are not member symbols.)
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.

Related Symbols 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.

template<class Scalar >
bool	isPartiallyInitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Partially Initialized" state or not.

template<class Scalar >
bool	isFullyInitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Fully Initialized" state or not.

template<class Scalar >
bool	opSupported (const LinearOpBase< Scalar > &M, EOpTransp M_trans)
	Determines if an operation is supported for a single scalar type.

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(...)`.

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>(...)`.

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

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

Constructors/initializers/accessors
	DefaultIdentityLinearOp ()
	Constructs to uninitialized.

	DefaultIdentityLinearOp (const RCP< const VectorSpaceBase< Scalar > > &space)

void	initialize (const RCP< const VectorSpaceBase< Scalar > > &space)
	Initialize given a list of non-const linear operators.

void	uninitialize ()
	Set to uninitialized.

Overridden from Teuchos::Describable
std::string	description () const
	Prints just the name `DefaultIdentityLinearOp` along with the overall dimensions.

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.

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 = alphaop(M)X + beta*Y`.

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

Constructor & Destructor Documentation

◆ DefaultIdentityLinearOp() [1/2]

template<class Scalar >

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

Constructs to uninitialized.

Postconditions:

this->range().get()==NULL

Definition at line 25 of file Thyra_DefaultIdentityLinearOp_def.hpp.

◆ DefaultIdentityLinearOp() [2/2]

template<class Scalar >

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

Calls initialize().

Definition at line 30 of file Thyra_DefaultIdentityLinearOp_def.hpp.

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:

this->range().get()==range.get()
this->domain().get()==domain.get()

Definition at line 39 of file Thyra_DefaultIdentityLinearOp_def.hpp.

◆ uninitialize()

template<class Scalar >

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

Set to uninitialized.

Postconditions:

this->range().get()==NULL

Definition at line 48 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 59 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 67 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 75 of file Thyra_DefaultIdentityLinearOp_def.hpp.

◆ description()

template<class Scalar >

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

virtual

Prints just the name DefaultIdentityLinearOp along with the overall dimensions.

Reimplemented from Teuchos::Describable.

Definition at line 88 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 107 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

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 114 of file Thyra_DefaultIdentityLinearOp_def.hpp.

Friends And Related Symbol Documentation

◆ identity()

template<class Scalar >

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

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

Related Symbols

Overridden from LinearOpBase

Constructors/initializers/accessors

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DefaultIdentityLinearOp() [1/2]

◆ DefaultIdentityLinearOp() [2/2]

Member Function Documentation

◆ initialize()

◆ uninitialize()

◆ range()

◆ domain()

◆ clone()

◆ description()

◆ opSupportedImpl()

◆ applyImpl()

Friends And Related Symbol Documentation

◆ identity()