Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Related Functions | List of all members
Thyra::DefaultBlockedLinearOp< Scalar > Class Template Reference
Development of linear Abstract Numerical Algorithms (ANAs) (Client Support)

Concrete composite LinearOpBase subclass that creates single linear operator object out of a set of constituent LinearOpBase blocks. More...

#include <Thyra_DefaultBlockedLinearOp_decl.hpp>

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

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP< DefaultBlockedLinearOp
< Scalar > > 		defaultBlockedLinearOp ()
 Nonmember default constructor. More...
 
template<class Scalar >
Teuchos::RCP< const
LinearOpBase< Scalar > > 		block1x1 (const Teuchos::RCP< const LinearOpBase< Scalar > > &A00, const std::string &label="")
 Form an implicit block 1x1 linear operator [ A00 ]. More...
 
template<class Scalar >
Teuchos::RCP< const
LinearOpBase< Scalar > > 		block1x2 (const Teuchos::RCP< const LinearOpBase< Scalar > > &A00, const Teuchos::RCP< const LinearOpBase< Scalar > > &A01, const std::string &label="")
 Form an implicit block 1x2 linear operator [ A00, A01 ]. More...
 
template<class Scalar >
Teuchos::RCP< const
LinearOpBase< Scalar > > 		block2x1 (const Teuchos::RCP< const LinearOpBase< Scalar > > &A00, const Teuchos::RCP< const LinearOpBase< Scalar > > &A10, const std::string &label="")
 Form an implicit block 2x1 linear operator [ A00; A10 ]. More...
 
template<class Scalar >
Teuchos::RCP< const
LinearOpBase< Scalar > > 		block2x2 (const Teuchos::RCP< const LinearOpBase< Scalar > > &A00, const Teuchos::RCP< const LinearOpBase< Scalar > > &A01, const Teuchos::RCP< const LinearOpBase< Scalar > > &A10, const Teuchos::RCP< const LinearOpBase< Scalar > > &A11, const std::string &label="")
 Form an implicit block 2x2 linear operator [ A00, A01; A10, A11 ]. More...
 
template<class Scalar >
Teuchos::RCP< LinearOpBase
< Scalar > > 		nonconstBlock1x1 (const Teuchos::RCP< LinearOpBase< Scalar > > &A00, const std::string &label="")
 Form an implicit block 1x1 linear operator [ A00 ]. More...
 
template<class Scalar >
Teuchos::RCP< LinearOpBase
< Scalar > > 		nonconstBlock1x2 (const Teuchos::RCP< LinearOpBase< Scalar > > &A00, const Teuchos::RCP< LinearOpBase< Scalar > > &A01, const std::string &label="")
 Form an implicit block 1x2 linear operator [ A00, A01 ]. More...
 
template<class Scalar >
Teuchos::RCP< LinearOpBase
< Scalar > > 		nonconstBlock2x1 (const Teuchos::RCP< LinearOpBase< Scalar > > &A00, const Teuchos::RCP< LinearOpBase< Scalar > > &A10, const std::string &label="")
 Form an implicit block 2x1 linear operator [ A00; A10 ]. More...
 
template<class Scalar >
Teuchos::RCP< LinearOpBase
< Scalar > > 		nonconstBlock2x2 (const Teuchos::RCP< LinearOpBase< Scalar > > &A00, const Teuchos::RCP< LinearOpBase< Scalar > > &A01, const Teuchos::RCP< LinearOpBase< Scalar > > &A10, const Teuchos::RCP< LinearOpBase< Scalar > > &A11, const std::string &label="")
 Form an implicit block 2x2 linear operator [ A00, A01; A10, A11 ]. 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...
 

Constructors

 DefaultBlockedLinearOp ()
 

Overridden from PhysicallyBlockedLinearOpBase

void beginBlockFill ()
 
void beginBlockFill (const int numRowBlocks, const int numColBlocks)
 
void beginBlockFill (const Teuchos::RCP< const ProductVectorSpaceBase< Scalar > > &productRange, const Teuchos::RCP< const ProductVectorSpaceBase< Scalar > > &productDomain)
 
bool blockFillIsActive () const
 
bool acceptsBlock (const int i, const int j) const
 
void setNonconstBlock (const int i, const int j, const Teuchos::RCP< LinearOpBase< Scalar > > &block)
 
void setBlock (const int i, const int j, const Teuchos::RCP< const LinearOpBase< Scalar > > &block)
 
void endBlockFill ()
 
void uninitialize ()
 

Overridden from BlockedLinearOpBase

Teuchos::RCP< const
ProductVectorSpaceBase< Scalar > > 		productRange () const
 
Teuchos::RCP< const
ProductVectorSpaceBase< Scalar > > 		productDomain () const
 
bool blockExists (const int i, const int j) const
 
bool blockIsConst (const int i, const int j) const
 
Teuchos::RCP< LinearOpBase
< Scalar > > 		getNonconstBlock (const int i, const int j)
 
Teuchos::RCP< const
LinearOpBase< Scalar > > 		getBlock (const int i, const int j) const
 

Overridden from LinearOpBase

Teuchos::RCP< const
VectorSpaceBase< Scalar > > 		range () const
 
Teuchos::RCP< const
VectorSpaceBase< Scalar > > 		domain () const
 
Teuchos::RCP< const
LinearOpBase< Scalar > > 		clone () const
 
bool opSupportedImpl (EOpTransp M_trans) const
 Returns true only if all constituent operators support M_trans. 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 DefaultBlockedLinearOp along with the overall dimensions and the number of constituent operators. More...
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const
 Prints the details about the constituent linear operators. More...
 

Overridden from RowStatLinearOpBase

virtual bool rowStatIsSupportedImpl (const RowStatLinearOpBaseUtils::ERowStat rowStat) const
 
virtual void getRowStatImpl (const RowStatLinearOpBaseUtils::ERowStat rowStat, const Teuchos::Ptr< VectorBase< Scalar > > &rowStatVec) const
 

Overridden from ScaledLinearOpBase

virtual bool supportsScaleLeftImpl () const
 
virtual bool supportsScaleRightImpl () const
 
virtual void scaleLeftImpl (const VectorBase< Scalar > &row_scaling)
 
virtual void scaleRightImpl (const VectorBase< Scalar > &col_scaling)
 

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...
 
- Public Member Functions inherited from Thyra::RowStatLinearOpBase< Scalar >
bool rowStatIsSupported (const RowStatLinearOpBaseUtils::ERowStat rowStat) const
 Determine if a given row stat is supported. More...
 
void getRowStat (const RowStatLinearOpBaseUtils::ERowStat rowStat, const Ptr< VectorBase< Scalar > > &rowStatVec) const
 Get some statistics about a supported row. More...
 
- Public Member Functions inherited from Thyra::ScaledLinearOpBase< Scalar >
bool supportsScaleLeft () const
 Determines if this objects supports left scaling. More...
 
bool supportsScaleRight () const
 Determines if this objects supports right scaling. More...
 
void scaleLeft (const VectorBase< Scalar > &row_scaling)
 Left scales operator with diagonal scaling operator. More...
 
void scaleRight (const VectorBase< Scalar > &col_scaling)
 Right scales operator with diagonal scaling operator. More...
 
- Protected Member Functions inherited from Thyra::LinearOpBase< Scalar >
- Protected Member Functions inherited from Thyra::RowStatLinearOpBase< Scalar >
- Protected Member Functions inherited from Thyra::ScaledLinearOpBase< Scalar >

Detailed Description

template<class Scalar>
class Thyra::DefaultBlockedLinearOp< Scalar >

Concrete composite LinearOpBase subclass that creates single linear operator object out of a set of constituent LinearOpBase blocks.

This class represents a blocked linear operator M of the form:

 M =  [ Op[0,0], Op[0,1], ... , Op[0,N];  
        Op[1,0], Op[1,1], ... , Op[1,N];  
        .        .              .         
        Op[M,0], Op[M,1], ... , Op[M,N]; ]

where Op[] is a logical 2D array of LinearOpBase objects and M=this->productRange()->getNumBlocks() and N=this->productDomain()->getNumBlocks(). Of course the operator M is not constructed explicitly but instead just applies the constituent linear operators with each set of blocks.

ToDo: Finish Documentation!

Definition at line 87 of file Thyra_DefaultBlockedLinearOp_decl.hpp.

Constructor & Destructor Documentation

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

Definition at line 64 of file Thyra_DefaultBlockedLinearOp_def.hpp.

Member Function Documentation

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< Scalar >::beginBlockFill ( )
virtual

Implements Thyra::PhysicallyBlockedLinearOpBase< Scalar >.

Definition at line 73 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< Scalar >::beginBlockFill ( const int  numRowBlocks,
const int  numColBlocks 
)
virtual

Implements Thyra::PhysicallyBlockedLinearOpBase< Scalar >.

Definition at line 82 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< Scalar >::beginBlockFill ( const Teuchos::RCP< const ProductVectorSpaceBase< Scalar > > &  productRange,
const Teuchos::RCP< const ProductVectorSpaceBase< Scalar > > &  productDomain 
)
virtual

Implements Thyra::PhysicallyBlockedLinearOpBase< Scalar >.

Definition at line 93 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
bool Thyra::DefaultBlockedLinearOp< Scalar >::blockFillIsActive ( ) const
virtual

Implements Thyra::PhysicallyBlockedLinearOpBase< Scalar >.

Definition at line 113 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
bool Thyra::DefaultBlockedLinearOp< Scalar >::acceptsBlock ( const int  i,
const int  j 
) const
virtual

Implements Thyra::PhysicallyBlockedLinearOpBase< Scalar >.

Definition at line 120 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< Scalar >::setNonconstBlock ( const int  i,
const int  j,
const Teuchos::RCP< LinearOpBase< Scalar > > &  block 
)
virtual

Implements Thyra::PhysicallyBlockedLinearOpBase< Scalar >.

Definition at line 131 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< Scalar >::setBlock ( const int  i,
const int  j,
const Teuchos::RCP< const LinearOpBase< Scalar > > &  block 
)
virtual

Implements Thyra::PhysicallyBlockedLinearOpBase< Scalar >.

Definition at line 141 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< Scalar >::endBlockFill ( )
virtual

Implements Thyra::PhysicallyBlockedLinearOpBase< Scalar >.

Definition at line 151 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< Scalar >::uninitialize ( )
virtual

Implements Thyra::PhysicallyBlockedLinearOpBase< Scalar >.

Definition at line 227 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
RCP< const ProductVectorSpaceBase< Scalar > > Thyra::DefaultBlockedLinearOp< Scalar >::productRange ( ) const
virtual

Implements Thyra::BlockedLinearOpBase< Scalar >.

Definition at line 246 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
RCP< const ProductVectorSpaceBase< Scalar > > Thyra::DefaultBlockedLinearOp< Scalar >::productDomain ( ) const
virtual

Implements Thyra::BlockedLinearOpBase< Scalar >.

Definition at line 254 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
bool Thyra::DefaultBlockedLinearOp< Scalar >::blockExists ( const int  i,
const int  j 
) const
virtual

Implements Thyra::BlockedLinearOpBase< Scalar >.

Definition at line 261 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
bool Thyra::DefaultBlockedLinearOp< Scalar >::blockIsConst ( const int  i,
const int  j 
) const
virtual

Implements Thyra::BlockedLinearOpBase< Scalar >.

Definition at line 272 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
RCP< LinearOpBase< Scalar > > Thyra::DefaultBlockedLinearOp< Scalar >::getNonconstBlock ( const int  i,
const int  j 
)
virtual

Implements Thyra::BlockedLinearOpBase< Scalar >.

Definition at line 287 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
RCP< const LinearOpBase< Scalar > > Thyra::DefaultBlockedLinearOp< Scalar >::getBlock ( const int  i,
const int  j 
) const
virtual

Implements Thyra::BlockedLinearOpBase< Scalar >.

Definition at line 300 of file Thyra_DefaultBlockedLinearOp_def.hpp.

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

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 316 of file Thyra_DefaultBlockedLinearOp_def.hpp.

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

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 324 of file Thyra_DefaultBlockedLinearOp_def.hpp.

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

Reimplemented from Thyra::LinearOpBase< Scalar >.

Definition at line 332 of file Thyra_DefaultBlockedLinearOp_def.hpp.

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

Prints just the name DefaultBlockedLinearOp along with the overall dimensions and the number of constituent operators.

Reimplemented from Teuchos::Describable.

Definition at line 342 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< Scalar >::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verbLevel 
) const
virtual

Prints the details about the constituent linear operators.

This function outputs different levels of detail based on the value passed in for verbLevel:

ToDo: Finish documentation!

Reimplemented from Teuchos::Describable.

Definition at line 356 of file Thyra_DefaultBlockedLinearOp_def.hpp.

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

Returns true only if all constituent operators support M_trans.

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 414 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< 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 430 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
bool Thyra::DefaultBlockedLinearOp< Scalar >::rowStatIsSupportedImpl ( const RowStatLinearOpBaseUtils::ERowStat  rowStat) const
protectedvirtual

Implements Thyra::RowStatLinearOpBase< Scalar >.

Definition at line 505 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< Scalar >::getRowStatImpl ( const RowStatLinearOpBaseUtils::ERowStat  rowStat,
const Teuchos::Ptr< VectorBase< Scalar > > &  rowStatVec 
) const
protectedvirtual

Implements Thyra::RowStatLinearOpBase< Scalar >.

Definition at line 570 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
bool Thyra::DefaultBlockedLinearOp< Scalar >::supportsScaleLeftImpl ( ) const
protectedvirtual

Implements Thyra::ScaledLinearOpBase< Scalar >.

Definition at line 660 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
bool Thyra::DefaultBlockedLinearOp< Scalar >::supportsScaleRightImpl ( ) const
protectedvirtual

Implements Thyra::ScaledLinearOpBase< Scalar >.

Definition at line 696 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< Scalar >::scaleLeftImpl ( const VectorBase< Scalar > &  row_scaling)
protectedvirtual

Implements Thyra::ScaledLinearOpBase< Scalar >.

Definition at line 731 of file Thyra_DefaultBlockedLinearOp_def.hpp.

template<class Scalar >
void Thyra::DefaultBlockedLinearOp< Scalar >::scaleRightImpl ( const VectorBase< Scalar > &  col_scaling)
protectedvirtual

Implements Thyra::ScaledLinearOpBase< Scalar >.

Definition at line 784 of file Thyra_DefaultBlockedLinearOp_def.hpp.

Friends And Related Function Documentation

template<class Scalar >
RCP< DefaultBlockedLinearOp< Scalar > > defaultBlockedLinearOp ( )
related

Nonmember default constructor.

template<class Scalar >
Teuchos::RCP< const LinearOpBase< Scalar > > block1x1 ( const Teuchos::RCP< const LinearOpBase< Scalar > > &  A00,
const std::string &  label = "" 
)
related

Form an implicit block 1x1 linear operator [ A00 ].

template<class Scalar >
Teuchos::RCP< const LinearOpBase< Scalar > > block1x2 ( const Teuchos::RCP< const LinearOpBase< Scalar > > &  A00,
const Teuchos::RCP< const LinearOpBase< Scalar > > &  A01,
const std::string &  label = "" 
)
related

Form an implicit block 1x2 linear operator [ A00, A01 ].

template<class Scalar >
Teuchos::RCP< const LinearOpBase< Scalar > > block2x1 ( const Teuchos::RCP< const LinearOpBase< Scalar > > &  A00,
const Teuchos::RCP< const LinearOpBase< Scalar > > &  A10,
const std::string &  label = "" 
)
related

Form an implicit block 2x1 linear operator [ A00; A10 ].

template<class Scalar >
Teuchos::RCP< const LinearOpBase< Scalar > > block2x2 ( const Teuchos::RCP< const LinearOpBase< Scalar > > &  A00,
const Teuchos::RCP< const LinearOpBase< Scalar > > &  A01,
const Teuchos::RCP< const LinearOpBase< Scalar > > &  A10,
const Teuchos::RCP< const LinearOpBase< Scalar > > &  A11,
const std::string &  label = "" 
)
related

Form an implicit block 2x2 linear operator [ A00, A01; A10, A11 ].

template<class Scalar >
Teuchos::RCP< LinearOpBase< Scalar > > nonconstBlock1x1 ( const Teuchos::RCP< LinearOpBase< Scalar > > &  A00,
const std::string &  label = "" 
)
related

Form an implicit block 1x1 linear operator [ A00 ].

template<class Scalar >
Teuchos::RCP< LinearOpBase< Scalar > > nonconstBlock1x2 ( const Teuchos::RCP< LinearOpBase< Scalar > > &  A00,
const Teuchos::RCP< LinearOpBase< Scalar > > &  A01,
const std::string &  label = "" 
)
related

Form an implicit block 1x2 linear operator [ A00, A01 ].

template<class Scalar >
Teuchos::RCP< LinearOpBase< Scalar > > nonconstBlock2x1 ( const Teuchos::RCP< LinearOpBase< Scalar > > &  A00,
const Teuchos::RCP< LinearOpBase< Scalar > > &  A10,
const std::string &  label = "" 
)
related

Form an implicit block 2x1 linear operator [ A00; A10 ].

template<class Scalar >
Teuchos::RCP< LinearOpBase< Scalar > > nonconstBlock2x2 ( const Teuchos::RCP< LinearOpBase< Scalar > > &  A00,
const Teuchos::RCP< LinearOpBase< Scalar > > &  A01,
const Teuchos::RCP< LinearOpBase< Scalar > > &  A10,
const Teuchos::RCP< LinearOpBase< Scalar > > &  A11,
const std::string &  label = "" 
)
related

Form an implicit block 2x2 linear operator [ A00, A01; A10, A11 ].

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.5