Stratimikos Version of the Day
Thyra::MLPreconditionerFactory Class Reference

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

#include <Thyra_MLPreconditionerFactory.hpp>

Inheritance diagram for Thyra::MLPreconditionerFactory:
Inheritance graph
[legend]

List of all members.

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.

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.

ToDo: Finish documentation!

Definition at line 45 of file Thyra_MLPreconditionerFactory.hpp.


Constructor & Destructor Documentation

Thyra::MLPreconditionerFactory::MLPreconditionerFactory ( )

Definition at line 100 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 [virtual]
bool Thyra::MLPreconditionerFactory::applySupportsConj ( EConj  conj) const [virtual]

Reimplemented from Thyra::PreconditionerFactoryBase< double >.

Definition at line 133 of file Thyra_MLPreconditionerFactory.cpp.

bool Thyra::MLPreconditionerFactory::applyTransposeSupportsConj ( EConj  conj) const [virtual]

Reimplemented from Thyra::PreconditionerFactoryBase< double >.

Definition at line 139 of file Thyra_MLPreconditionerFactory.cpp.

RCP< PreconditionerBase< double > > Thyra::MLPreconditionerFactory::createPrec ( ) const [virtual]
void Thyra::MLPreconditionerFactory::initializePrec ( const Teuchos::RCP< const LinearOpSourceBase< double > > &  fwdOp,
PreconditionerBase< double > *  prec,
const ESupportSolveUse  supportSolveUse 
) const [virtual]
void Thyra::MLPreconditionerFactory::uninitializePrec ( PreconditionerBase< double > *  prec,
Teuchos::RCP< const LinearOpSourceBase< double > > *  fwdOp,
ESupportSolveUse supportSolveUse 
) const [virtual]
void Thyra::MLPreconditionerFactory::setParameterList ( Teuchos::RCP< Teuchos::ParameterList > const &  paramList) [virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 329 of file Thyra_MLPreconditionerFactory.cpp.

RCP< ParameterList > Thyra::MLPreconditionerFactory::getNonconstParameterList ( ) [virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 369 of file Thyra_MLPreconditionerFactory.cpp.

RCP< ParameterList > Thyra::MLPreconditionerFactory::unsetParameterList ( ) [virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 376 of file Thyra_MLPreconditionerFactory.cpp.

RCP< const ParameterList > Thyra::MLPreconditionerFactory::getParameterList ( ) const [virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 385 of file Thyra_MLPreconditionerFactory.cpp.

RCP< const ParameterList > Thyra::MLPreconditionerFactory::getValidParameters ( ) const [virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 392 of file Thyra_MLPreconditionerFactory.cpp.

std::string Thyra::MLPreconditionerFactory::description ( ) const [virtual]

Reimplemented from Teuchos::Describable.

Definition at line 495 of file Thyra_MLPreconditionerFactory.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends