Teko  Version of the Day
 All Classes Files Functions Variables Pages
Public Member Functions | List of all members
Teko::StratimikosFactory Class Reference

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

#include <Teko_StratimikosFactory.hpp>

Inherits PreconditionerFactoryBase< double >.

Public Member Functions

void initializePrec_Thyra (const Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > &fwdOp, Thyra::PreconditionerBase< double > *prec, const Thyra::ESupportSolveUse supportSolveUse) const
 
void initializePrec_Epetra (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. More...
 
Constructors/initializers/accessors
 StratimikosFactory ()
 
 StratimikosFactory (const Teuchos::RCP< Teko::RequestHandler > &rh)
 
 StratimikosFactory (const Teuchos::RCP< Stratimikos::DefaultLinearSolverBuilder > &builder, const Teuchos::RCP< Teko::RequestHandler > &rh)
 
 STANDARD_COMPOSITION_MEMBERS (Thyra::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 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
 

Detailed Description

Concrete preconditioner factory subclass based on ML.

ToDo: Finish documentation!

Definition at line 22 of file Teko_StratimikosFactory.hpp.

Constructor & Destructor Documentation

Teko::StratimikosFactory::StratimikosFactory ( )

Definition at line 59 of file Teko_StratimikosFactory.cpp.

Member Function Documentation

Teko::StratimikosFactory::STANDARD_COMPOSITION_MEMBERS ( Thyra::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 Teko::StratimikosFactory::isCompatible ( const Thyra::LinearOpSourceBase< double > &  fwdOp) const

Definition at line 79 of file Teko_StratimikosFactory.cpp.

bool Teko::StratimikosFactory::applySupportsConj ( Thyra::EConj  conj) const

Definition at line 109 of file Teko_StratimikosFactory.cpp.

bool Teko::StratimikosFactory::applyTransposeSupportsConj ( Thyra::EConj  conj) const

Definition at line 115 of file Teko_StratimikosFactory.cpp.

Teuchos::RCP< Thyra::PreconditionerBase< double > > Teko::StratimikosFactory::createPrec ( ) const

Definition at line 122 of file Teko_StratimikosFactory.cpp.

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

Definition at line 128 of file Teko_StratimikosFactory.cpp.

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

Definition at line 407 of file Teko_StratimikosFactory.cpp.

void Teko::StratimikosFactory::setParameterList ( Teuchos::RCP< Teuchos::ParameterList > const &  paramList)

Definition at line 420 of file Teko_StratimikosFactory.cpp.

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

Definition at line 433 of file Teko_StratimikosFactory.cpp.

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

Definition at line 440 of file Teko_StratimikosFactory.cpp.

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

Definition at line 449 of file Teko_StratimikosFactory.cpp.

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

Definition at line 456 of file Teko_StratimikosFactory.cpp.

std::string Teko::StratimikosFactory::description ( ) const

Definition at line 573 of file Teko_StratimikosFactory.cpp.

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 142 of file Teko_StratimikosFactory.cpp.

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

Setup an epetra preconditioner.

Definition at line 244 of file Teko_StratimikosFactory.cpp.

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

Access to the application communication request handling mechnism

Definition at line 118 of file Teko_StratimikosFactory.hpp.

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

Access to the application communication request handling mechnism

Definition at line 123 of file Teko_StratimikosFactory.hpp.

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

Get the decomposition vector in use by this factory.

Definition at line 127 of file Teko_StratimikosFactory.hpp.


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