Thyra::MLPreconditionerFactory Class Reference

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

List of all members.

Public Member Functions
Constructors/initializers/accessors
	MLPreconditionerFactory (const RCP< ParameterList > &params)
	MLPreconditionerFactory (const EMLProblemType &probType, const ParameterList &revisions=ParameterList())
	MLPreconditionerFactory (const std::string &probType, const ParameterList &revisions=ParameterList())
Overridden from PreconditionerFactoryBase
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	applySupportsConj (EConj conj) const
bool	applyTransposeSupportsConj (EConj conj) const
RCP< PreconditionerBase< double > >	createPrec () const
void	initializePrec (const RCP< const LinearOpBase< double > > &fwdOp, PreconditionerBase< double > *prec, const ESupportSolveUse supportSolveUse) const
void	uninitializePrec (PreconditionerBase< double > *prec, RCP< const LinearOpBase< double > > *fwdOp, ESupportSolveUse *supportSolveUse) const
Overridden from ParameterListAcceptor
void	setParameterList (RCP< ParameterList > const &paramList)
RCP< ParameterList >	getNonconstParameterList ()
RCP< ParameterList >	unsetParameterList ()
RCP< const ParameterList >	getParameterList () const
Public functions overridden from Describable.
std::string	description () const
Private Member Functions
RCP< ParameterList >	reviseDefaultList (const ParameterList &defaults, const ParameterList &revisions) const
std::string	probToString (const EMLProblemType &probType) const
RCP< ParameterList >	defaultParameters (const EMLProblemType &probType) const
RCP< ParameterList >	defaultParameters (const std::string &probType) const
Static Private Member Functions
static RCP< const ParameterList >	generateAndGetValidParameters ()
Private Attributes
RCP< ParameterList >	paramList_

---

Detailed Description

Concrete preconditioner factory subclass based on ML.

ToDo: Finish documentation!

Definition at line 56 of file Thyra_MLPreconditionerFactory.hpp.

---

Constructor & Destructor Documentation

MLPreconditionerFactory::MLPreconditionerFactory

(

const RCP< ParameterList > &

params

)

Definition at line 48 of file Thyra_MLPreconditionerFactory.cpp.

MLPreconditionerFactory::MLPreconditionerFactory	(	const EMLProblemType &	probType,
		const ParameterList &	revisions = ParameterList()
	)

Definition at line 54 of file Thyra_MLPreconditionerFactory.cpp.

MLPreconditionerFactory::MLPreconditionerFactory	(	const std::string &	probType,
		const ParameterList &	revisions = ParameterList()
	)

Definition at line 61 of file Thyra_MLPreconditionerFactory.cpp.

---

Member Function Documentation

bool MLPreconditionerFactory::applySupportsConj

(

EConj

conj

)

const

Definition at line 123 of file Thyra_MLPreconditionerFactory.cpp.

bool MLPreconditionerFactory::applyTransposeSupportsConj

(

EConj

conj

)

const

Definition at line 128 of file Thyra_MLPreconditionerFactory.cpp.

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

(

)

const

Definition at line 134 of file Thyra_MLPreconditionerFactory.cpp.

RCP< ParameterList > MLPreconditionerFactory::defaultParameters

(

const EMLProblemType &

probType

)

const [private]

Definition at line 84 of file Thyra_MLPreconditionerFactory.cpp.

RCP< ParameterList > MLPreconditionerFactory::defaultParameters

(

const std::string &

probType

)

const [private]

Definition at line 91 of file Thyra_MLPreconditionerFactory.cpp.

std::string MLPreconditionerFactory::description

(

)

const

Definition at line 327 of file Thyra_MLPreconditionerFactory.cpp.

static RCP<const ParameterList> Thyra::MLPreconditionerFactory::generateAndGetValidParameters

(

)

[static, private]

Teuchos::RCP< Teuchos::ParameterList > MLPreconditionerFactory::getNonconstParameterList

(

)

Definition at line 305 of file Thyra_MLPreconditionerFactory.cpp.

References paramList_.

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

(

)

const

Definition at line 319 of file Thyra_MLPreconditionerFactory.cpp.

References paramList_.

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

Definition at line 139 of file Thyra_MLPreconditionerFactory.cpp.

References paramList_, and totalTimer().

std::string MLPreconditionerFactory::probToString

(

const EMLProblemType &

probType

)

const [private]

Definition at line 68 of file Thyra_MLPreconditionerFactory.cpp.

References Thyra::ML_DomainDecomposition, Thyra::ML_DomainDecompositionML, and Thyra::ML_Maxwell.

RCP< ParameterList > MLPreconditionerFactory::reviseDefaultList	(	const ParameterList &	defaults,
		const ParameterList &	revisions
	)		const [private]

Definition at line 335 of file Thyra_MLPreconditionerFactory.cpp.

void MLPreconditionerFactory::setParameterList

(

RCP< ParameterList > const &

paramList

)

Definition at line 296 of file Thyra_MLPreconditionerFactory.cpp.

References paramList_.

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

Definition at line 285 of file Thyra_MLPreconditionerFactory.cpp.

Teuchos::RCP< Teuchos::ParameterList > MLPreconditionerFactory::unsetParameterList

(

)

Definition at line 311 of file Thyra_MLPreconditionerFactory.cpp.

References paramList_.

---

Member Data Documentation

RCP<ParameterList> Thyra::MLPreconditionerFactory::paramList_ [private]

Definition at line 145 of file Thyra_MLPreconditionerFactory.hpp.

Referenced by getNonconstParameterList(), getParameterList(), initializePrec(), setParameterList(), and unsetParameterList().