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

#include <Thyra_TpetraLinearOp_decl.hpp>

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

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

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.

Protected member functions overridden from RowStatLinearOpBase.
RCP< const VectorSpaceBase< Scalar > >	rangeSpace_

RCP< const VectorSpaceBase< Scalar > >	domainSpace_

Teuchos::ConstNonconstObjectContainer< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	tpetraOperator_

virtual bool	rowStatIsSupportedImpl (const RowStatLinearOpBaseUtils::ERowStat rowStat) const

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

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

Constructors/initializers.
	TpetraLinearOp ()
	Construct to uninitialized.

void	initialize (const RCP< const VectorSpaceBase< Scalar > > &rangeSpace, const RCP< const VectorSpaceBase< Scalar > > &domainSpace, const RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraOperator)
	Initialize.

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.

RCP< Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getTpetraOperator ()
	Get embedded non-const Tpetra::Operator.

RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getConstTpetraOperator () const
	Get embedded const Tpetra::Operator.

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)

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

◆ TpetraLinearOp()

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.

Referenced by constTpetraLinearOp(), and tpetraLinearOp().

Member Function Documentation

◆ initialize()

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.

References initializeImpl().

◆ constInitialize()

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.

References initializeImpl().

◆ getTpetraOperator()

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.

References tpetraOperator_.

Referenced by Thyra::TpetraOperatorVectorExtraction< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getTpetraOperator().

◆ getConstTpetraOperator()

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.

References tpetraOperator_.

Referenced by Thyra::TpetraOperatorVectorExtraction< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getConstTpetraOperator().

◆ range()

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.

References rangeSpace_.

◆ domain()

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.

References domainSpace_.

◆ opSupportedImpl()

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 Teuchos::ScalarTraits< typename T >::isComplex, and tpetraOperator_.

◆ applyImpl()

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.

References Thyra::convertToTeuchosTransMode(), and tpetraOperator_.

◆ supportsScaleLeftImpl()

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.

◆ supportsScaleRightImpl()

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.

◆ scaleLeftImpl()

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 321 of file Thyra_TpetraLinearOp_def.hpp.

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

◆ scaleRightImpl()

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(), and tpetraOperator_.

◆ rowStatIsSupportedImpl()

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 358 of file Thyra_TpetraLinearOp_def.hpp.

References tpetraOperator_.

◆ getRowStatImpl()

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 377 of file Thyra_TpetraLinearOp_def.hpp.

References Thyra::TpetraOperatorVectorExtraction< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getTpetraVector(), and tpetraOperator_.

◆ initializeImpl()

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 457 of file Thyra_TpetraLinearOp_def.hpp.

References domainSpace_, rangeSpace_, and tpetraOperator_.

Referenced by constInitialize(), and initialize().

Friends And Related Symbol Documentation

◆ tpetraLinearOp()

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.

Definition at line 229 of file Thyra_TpetraLinearOp_decl.hpp.

References Teuchos::rcp(), and TpetraLinearOp().

◆ constTpetraLinearOp()

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.

Definition at line 248 of file Thyra_TpetraLinearOp_decl.hpp.

References Teuchos::rcp(), and TpetraLinearOp().

Member Data Documentation

◆ rangeSpace_

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.

Referenced by initializeImpl(), and range().

◆ domainSpace_

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.

Referenced by domain(), and initializeImpl().

◆ tpetraOperator_

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.

Referenced by applyImpl(), getConstTpetraOperator(), getRowStatImpl(), getTpetraOperator(), initializeImpl(), opSupportedImpl(), rowStatIsSupportedImpl(), scaleLeftImpl(), and scaleRightImpl().

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

Related Symbols

Protected member functions overridden from RowStatLinearOpBase.

Constructors/initializers.

Public Overridden functions from LinearOpBase.

Protected Overridden functions from LinearOpBase.

Protected member functions overridden from ScaledLinearOpBase.

Detailed Description

Constructor & Destructor Documentation

◆ TpetraLinearOp()

Member Function Documentation

◆ initialize()

◆ constInitialize()

◆ getTpetraOperator()

◆ getConstTpetraOperator()

◆ range()

◆ domain()

◆ opSupportedImpl()

◆ applyImpl()

◆ supportsScaleLeftImpl()

◆ supportsScaleRightImpl()

◆ scaleLeftImpl()

◆ scaleRightImpl()

◆ rowStatIsSupportedImpl()

◆ getRowStatImpl()

◆ initializeImpl()

Friends And Related Symbol Documentation

◆ tpetraLinearOp()

◆ constTpetraLinearOp()

Member Data Documentation

◆ rangeSpace_

◆ domainSpace_

◆ tpetraOperator_