Node subclass that provides a good default implementation for the describe() function. More...

#include <Thyra_LinearOpDefaultBase_decl.hpp>

Inheritance diagram for Thyra::LinearOpDefaultBase< Scalar >:

Public functions overridden from Teuchos::Describable
std::string	description () const
	Default description that gives the label, type, and dimenstion . More...

void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
	Generates a default outputting for all linear operators. More...

Additional Inherited Members
Public Member Functions inherited from Thyra::LinearOpBase< Scalar >
virtual RCP< const VectorSpaceBase< Scalar > >	range () const =0
	Return a smart pointer for the range space for `this` operator. More...

virtual RCP< const VectorSpaceBase< Scalar > >	domain () const =0
	Return a smart pointer for the domain space for `this` operator. More...

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

virtual RCP< const LinearOpBase< Scalar > >	clone () const
	Clone the linear operator object (if supported). More...

Protected Member Functions inherited from Thyra::LinearOpBase< Scalar >
virtual bool	opSupportedImpl (EOpTransp M_trans) const =0
	Override in subclass. More...

virtual void	applyImpl (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const =0
	Override in subclass. More...

Related Functions 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. More...

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

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

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

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

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

Detailed Description

template<class Scalar>
class Thyra::LinearOpDefaultBase< Scalar >

Node subclass that provides a good default implementation for the describe() function.

Definition at line 55 of file Thyra_LinearOpDefaultBase_decl.hpp.

Member Function Documentation

template<class Scalar >

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

virtual

Default description that gives the label, type, and dimenstion .

Reimplemented from Teuchos::Describable.

Reimplemented in Thyra::SpmdVectorDefaultBase< Scalar >, and Thyra::VectorDefaultBase< Scalar >.

Definition at line 57 of file Thyra_LinearOpDefaultBase_def.hpp.

template<class Scalar >

void Thyra::LinearOpDefaultBase< Scalar >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel
	)		const

virtual

Generates a default outputting for all linear operators.

Calls on the this->description() function for the name of the class (and possibly its instance name) and then if verbLevel >= VERB_EXTREME, then the linear operators elements themselves are printed as well. The format of the output is as follows:

type = 'this->description()', rangeDim = m, domainDim = n
  1:1:a11 1:2:a12 ... 1:n:a1n
  2:1:a21 2:2:a22 ... 1:n:a2n
  .       .           .
  .       .           .
  .       .           .
  m:1:am1 m:2:am2 ... m:n:amn

The above matrix coefficients are with respect to the natural basis as defined by the scalar products.

Before type = 'this->description()' is printed and after each newline, leadingIndent is output. The index:value lines are offset an additional indentSpacer amount. A newline is printed after the last m:n:amn entry.

Reimplemented from Teuchos::Describable.

Reimplemented in Thyra::VectorDefaultBase< Scalar >.

Definition at line 79 of file Thyra_LinearOpDefaultBase_def.hpp.

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

Public functions overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

template<class Scalar> class Thyra::LinearOpDefaultBase< Scalar >

Member Function Documentation

template<class Scalar>
class Thyra::LinearOpDefaultBase< Scalar >