Thyra::BelosTpetraPreconditionerFactory< MatrixType > Class Template Reference

Concrete preconditioner factory subclass based on Belos. (Yes, Belos solvers can also be used as preconditioners!) More...

#include <Thyra_BelosTpetraPreconditionerFactory_decl.hpp>

Inherits PreconditionerFactoryBase< MatrixType::scalar_type >.

Public Types
typedef MatrixType::scalar_type	scalar_type

Private Attributes
Teuchos::RCP < Teuchos::ParameterList >	paramList_

Constructors/initializers/accessors
	BelosTpetraPreconditionerFactory ()

Overridden from PreconditionerFactoryBase
bool	isCompatible (const LinearOpSourceBase< scalar_type > &fwdOp) const
Teuchos::RCP < PreconditionerBase < scalar_type > >	createPrec () const
void	initializePrec (const Teuchos::RCP< const LinearOpSourceBase< scalar_type > > &fwdOp, PreconditionerBase< scalar_type > *prec, const ESupportSolveUse supportSolveUse) const
void	uninitializePrec (PreconditionerBase< scalar_type > *prec, Teuchos::RCP< const LinearOpSourceBase< scalar_type > > *fwdOp, ESupportSolveUse *supportSolveUse) const

Overridden from Teuchos::ParameterListAcceptor
void	setParameterList (const Teuchos::RCP< Teuchos::ParameterList > &paramList)
Teuchos::RCP < Teuchos::ParameterList >	getNonconstParameterList ()
Teuchos::RCP < Teuchos::ParameterList >	unsetParameterList ()
Teuchos::RCP< const Teuchos::ParameterList >	getParameterList () const
Teuchos::RCP< const Teuchos::ParameterList >	getValidParameters () const

Public functions overridden from Describable.
std::string	description () const

Detailed Description

template<typename MatrixType>
class Thyra::BelosTpetraPreconditionerFactory< MatrixType >

Concrete preconditioner factory subclass based on Belos. (Yes, Belos solvers can also be used as preconditioners!)

Definition at line 21 of file Thyra_BelosTpetraPreconditionerFactory_decl.hpp.

Member Typedef Documentation

template<typename MatrixType >

typedef MatrixType::scalar_type Thyra::BelosTpetraPreconditionerFactory< MatrixType >::scalar_type

Definition at line 25 of file Thyra_BelosTpetraPreconditionerFactory_decl.hpp.

Constructor & Destructor Documentation

template<typename MatrixType >

Thyra::BelosTpetraPreconditionerFactory< MatrixType >::BelosTpetraPreconditionerFactory

(

)

Definition at line 51 of file Thyra_BelosTpetraPreconditionerFactory_def.hpp.

Member Function Documentation

template<typename MatrixType >

bool Thyra::BelosTpetraPreconditionerFactory< MatrixType >::isCompatible

(

const LinearOpSourceBase< scalar_type > &

fwdOp

)

const

Definition at line 59 of file Thyra_BelosTpetraPreconditionerFactory_def.hpp.

template<typename MatrixType >

Teuchos::RCP< PreconditionerBase< typename BelosTpetraPreconditionerFactory< MatrixType >::scalar_type > > Thyra::BelosTpetraPreconditionerFactory< MatrixType >::createPrec

(

)

const

Definition at line 79 of file Thyra_BelosTpetraPreconditionerFactory_def.hpp.

template<typename MatrixType >

void Thyra::BelosTpetraPreconditionerFactory< MatrixType >::initializePrec	(	const Teuchos::RCP< const LinearOpSourceBase< scalar_type > > &	fwdOp,
		PreconditionerBase< scalar_type > *	prec,
		const ESupportSolveUse	supportSolveUse
	)		const

Definition at line 86 of file Thyra_BelosTpetraPreconditionerFactory_def.hpp.

template<typename MatrixType >

void Thyra::BelosTpetraPreconditionerFactory< MatrixType >::uninitializePrec	(	PreconditionerBase< scalar_type > *	prec,
		Teuchos::RCP< const LinearOpSourceBase< scalar_type > > *	fwdOp,
		ESupportSolveUse *	supportSolveUse
	)		const

Definition at line 212 of file Thyra_BelosTpetraPreconditionerFactory_def.hpp.

template<typename MatrixType >

void Thyra::BelosTpetraPreconditionerFactory< MatrixType >::setParameterList

(

const Teuchos::RCP< Teuchos::ParameterList > &

paramList

)

Definition at line 246 of file Thyra_BelosTpetraPreconditionerFactory_def.hpp.

template<typename MatrixType >

Teuchos::RCP< Teuchos::ParameterList > Thyra::BelosTpetraPreconditionerFactory< MatrixType >::getNonconstParameterList

(

)

Definition at line 263 of file Thyra_BelosTpetraPreconditionerFactory_def.hpp.

template<typename MatrixType >

Teuchos::RCP< Teuchos::ParameterList > Thyra::BelosTpetraPreconditionerFactory< MatrixType >::unsetParameterList

(

)

Definition at line 271 of file Thyra_BelosTpetraPreconditionerFactory_def.hpp.

template<typename MatrixType >

Teuchos::RCP< const Teuchos::ParameterList > Thyra::BelosTpetraPreconditionerFactory< MatrixType >::getParameterList

(

)

const

Definition at line 281 of file Thyra_BelosTpetraPreconditionerFactory_def.hpp.

template<typename MatrixType >

Teuchos::RCP< const Teuchos::ParameterList > Thyra::BelosTpetraPreconditionerFactory< MatrixType >::getValidParameters

(

)

const

Definition at line 288 of file Thyra_BelosTpetraPreconditionerFactory_def.hpp.

template<typename MatrixType >

std::string Thyra::BelosTpetraPreconditionerFactory< MatrixType >::description

(

)

const

Definition at line 316 of file Thyra_BelosTpetraPreconditionerFactory_def.hpp.

Member Data Documentation

template<typename MatrixType >

Teuchos::RCP<Teuchos::ParameterList> Thyra::BelosTpetraPreconditionerFactory< MatrixType >::paramList_

private

Definition at line 84 of file Thyra_BelosTpetraPreconditionerFactory_decl.hpp.

---

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

• Thyra_BelosTpetraPreconditionerFactory_decl.hpp
• Thyra_BelosTpetraPreconditionerFactory_def.hpp