Node subclass that provides a good default implementation for the describe() function.
More...
#include <Thyra_LinearOpDefaultBase_decl.hpp>
Public functions overridden from Teuchos::Describable | |
| std::string | description () const |
| Default description that gives the label, type, and dimenstion . | |
| void | describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const |
| Generates a default outputting for all linear operators. | |
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. | |
| virtual RCP< const VectorSpaceBase< Scalar > > | domain () const =0 |
Return a smart pointer for the domain space for this operator. | |
| 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 = alpha*op(M)*X + beta*Y. | |
| virtual RCP< const LinearOpBase< Scalar > > | clone () const |
| Clone the linear operator object (if supported). | |
| Protected Member Functions inherited from Thyra::LinearOpBase< Scalar > | |
| virtual bool | opSupportedImpl (EOpTransp M_trans) const =0 |
| Override in subclass. | |
| 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. | |
| 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>(...). | |
Detailed Description
class Thyra::LinearOpDefaultBase< Scalar >
Node subclass that provides a good default implementation for the describe() function.
Definition at line 23 of file Thyra_LinearOpDefaultBase_decl.hpp.
Member Function Documentation
◆ description()
|
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 25 of file Thyra_LinearOpDefaultBase_def.hpp.
◆ describe()
|
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 47 of file Thyra_LinearOpDefaultBase_def.hpp.
The documentation for this class was generated from the following files:
