Teko::PreconditionerLinearOp< ScalarT > Class Template Reference

Class that wraps a PreconditionerBase object it makes it behave like a linear operator. More...

#include <Teko_PreconditionerLinearOpDecl.hpp>

List of all members.

Public Member Functions
void	initialize (const Teuchos::RCP< Thyra::PreconditionerBase< ScalarT > > &prec)
	build a linear operator using this preconditioner, this initialization permits changes
void	initialize (const Teuchos::RCP< const Thyra::PreconditionerBase< ScalarT > > &prec)
	build a linear operator using this preconditioner, this initialization refuses changes
void	uninitialize ()
	Disassociate this object with the currently owned preconditioner.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase < ScalarT > >	range () const
	Range space of this operator.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase < ScalarT > >	domain () const
	Domain space of this operator.
virtual void	applyImpl (const Thyra::EOpTransp M_trans, const Thyra::MultiVectorBase< ScalarT > &x, const Teuchos::Ptr< Thyra::MultiVectorBase< ScalarT > > &y, const ScalarT alpha, const ScalarT beta) const
	Apply operation.
virtual Teuchos::RCP < Thyra::PreconditionerBase < ScalarT > >	getNonconstPreconditioner ()
	Get a nonconstant PreconditionerBase object.
virtual Teuchos::RCP< const Thyra::PreconditionerBase < ScalarT > >	getPreconditioner () const
	Get a constant PreconditionerBase object.
Teko::LinearOp	getOperator () const
	Get teko linear operator.
Protected Member Functions
Teuchos::ConstNonconstObjectContainer < Thyra::LinearOpBase< ScalarT > >	getOperator_cnoc () const
	get operator associated with the preconditioner
Teuchos::ConstNonconstObjectContainer < Thyra::LinearOpBase< ScalarT > >	getOperator_cnoc ()
	get operator associated with the preconditioner

---

Detailed Description

template<typename ScalarT>
class Teko::PreconditionerLinearOp< ScalarT >

Class that wraps a PreconditionerBase object it makes it behave like a linear operator.

Class that wraps a PreconditionerBase object it makes it behave like a linear operator. Note that this is useful because it stores the neccessary state information for reconstructing a preconditioner.

Definition at line 66 of file Teko_PreconditionerLinearOpDecl.hpp.

---

Member Function Documentation

template<typename ScalarT >

void Teko::PreconditionerLinearOp< ScalarT >::initialize

(

const Teuchos::RCP< Thyra::PreconditionerBase< ScalarT > > &

prec

)

build a linear operator using this preconditioner, this initialization permits changes

Definition at line 75 of file Teko_PreconditionerLinearOp.hpp.

template<typename ScalarT >

void Teko::PreconditionerLinearOp< ScalarT >::initialize

(

const Teuchos::RCP< const Thyra::PreconditionerBase< ScalarT > > &

prec

)

build a linear operator using this preconditioner, this initialization refuses changes

Definition at line 83 of file Teko_PreconditionerLinearOp.hpp.

template<typename ScalarT >

void Teko::PreconditionerLinearOp< ScalarT >::uninitialize

(

)

Disassociate this object with the currently owned preconditioner.

Definition at line 91 of file Teko_PreconditionerLinearOp.hpp.

template<typename ScalarT >

Teuchos::RCP< const Thyra::VectorSpaceBase< ScalarT > > Teko::PreconditionerLinearOp< ScalarT >::range

(

)

const [virtual]

Range space of this operator.

Definition at line 98 of file Teko_PreconditionerLinearOp.hpp.

template<typename ScalarT >

Teuchos::RCP< const Thyra::VectorSpaceBase< ScalarT > > Teko::PreconditionerLinearOp< ScalarT >::domain

(

)

const [virtual]

Domain space of this operator.

Definition at line 105 of file Teko_PreconditionerLinearOp.hpp.

template<typename ScalarT >

void Teko::PreconditionerLinearOp< ScalarT >::applyImpl	(	const Thyra::EOpTransp	M_trans,
		const Thyra::MultiVectorBase< ScalarT > &	x,
		const Teuchos::Ptr< Thyra::MultiVectorBase< ScalarT > > &	y,
		const ScalarT	alpha,
		const ScalarT	beta
	)		const [virtual]

Apply operation.

Definition at line 118 of file Teko_PreconditionerLinearOp.hpp.

template<typename ScalarT >

Teuchos::RCP< Thyra::PreconditionerBase< ScalarT > > Teko::PreconditionerLinearOp< ScalarT >::getNonconstPreconditioner

(

)

[virtual]

Get a nonconstant PreconditionerBase object.

Definition at line 132 of file Teko_PreconditionerLinearOp.hpp.

template<typename ScalarT >

Teuchos::RCP< const Thyra::PreconditionerBase< ScalarT > > Teko::PreconditionerLinearOp< ScalarT >::getPreconditioner

(

)

const [virtual]

Get a constant PreconditionerBase object.

Definition at line 139 of file Teko_PreconditionerLinearOp.hpp.

template<typename ScalarT >

Teko::LinearOp Teko::PreconditionerLinearOp< ScalarT >::getOperator

(

)

const [inline]

Get teko linear operator.

Definition at line 105 of file Teko_PreconditionerLinearOpDecl.hpp.

template<typename ScalarT >

Teuchos::ConstNonconstObjectContainer< Thyra::LinearOpBase< ScalarT > > Teko::PreconditionerLinearOp< ScalarT >::getOperator_cnoc

(

)

const [protected]

get operator associated with the preconditioner

Definition at line 146 of file Teko_PreconditionerLinearOp.hpp.

template<typename ScalarT >

Teuchos::ConstNonconstObjectContainer< Thyra::LinearOpBase< ScalarT > > Teko::PreconditionerLinearOp< ScalarT >::getOperator_cnoc

(

)

[protected]

get operator associated with the preconditioner

Definition at line 156 of file Teko_PreconditionerLinearOp.hpp.

---

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

• Teko_PreconditionerLinearOpDecl.hpp
• Teko_PreconditionerLinearOp.hpp