Stratimikos  Version of the Day
List of all members
Thyra::MLPreconditionerFactory Class Reference

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

#include <Thyra_MLPreconditionerFactory.hpp>

Inherits PreconditionerFactoryBase< double >.

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 57 of file Thyra_MLPreconditionerFactory.hpp.

Constructor & Destructor Documentation

◆ MLPreconditionerFactory()

Thyra::MLPreconditionerFactory::MLPreconditionerFactory ( )

Definition at line 117 of file Thyra_MLPreconditionerFactory.cpp.

Member Function Documentation

◆ STANDARD_COMPOSITION_MEMBERS()

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.

◆ isCompatible()

bool Thyra::MLPreconditionerFactory::isCompatible ( const LinearOpSourceBase< double > &  fwdOp) const

Definition at line 125 of file Thyra_MLPreconditionerFactory.cpp.

◆ applySupportsConj()

bool Thyra::MLPreconditionerFactory::applySupportsConj ( EConj  conj) const

Definition at line 150 of file Thyra_MLPreconditionerFactory.cpp.

◆ applyTransposeSupportsConj()

bool Thyra::MLPreconditionerFactory::applyTransposeSupportsConj ( EConj  conj) const

Definition at line 156 of file Thyra_MLPreconditionerFactory.cpp.

◆ createPrec()

RCP< PreconditionerBase< double > > Thyra::MLPreconditionerFactory::createPrec ( ) const

Definition at line 163 of file Thyra_MLPreconditionerFactory.cpp.

◆ initializePrec()

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

Definition at line 169 of file Thyra_MLPreconditionerFactory.cpp.

◆ uninitializePrec()

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

Definition at line 338 of file Thyra_MLPreconditionerFactory.cpp.

◆ setParameterList()

void Thyra::MLPreconditionerFactory::setParameterList ( Teuchos::RCP< Teuchos::ParameterList > const &  paramList)

Definition at line 351 of file Thyra_MLPreconditionerFactory.cpp.

◆ getNonconstParameterList()

RCP< ParameterList > Thyra::MLPreconditionerFactory::getNonconstParameterList ( )

Definition at line 396 of file Thyra_MLPreconditionerFactory.cpp.

◆ unsetParameterList()

RCP< ParameterList > Thyra::MLPreconditionerFactory::unsetParameterList ( )

Definition at line 403 of file Thyra_MLPreconditionerFactory.cpp.

◆ getParameterList()

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

Definition at line 412 of file Thyra_MLPreconditionerFactory.cpp.

◆ getValidParameters()

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

Definition at line 419 of file Thyra_MLPreconditionerFactory.cpp.

◆ description()

std::string Thyra::MLPreconditionerFactory::description ( ) const

Definition at line 527 of file Thyra_MLPreconditionerFactory.cpp.


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

Generated for Stratimikos by doxygen 1.8.14