Thyra::MLPreconditionerFactory Class Reference

Concrete preconditioner factory subclass based on ML. More...

#include <Thyra_MLPreconditionerFactory.hpp>

Inherits PreconditionerFactoryBase< double >.

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

Constructors/initializers/accessors
	MLPreconditionerFactory ()
	STANDARD_COMPOSITION_MEMBERS (EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor)
	Set the strategy object used to extract an Epetra_Operator view of an input forward operator. More...

Overridden from PreconditionerFactoryBase
bool	isCompatible (const LinearOpSourceBase< double > &fwdOp) const
bool	applySupportsConj (EConj conj) const
bool	applyTransposeSupportsConj (EConj conj) const
Teuchos::RCP < PreconditionerBase< double > >	createPrec () const
void	initializePrec (const Teuchos::RCP< const LinearOpSourceBase< double > > &fwdOp, PreconditionerBase< double > *prec, const ESupportSolveUse supportSolveUse) const
void	uninitializePrec (PreconditionerBase< double > *prec, Teuchos::RCP< const LinearOpSourceBase< double > > *fwdOp, 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

Detailed Description

Concrete preconditioner factory subclass based on ML.

For information on ML and its available options, please see the ML home page or the ML User manuals.

Definition at line 25 of file Thyra_MLPreconditionerFactory.hpp.

Constructor & Destructor Documentation

Thyra::MLPreconditionerFactory::MLPreconditionerFactory

(

)

Definition at line 91 of file Thyra_MLPreconditionerFactory.cpp.

Member Function Documentation

Thyra::MLPreconditionerFactory::STANDARD_COMPOSITION_MEMBERS	(	EpetraOperatorViewExtractorBase	,
		epetraFwdOpViewExtractor
	)

Set the strategy object used to extract an Epetra_Operator view of an input forward operator.

This view will then be dynamically casted to Epetra_RowMatrix before it is used.

The default implementation used is EpetraOperatorViewExtractorBase.

bool Thyra::MLPreconditionerFactory::isCompatible

(

const LinearOpSourceBase< double > &

fwdOp

)

const

Definition at line 99 of file Thyra_MLPreconditionerFactory.cpp.

bool Thyra::MLPreconditionerFactory::applySupportsConj

(

EConj

conj

)

const

Definition at line 124 of file Thyra_MLPreconditionerFactory.cpp.

bool Thyra::MLPreconditionerFactory::applyTransposeSupportsConj

(

EConj

conj

)

const

Definition at line 130 of file Thyra_MLPreconditionerFactory.cpp.

RCP< PreconditionerBase< double > > Thyra::MLPreconditionerFactory::createPrec

(

)

const

Definition at line 137 of file Thyra_MLPreconditionerFactory.cpp.

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

Definition at line 143 of file Thyra_MLPreconditionerFactory.cpp.

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

Definition at line 367 of file Thyra_MLPreconditionerFactory.cpp.

void Thyra::MLPreconditionerFactory::setParameterList

(

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

paramList

)

Definition at line 380 of file Thyra_MLPreconditionerFactory.cpp.

RCP< ParameterList > Thyra::MLPreconditionerFactory::getNonconstParameterList

(

)

Definition at line 434 of file Thyra_MLPreconditionerFactory.cpp.

RCP< ParameterList > Thyra::MLPreconditionerFactory::unsetParameterList

(

)

Definition at line 441 of file Thyra_MLPreconditionerFactory.cpp.

RCP< const ParameterList > Thyra::MLPreconditionerFactory::getParameterList

(

)

const

Definition at line 450 of file Thyra_MLPreconditionerFactory.cpp.

RCP< const ParameterList > Thyra::MLPreconditionerFactory::getValidParameters

(

)

const

Definition at line 457 of file Thyra_MLPreconditionerFactory.cpp.

std::string Thyra::MLPreconditionerFactory::description

(

)

const

Definition at line 538 of file Thyra_MLPreconditionerFactory.cpp.

Member Data Documentation

Teuchos::RCP<Teuchos::ParameterList> Thyra::MLPreconditionerFactory::paramList_

private

Definition at line 101 of file Thyra_MLPreconditionerFactory.hpp.

---

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

• Thyra_MLPreconditionerFactory.hpp
• Thyra_MLPreconditionerFactory.cpp