Stratimikos Version of the Day
Loading...
Searching...
No Matches
List of all members
Thyra::AztecOOLinearOpWithSolveFactory Class Reference

LinearOpWithSolveFactoryBase subclass implemented in terms of AztecOO. More...

#include <Thyra_AztecOOLinearOpWithSolveFactory.hpp>

Inherits LinearOpWithSolveFactoryBase< double >.

Public functions overridden from Teuchos::Describable.

std::string description () const
 

Constructors/initializers/accessors

 AztecOOLinearOpWithSolveFactory (Teuchos::RCP< Teuchos::ParameterList > const &paramList=Teuchos::null)
 Construct uninitialized.
 
 STANDARD_COMPOSITION_MEMBERS (EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor)
 Set the strategy object used to extract an Epetra_Operator view of an input forward operator.
 

Overridden public functions from LinearOpWithSolveFactoryBase

bool acceptsPreconditionerFactory () const
 Returns true .
 
void setPreconditionerFactory (const Teuchos::RCP< PreconditionerFactoryBase< double > > &precFactory, const std::string &precFactoryName)
 
Teuchos::RCP< PreconditionerFactoryBase< double > > getPreconditionerFactory () const
 
void unsetPreconditionerFactory (Teuchos::RCP< PreconditionerFactoryBase< double > > *precFactory, std::string *precFactoryName)
 
bool isCompatible (const LinearOpSourceBase< double > &fwdOpSrc) const
 
Teuchos::RCP< LinearOpWithSolveBase< double > > createOp () const
 
void initializeOp (const Teuchos::RCP< const LinearOpSourceBase< double > > &fwdOpSrc, LinearOpWithSolveBase< double > *Op, const ESupportSolveUse supportSolveUse) const
 
void initializeAndReuseOp (const Teuchos::RCP< const LinearOpSourceBase< double > > &fwdOpSrc, LinearOpWithSolveBase< double > *Op) const
 
void uninitializeOp (LinearOpWithSolveBase< double > *Op, Teuchos::RCP< const LinearOpSourceBase< double > > *fwdOpSrc, Teuchos::RCP< const PreconditionerBase< double > > *prec, Teuchos::RCP< const LinearOpSourceBase< double > > *approxFwdOpSrc, ESupportSolveUse *supportSolveUse) const
 
bool supportsPreconditionerInputType (const EPreconditionerInputType precOpType) const
 
void initializePreconditionedOp (const Teuchos::RCP< const LinearOpSourceBase< double > > &fwdOpSrc, const Teuchos::RCP< const PreconditionerBase< double > > &prec, LinearOpWithSolveBase< double > *Op, const ESupportSolveUse supportSolveUse) const
 
void initializeApproxPreconditionedOp (const Teuchos::RCP< const LinearOpSourceBase< double > > &fwdOpSrc, const Teuchos::RCP< const LinearOpSourceBase< double > > &approxFwdOpSrc, LinearOpWithSolveBase< double > *Op, const ESupportSolveUse supportSolveUse) const
 

Overridden from 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
 

Detailed Description

LinearOpWithSolveFactoryBase subclass implemented in terms of AztecOO.

This class creates objects of type AztecOOLinearOpWithSolve (through the LinearOpWithSolveBase interface) using AztecOO objects.

The class can support both externally defined preconditioners and built-in aztec preconditioners. Then built-in aztec preconditioners are used (as specified by the input parameter list), *this only supports very limited functionality and does not support adjoint solves. However, when no preconditioning or externally defined preconditioners are used, *this supports a wide range of features which include:

Definition at line 79 of file Thyra_AztecOOLinearOpWithSolveFactory.hpp.

Constructor & Destructor Documentation

◆ AztecOOLinearOpWithSolveFactory()

Thyra::AztecOOLinearOpWithSolveFactory::AztecOOLinearOpWithSolveFactory ( Teuchos::RCP< Teuchos::ParameterList > const & paramList = Teuchos::null)

Construct uninitialized.

Definition at line 103 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

Member Function Documentation

◆ STANDARD_COMPOSITION_MEMBERS()

Thyra::AztecOOLinearOpWithSolveFactory::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.

◆ acceptsPreconditionerFactory()

bool Thyra::AztecOOLinearOpWithSolveFactory::acceptsPreconditionerFactory ( ) const

Returns true .

Definition at line 123 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ setPreconditionerFactory()

void Thyra::AztecOOLinearOpWithSolveFactory::setPreconditionerFactory ( const Teuchos::RCP< PreconditionerFactoryBase< double > > & precFactory,
const std::string & precFactoryName )

Definition at line 129 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ getPreconditionerFactory()

Teuchos::RCP< PreconditionerFactoryBase< double > > Thyra::AztecOOLinearOpWithSolveFactory::getPreconditionerFactory ( ) const

Definition at line 152 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ unsetPreconditionerFactory()

void Thyra::AztecOOLinearOpWithSolveFactory::unsetPreconditionerFactory ( Teuchos::RCP< PreconditionerFactoryBase< double > > * precFactory,
std::string * precFactoryName )

Definition at line 158 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ isCompatible()

bool Thyra::AztecOOLinearOpWithSolveFactory::isCompatible ( const LinearOpSourceBase< double > & fwdOpSrc) const

Definition at line 171 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ createOp()

Teuchos::RCP< LinearOpWithSolveBase< double > > Thyra::AztecOOLinearOpWithSolveFactory::createOp ( ) const

Definition at line 180 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ initializeOp()

void Thyra::AztecOOLinearOpWithSolveFactory::initializeOp ( const Teuchos::RCP< const LinearOpSourceBase< double > > & fwdOpSrc,
LinearOpWithSolveBase< double > * Op,
const ESupportSolveUse supportSolveUse ) const

Definition at line 186 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ initializeAndReuseOp()

void Thyra::AztecOOLinearOpWithSolveFactory::initializeAndReuseOp ( const Teuchos::RCP< const LinearOpSourceBase< double > > & fwdOpSrc,
LinearOpWithSolveBase< double > * Op ) const

Definition at line 196 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ uninitializeOp()

void Thyra::AztecOOLinearOpWithSolveFactory::uninitializeOp ( LinearOpWithSolveBase< double > * Op,
Teuchos::RCP< const LinearOpSourceBase< double > > * fwdOpSrc,
Teuchos::RCP< const PreconditionerBase< double > > * prec,
Teuchos::RCP< const LinearOpSourceBase< double > > * approxFwdOpSrc,
ESupportSolveUse * supportSolveUse ) const

Definition at line 253 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ supportsPreconditionerInputType()

bool Thyra::AztecOOLinearOpWithSolveFactory::supportsPreconditionerInputType ( const EPreconditionerInputType precOpType) const

Definition at line 205 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ initializePreconditionedOp()

void Thyra::AztecOOLinearOpWithSolveFactory::initializePreconditionedOp ( const Teuchos::RCP< const LinearOpSourceBase< double > > & fwdOpSrc,
const Teuchos::RCP< const PreconditionerBase< double > > & prec,
LinearOpWithSolveBase< double > * Op,
const ESupportSolveUse supportSolveUse ) const

Definition at line 228 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ initializeApproxPreconditionedOp()

void Thyra::AztecOOLinearOpWithSolveFactory::initializeApproxPreconditionedOp ( const Teuchos::RCP< const LinearOpSourceBase< double > > & fwdOpSrc,
const Teuchos::RCP< const LinearOpSourceBase< double > > & approxFwdOpSrc,
LinearOpWithSolveBase< double > * Op,
const ESupportSolveUse supportSolveUse ) const

Definition at line 240 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ setParameterList()

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

Definition at line 289 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ getNonconstParameterList()

Teuchos::RCP< Teuchos::ParameterList > Thyra::AztecOOLinearOpWithSolveFactory::getNonconstParameterList ( )

Definition at line 328 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ unsetParameterList()

Teuchos::RCP< Teuchos::ParameterList > Thyra::AztecOOLinearOpWithSolveFactory::unsetParameterList ( )

Definition at line 335 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ getParameterList()

Teuchos::RCP< const Teuchos::ParameterList > Thyra::AztecOOLinearOpWithSolveFactory::getParameterList ( ) const

Definition at line 344 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ getValidParameters()

Teuchos::RCP< const Teuchos::ParameterList > Thyra::AztecOOLinearOpWithSolveFactory::getValidParameters ( ) const

Definition at line 351 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

◆ description()

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

Definition at line 360 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.


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

Generated for Stratimikos by doxygen 1.10.0