Teko::StratimikosFactory Class Reference

Adapts Teko block preconditioners to the Stratimikos framework. More...

#include <Teko_StratimikosFactory.hpp>

Inherits Thyra::PreconditionerFactoryBase< double >.

Public Member Functions
Constructors/initializers/accessors
	StratimikosFactory ()
Overridden from PreconditionerFactoryBase
bool	isCompatible (const Thyra::LinearOpSourceBase< double > &fwdOp) const
bool	applySupportsConj (Thyra::EConj conj) const
bool	applyTransposeSupportsConj (Thyra::EConj conj) const
Teuchos::RCP< Thyra::PreconditionerBase< double > >	createPrec () const
void	initializePrec (const Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > &fwdOp, Thyra::PreconditionerBase< double > *prec, const Thyra::ESupportSolveUse supportSolveUse) const
void	uninitializePrec (Thyra::PreconditionerBase< double > *prec, Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > *fwdOp, Thyra::ESupportSolveUse *supportSolveUse) const
Overridden from Teuchos::ParameterListAcceptor
void	setParameterList (Teuchos::RCP< Teuchos::ParameterList > const &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
void	initializePrec_Thyra (const Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > &fwdOp, Thyra::PreconditionerBase< double > *prec, const Thyra::ESupportSolveUse supportSolveUse) const
void	setRequestHandler (const Teuchos::RCP< Teko::RequestHandler > &rh)
Teuchos::RCP< Teko::RequestHandler >	getRequestHandler () const
const std::vector< int > &	getDecomposition () const
	Get the decomposition vector in use by this factory.

Detailed Description

Adapts Teko block preconditioners to the Stratimikos framework.

This factory is what registers Teko as a Stratimikos preconditioner named "Teko" (see Teko::addTekoToStratimikosBuilder). Once registered, an entire Teko block preconditioner can be configured from the Stratimikos parameter list / XML: the top-level keys describe how to segregate the monolithic operator into blocks ("Strided Blocking", "Reorder Type") and which named inverse to apply to the whole system ("Inverse Type"), while the "Inverse Factory Library" sublist defines every named inverse. The complete list of valid parameters is returned by getValidParameters().

See the Configuration Model page of the Teko user's guide for the parameter reference and worked XML examples.

Definition at line 38 of file Teko_StratimikosFactory.hpp.

Constructor & Destructor Documentation

StratimikosFactory()

Teko::StratimikosFactory::StratimikosFactory

(

)

Definition at line 69 of file Teko_StratimikosFactory.cpp.

Member Function Documentation

isCompatible()

bool Teko::StratimikosFactory::isCompatible

(

const Thyra::LinearOpSourceBase< double > &

fwdOp

)

const

Definition at line 84 of file Teko_StratimikosFactory.cpp.

applySupportsConj()

bool Teko::StratimikosFactory::applySupportsConj

(

Thyra::EConj

conj

)

const

Definition at line 90 of file Teko_StratimikosFactory.cpp.

applyTransposeSupportsConj()

bool Teko::StratimikosFactory::applyTransposeSupportsConj

(

Thyra::EConj

conj

)

const

Definition at line 92 of file Teko_StratimikosFactory.cpp.

createPrec()

Teuchos::RCP< Thyra::PreconditionerBase< double > > Teko::StratimikosFactory::createPrec

(

)

const

Definition at line 96 of file Teko_StratimikosFactory.cpp.

initializePrec()

void Teko::StratimikosFactory::initializePrec	(	const Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > &	fwdOp,
		Thyra::PreconditionerBase< double > *	prec,
		const Thyra::ESupportSolveUse	supportSolveUse
	)		const

Definition at line 100 of file Teko_StratimikosFactory.cpp.

uninitializePrec()

void Teko::StratimikosFactory::uninitializePrec	(	Thyra::PreconditionerBase< double > *	prec,
		Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > *	fwdOp,
		Thyra::ESupportSolveUse *	supportSolveUse
	)		const

Definition at line 282 of file Teko_StratimikosFactory.cpp.

setParameterList()

void Teko::StratimikosFactory::setParameterList

(

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

paramList

)

Definition at line 292 of file Teko_StratimikosFactory.cpp.

getNonconstParameterList()

Teuchos::RCP< Teuchos::ParameterList > Teko::StratimikosFactory::getNonconstParameterList

(

)

Definition at line 299 of file Teko_StratimikosFactory.cpp.

unsetParameterList()

Teuchos::RCP< Teuchos::ParameterList > Teko::StratimikosFactory::unsetParameterList

(

)

Definition at line 303 of file Teko_StratimikosFactory.cpp.

getParameterList()

Teuchos::RCP< const Teuchos::ParameterList > Teko::StratimikosFactory::getParameterList

(

)

const

Definition at line 309 of file Teko_StratimikosFactory.cpp.

getValidParameters()

Teuchos::RCP< const Teuchos::ParameterList > Teko::StratimikosFactory::getValidParameters

(

)

const

Definition at line 313 of file Teko_StratimikosFactory.cpp.

description()

std::string Teko::StratimikosFactory::description

(

)

const

Definition at line 364 of file Teko_StratimikosFactory.cpp.

initializePrec_Thyra()

void Teko::StratimikosFactory::initializePrec_Thyra	(	const Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > &	fwdOp,
		Thyra::PreconditionerBase< double > *	prec,
		const Thyra::ESupportSolveUse	supportSolveUse
	)		const

Setup an thyra preconditioner (most likely blocked)

Definition at line 109 of file Teko_StratimikosFactory.cpp.

setRequestHandler()

void Teko::StratimikosFactory::setRequestHandler ( const Teuchos::RCP< Teko::RequestHandler > &  rh )

inline

Access to the application communication request handling mechnism

Definition at line 107 of file Teko_StratimikosFactory.hpp.

getRequestHandler()

Teuchos::RCP< Teko::RequestHandler > Teko::StratimikosFactory::getRequestHandler ( ) const

inline

Access to the application communication request handling mechnism

Definition at line 111 of file Teko_StratimikosFactory.hpp.

getDecomposition()

const std::vector< int > & Teko::StratimikosFactory::getDecomposition ( ) const

inline

Get the decomposition vector in use by this factory.

Definition at line 114 of file Teko_StratimikosFactory.hpp.

---

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

• Teko_StratimikosFactory.hpp
• Teko_StratimikosFactory.cpp