Thyra::AztecOOLinearOpWithSolveFactory Class Reference
[AztecOO to Thyra Linear Solver Adapter Code]

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

#include <Thyra_AztecOOLinearOpWithSolveFactory.hpp>

List of all members.

Constructors/initializers/accessors

 AztecOOLinearOpWithSolveFactory (const int fwdDefaultMaxIterations=400, const double fwdDefaultTol=1e-6, const int adjDefaultMaxIterations=400, const double adjDefaultTol=1e-6)
 Construct uninitialized but with default option values.
void fwdDefaultMaxIterations (const int &fwdDefaultMaxIterations)
 The default maximum number of iterations for forward solves.
const int & fwdDefaultMaxIterations () const
void fwdDefaultTol (const double &fwdDefaultTol)
 The default solution tolerance on the residual for forward solves.
const double & fwdDefaultTol () const
void adjDefaultMaxIterations (const int &adjDefaultMaxIterations)
 The default maximum number of iterations for adjoint solves.
const int & adjDefaultMaxIterations () const
void adjDefaultTol (const double &adjDefaultTol)
 The default solution tolerance on the residual for adjoint solves.
const double & adjDefaultTol () const
void setFwdAztecSolveParameters (const Teuchos::RefCountPtr< Teuchos::ParameterList > &fwdSolveParamlist, bool fwd_cerr_warning_if_unused=false)
 Set the parameters that will be used for the forward aztec sovler.
void setAdjAztecSolveParameters (const Teuchos::RefCountPtr< Teuchos::ParameterList > &adjSolveParamlist, bool adj_cerr_warning_if_unused=false)
 Set the parameters that will be used for the adjoint aztec sovler.

Overridden public functions from LinearOpWithSolveFactoryBase

bool isCompatible (const LinearOpBase< double > &fwdOp) const
 
Teuchos::RefCountPtr< LinearOpWithSolveBase<
double > > 
createOp () const
 
void initializeOp (const Teuchos::RefCountPtr< const LinearOpBase< double > > &fwdOp, LinearOpWithSolveBase< double > *Op) const
 
void initializeAndReuseOp (const Teuchos::RefCountPtr< const LinearOpBase< double > > &fwdOp, LinearOpWithSolveBase< double > *Op) const
 
bool supportsPreconditionerInputType (const EPreconditionerInputType precOpType) const
 
void initializePreconditionedOp (const Teuchos::RefCountPtr< const LinearOpBase< double > > &fwdOp, const Teuchos::RefCountPtr< const LinearOpBase< double > > &precOp, const EPreconditionerInputType precOpType, LinearOpWithSolveBase< double > *Op) const
 
void uninitializeOp (LinearOpWithSolveBase< double > *Op, Teuchos::RefCountPtr< const LinearOpBase< double > > *fwdOp, Teuchos::RefCountPtr< const LinearOpBase< double > > *precOp, EPreconditionerInputType *precOpType) 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:

Warning: One must be very careful what options are set using the parameter lists passed in using setFwdAztecSolveParameters() and setAdjAztecSolveParameters() as some of these options will cause great problems and may even result in exit() being called to terminate your program! In the future, a new parameter sublist will be defined that will define a safer way to control the underlying aztec solvers.

Click on the above "examples" link at the top to see how this class is used.

Definition at line 74 of file Thyra_AztecOOLinearOpWithSolveFactory.hpp.


Constructor & Destructor Documentation

Thyra::AztecOOLinearOpWithSolveFactory::AztecOOLinearOpWithSolveFactory const int  fwdDefaultMaxIterations = 400,
const double  fwdDefaultTol = 1e-6,
const int  adjDefaultMaxIterations = 400,
const double  adjDefaultTol = 1e-6
 

Construct uninitialized but with default option values.

Note, these defaults where taken from NOX::EpetraNew::LinearSystemAztecOO::applyJacobianInverse(...) on 2005/08/15.

Definition at line 44 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.


Member Function Documentation

void Thyra::AztecOOLinearOpWithSolveFactory::fwdDefaultMaxIterations const int &  fwdDefaultMaxIterations  )  [inline]
 

The default maximum number of iterations for forward solves.

Definition at line 94 of file Thyra_AztecOOLinearOpWithSolveFactory.hpp.

const int& Thyra::AztecOOLinearOpWithSolveFactory::fwdDefaultMaxIterations  )  const [inline]
 

Definition at line 94 of file Thyra_AztecOOLinearOpWithSolveFactory.hpp.

void Thyra::AztecOOLinearOpWithSolveFactory::fwdDefaultTol const double &  fwdDefaultTol  )  [inline]
 

The default solution tolerance on the residual for forward solves.

Definition at line 96 of file Thyra_AztecOOLinearOpWithSolveFactory.hpp.

const double& Thyra::AztecOOLinearOpWithSolveFactory::fwdDefaultTol  )  const [inline]
 

Definition at line 96 of file Thyra_AztecOOLinearOpWithSolveFactory.hpp.

void Thyra::AztecOOLinearOpWithSolveFactory::adjDefaultMaxIterations const int &  adjDefaultMaxIterations  )  [inline]
 

The default maximum number of iterations for adjoint solves.

Definition at line 98 of file Thyra_AztecOOLinearOpWithSolveFactory.hpp.

const int& Thyra::AztecOOLinearOpWithSolveFactory::adjDefaultMaxIterations  )  const [inline]
 

Definition at line 98 of file Thyra_AztecOOLinearOpWithSolveFactory.hpp.

void Thyra::AztecOOLinearOpWithSolveFactory::adjDefaultTol const double &  adjDefaultTol  )  [inline]
 

The default solution tolerance on the residual for adjoint solves.

Definition at line 100 of file Thyra_AztecOOLinearOpWithSolveFactory.hpp.

const double& Thyra::AztecOOLinearOpWithSolveFactory::adjDefaultTol  )  const [inline]
 

Definition at line 100 of file Thyra_AztecOOLinearOpWithSolveFactory.hpp.

void Thyra::AztecOOLinearOpWithSolveFactory::setFwdAztecSolveParameters const Teuchos::RefCountPtr< Teuchos::ParameterList > &  fwdSolveParamlist,
bool  fwd_cerr_warning_if_unused = false
 

Set the parameters that will be used for the forward aztec sovler.

See AztecOO::SetParameters() for what options these are!

Definition at line 56 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

void Thyra::AztecOOLinearOpWithSolveFactory::setAdjAztecSolveParameters const Teuchos::RefCountPtr< Teuchos::ParameterList > &  adjSolveParamlist,
bool  adj_cerr_warning_if_unused = false
 

Set the parameters that will be used for the adjoint aztec sovler.

See AztecOO::SetParameters() for what options these are!

Definition at line 65 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

bool Thyra::AztecOOLinearOpWithSolveFactory::isCompatible const LinearOpBase< double > &  fwdOp  )  const
 

Definition at line 76 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

Teuchos::RefCountPtr< LinearOpWithSolveBase< double > > Thyra::AztecOOLinearOpWithSolveFactory::createOp  )  const
 

Definition at line 91 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

void Thyra::AztecOOLinearOpWithSolveFactory::initializeOp const Teuchos::RefCountPtr< const LinearOpBase< double > > &  fwdOp,
LinearOpWithSolveBase< double > *  Op
const
 

Definition at line 96 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

void Thyra::AztecOOLinearOpWithSolveFactory::initializeAndReuseOp const Teuchos::RefCountPtr< const LinearOpBase< double > > &  fwdOp,
LinearOpWithSolveBase< double > *  Op
const
 

Definition at line 104 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

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

Definition at line 112 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

void Thyra::AztecOOLinearOpWithSolveFactory::initializePreconditionedOp const Teuchos::RefCountPtr< const LinearOpBase< double > > &  fwdOp,
const Teuchos::RefCountPtr< const LinearOpBase< double > > &  precOp,
const EPreconditionerInputType  precOpType,
LinearOpWithSolveBase< double > *  Op
const
 

Definition at line 130 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.

void Thyra::AztecOOLinearOpWithSolveFactory::uninitializeOp LinearOpWithSolveBase< double > *  Op,
Teuchos::RefCountPtr< const LinearOpBase< double > > *  fwdOp,
Teuchos::RefCountPtr< const LinearOpBase< double > > *  precOp,
EPreconditionerInputType precOpType
const
 

Definition at line 141 of file Thyra_AztecOOLinearOpWithSolveFactory.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:38:53 2008 for Aztecoo/Thyra Linear Solver Adapter Software by doxygen 1.3.9.1