Thyra Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Private Member Functions | Private Attributes | Related Functions | List of all members
Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Concrete Thyra::LinearOpBase subclass for Tpetra::Operator. More...

#include <Thyra_TpetraLinearOp_decl.hpp>

Inherits LinearOpDefaultBase< Scalar >, ScaledLinearOpBase< Scalar >, and RowStatLinearOpBase< Scalar >.

Private Member Functions

template<class TpetraOperator_t >
void initializeImpl (const RCP< const VectorSpaceBase< Scalar > > &rangeSpace, const RCP< const VectorSpaceBase< Scalar > > &domainSpace, const RCP< TpetraOperator_t > &tpetraOperator)
 

Private Attributes

RCP< const VectorSpaceBase
< Scalar > > 		rangeSpace_
 
RCP< const VectorSpaceBase
< Scalar > > 		domainSpace_
 
Teuchos::ConstNonconstObjectContainer
< Tpetra::Operator< Scalar,
LocalOrdinal, GlobalOrdinal,
Node > > 		tpetraOperator_
 

Related Functions

(Note that these are not member functions.)

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< TpetraLinearOp< Scalar,
LocalOrdinal, GlobalOrdinal,
Node > > 		tpetraLinearOp (const RCP< const VectorSpaceBase< Scalar > > &rangeSpace, const RCP< const VectorSpaceBase< Scalar > > &domainSpace, const RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraOperator)
 Nonmmeber constructor for TpetraLinearOp. More...
 
template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const TpetraLinearOp
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > > 		constTpetraLinearOp (const RCP< const VectorSpaceBase< Scalar > > &rangeSpace, const RCP< const VectorSpaceBase< Scalar > > &domainSpace, const RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraOperator)
 Nonmmeber constructor for TpetraLinearOp. More...
 

Constructors/initializers.

 TpetraLinearOp ()
 Construct to uninitialized. More...
 
void initialize (const RCP< const VectorSpaceBase< Scalar > > &rangeSpace, const RCP< const VectorSpaceBase< Scalar > > &domainSpace, const RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraOperator)
 Initialize. More...
 
void constInitialize (const RCP< const VectorSpaceBase< Scalar > > &rangeSpace, const RCP< const VectorSpaceBase< Scalar > > &domainSpace, const RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraOperator)
 Initialize. More...
 
RCP< Tpetra::Operator< Scalar,
LocalOrdinal, GlobalOrdinal,
Node > > 		getTpetraOperator ()
 Get embedded non-const Tpetra::Operator. More...
 
RCP< const Tpetra::Operator
< Scalar, LocalOrdinal,
GlobalOrdinal, Node > > 		getConstTpetraOperator () const
 Get embedded const Tpetra::Operator. More...
 

Public Overridden functions from LinearOpBase.

RCP< const
Thyra::VectorSpaceBase< Scalar > > 		range () const
 
RCP< const
Thyra::VectorSpaceBase< Scalar > > 		domain () const
 

Protected Overridden functions from LinearOpBase.

bool opSupportedImpl (Thyra::EOpTransp M_trans) const
 
void applyImpl (const Thyra::EOpTransp M_trans, const Thyra::MultiVectorBase< Scalar > &X_in, const Teuchos::Ptr< Thyra::MultiVectorBase< Scalar > > &Y_inout, const Scalar alpha, const Scalar beta) const
 

Protected member functions 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)
 

Protected member functions overridden from RowStatLinearOpBase.

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

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Concrete Thyra::LinearOpBase subclass for Tpetra::Operator.

Todo:
Finish Documentation

Definition at line 73 of file Thyra_TpetraLinearOp_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraLinearOp ( )

Construct to uninitialized.

Definition at line 138 of file Thyra_TpetraLinearOp_def.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::initialize ( const RCP< const VectorSpaceBase< Scalar > > &  rangeSpace,
const RCP< const VectorSpaceBase< Scalar > > &  domainSpace,
const RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  tpetraOperator 
)

Initialize.

Definition at line 143 of file Thyra_TpetraLinearOp_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::constInitialize ( const RCP< const VectorSpaceBase< Scalar > > &  rangeSpace,
const RCP< const VectorSpaceBase< Scalar > > &  domainSpace,
const RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  tpetraOperator 
)

Initialize.

Definition at line 154 of file Thyra_TpetraLinearOp_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getTpetraOperator ( )

Get embedded non-const Tpetra::Operator.

Definition at line 166 of file Thyra_TpetraLinearOp_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getConstTpetraOperator ( ) const

Get embedded const Tpetra::Operator.

Definition at line 174 of file Thyra_TpetraLinearOp_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Thyra::VectorSpaceBase< Scalar > > Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::range ( ) const

Definition at line 185 of file Thyra_TpetraLinearOp_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const Thyra::VectorSpaceBase< Scalar > > Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::domain ( ) const

Definition at line 193 of file Thyra_TpetraLinearOp_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::opSupportedImpl ( Thyra::EOpTransp  M_trans) const
protected

Definition at line 251 of file Thyra_TpetraLinearOp_def.hpp.

References is_null(), and NOTRANS.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::applyImpl ( const Thyra::EOpTransp  M_trans,
const Thyra::MultiVectorBase< Scalar > &  X_in,
const Teuchos::Ptr< Thyra::MultiVectorBase< Scalar > > &  Y_inout,
const Scalar  alpha,
const Scalar  beta 
) const
protected

Definition at line 271 of file Thyra_TpetraLinearOp_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::supportsScaleLeftImpl ( ) const
protectedvirtual

Definition at line 306 of file Thyra_TpetraLinearOp_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::supportsScaleRightImpl ( ) const
protectedvirtual

Definition at line 313 of file Thyra_TpetraLinearOp_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scaleLeftImpl ( const VectorBase< Scalar > &  row_scaling)
protectedvirtual

Definition at line 322 of file Thyra_TpetraLinearOp_def.hpp.

References Thyra::TpetraOperatorVectorExtraction< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getConstTpetraVector().

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scaleRightImpl ( const VectorBase< Scalar > &  col_scaling)
protectedvirtual

Definition at line 339 of file Thyra_TpetraLinearOp_def.hpp.

References Thyra::TpetraOperatorVectorExtraction< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getConstTpetraVector().

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::rowStatIsSupportedImpl ( const RowStatLinearOpBaseUtils::ERowStat  rowStat) const
protectedvirtual

Definition at line 357 of file Thyra_TpetraLinearOp_def.hpp.

References is_null(), and TEUCHOS_UNREACHABLE_RETURN.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRowStatImpl ( const RowStatLinearOpBaseUtils::ERowStat  rowStat,
const Ptr< VectorBase< Scalar > > &  rowStatVec 
) const
protectedvirtual

Definition at line 376 of file Thyra_TpetraLinearOp_def.hpp.

References Thyra::TpetraOperatorVectorExtraction< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getTpetraVector(), nonnull(), Teuchos::ArrayView< T >::size(), TEUCHOS_ASSERT, and TEUCHOS_TEST_FOR_EXCEPTION.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
template<class TpetraOperator_t >
void Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::initializeImpl ( const RCP< const VectorSpaceBase< Scalar > > &  rangeSpace,
const RCP< const VectorSpaceBase< Scalar > > &  domainSpace,
const RCP< TpetraOperator_t > &  tpetraOperator 
)
private

Definition at line 453 of file Thyra_TpetraLinearOp_def.hpp.

References nonnull(), and TEUCHOS_ASSERT.

Friends And Related Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node > > tpetraLinearOp ( const RCP< const VectorSpaceBase< Scalar > > &  rangeSpace,
const RCP< const VectorSpaceBase< Scalar > > &  domainSpace,
const RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  tpetraOperator 
)
related

Nonmmeber constructor for TpetraLinearOp.

Definition at line 229 of file Thyra_TpetraLinearOp_decl.hpp.

References Teuchos::rcp().

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node > > constTpetraLinearOp ( const RCP< const VectorSpaceBase< Scalar > > &  rangeSpace,
const RCP< const VectorSpaceBase< Scalar > > &  domainSpace,
const RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  tpetraOperator 
)
related

Nonmmeber constructor for TpetraLinearOp.

Definition at line 248 of file Thyra_TpetraLinearOp_decl.hpp.

References Teuchos::rcp().

Member Data Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
RCP<const VectorSpaceBase<Scalar> > Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::rangeSpace_
private

Definition at line 201 of file Thyra_TpetraLinearOp_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
RCP<const VectorSpaceBase<Scalar> > Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::domainSpace_
private

Definition at line 204 of file Thyra_TpetraLinearOp_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::ConstNonconstObjectContainer<Tpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> > Thyra::TpetraLinearOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::tpetraOperator_
private

Definition at line 207 of file Thyra_TpetraLinearOp_decl.hpp.

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