Thyra::BelosLinearOpWithSolveFactory< Scalar > Class Template Reference
[Belos to Thyra Linear Solver Adapter Code]

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

#include <Thyra_BelosLinearOpWithSolveFactoryDecl.hpp>

List of all members.

Public types

typedef Teuchos::ScalarTraits<
Scalar >::magnitudeType 
MagnitudeType
 

Constructors/initializers/accessors

 BelosLinearOpWithSolveFactory ()
 Construct without preconditioner factory.
 BelosLinearOpWithSolveFactory (const Teuchos::RefCountPtr< PreconditionerFactoryBase< Scalar > > &precFactory)
 Calls this->setPreconditionerFactory(precFactory)</tt. .

Overridden public functions from LinearOpWithSolveFactoryBase

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

Overridden from ParameterListAcceptor

void setParameterList (Teuchos::RefCountPtr< Teuchos::ParameterList > const &paramList)
 
Teuchos::RefCountPtr< Teuchos::ParameterListgetParameterList ()
 
Teuchos::RefCountPtr< Teuchos::ParameterListunsetParameterList ()
 
Teuchos::RefCountPtr< const
Teuchos::ParameterList
getParameterList () const
 
Teuchos::RefCountPtr< const
Teuchos::ParameterList
getValidParameters () const
 

Public functions overridden from Teuchos::Describable.

std::string description () const
 

Parameter names for Paramter List

const std::string SolverType_name = "Solver Type"
 
const std::string SolverType_default = "GMRES"
 
const std::string MaxIters_name = "Max Iters"
 
const int MaxIters_default = 400
 
const std::string MaxRestarts_name = "Max Restarts"
 
const int MaxRestarts_default = 25
 
const std::string BlockSize_name = "Block Size"
 
const int BlockSize_default = 1
 
const std::string AdjustableBlockSize_name = "Adjustable Block Size"
 
const bool AdjustableBlockSize_default = true
 
const std::string DefaultRelResNorm_name = "Default Rel Res Norm"
 
const MagnitudeType DefaultRelResNorm_default = 1e-6
 
const std::string GMRES_name = "GMRES"
 
const std::string GMRES_MaxNumberOfKrylovVectors_name = "Max Number of Krylov Vectors"
 
const int GMRES_MaxNumberOfKrylovVectors_default = 300
 
const std::string GMRES_Variant_name = "Variant"
 
const std::string GMRES_Variant_default = "Standard"
 
const std::string Outputter_name = "Outputter"
 
const std::string Outputter_OutputFrequency_name = "Output Frequency"
 
const int Outputter_OutputFrequency_default = 10
 
const std::string Outputter_OutputMaxResOnly_name = "Output Max Res Only"
 
const bool Outputter_OutputMaxResOnly_default = true
 


Detailed Description

template<class Scalar>
class Thyra::BelosLinearOpWithSolveFactory< Scalar >

LinearOpWithSolveFactoryBase subclass implemented in terms of Belos.

ToDo: Finish Documentation!

Definition at line 21 of file Thyra_BelosLinearOpWithSolveFactoryDecl.hpp.


Member Typedef Documentation

template<class Scalar>
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Thyra::BelosLinearOpWithSolveFactory< Scalar >::MagnitudeType
 

Definition at line 28 of file Thyra_BelosLinearOpWithSolveFactoryDecl.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Thyra::BelosLinearOpWithSolveFactory< Scalar >::BelosLinearOpWithSolveFactory  ) 
 

Construct without preconditioner factory.

Definition at line 74 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
Thyra::BelosLinearOpWithSolveFactory< Scalar >::BelosLinearOpWithSolveFactory const Teuchos::RefCountPtr< PreconditionerFactoryBase< Scalar > > &  precFactory  ) 
 

Calls this->setPreconditionerFactory(precFactory)</tt. .

Definition at line 81 of file Thyra_BelosLinearOpWithSolveFactory.hpp.


Member Function Documentation

template<class Scalar>
bool Thyra::BelosLinearOpWithSolveFactory< Scalar >::acceptsPreconditionerFactory  )  const
 

Returns true .

Definition at line 92 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::setPreconditionerFactory const Teuchos::RefCountPtr< PreconditionerFactoryBase< Scalar > > &  precFactory,
const std::string &  precFactoryName
 

Definition at line 98 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
Teuchos::RefCountPtr< PreconditionerFactoryBase< Scalar > > Thyra::BelosLinearOpWithSolveFactory< Scalar >::getPreconditionerFactory  )  const
 

Definition at line 118 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::unsetPreconditionerFactory Teuchos::RefCountPtr< PreconditionerFactoryBase< Scalar > > *  precFactory,
std::string *  precFactoryName
 

Definition at line 124 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
bool Thyra::BelosLinearOpWithSolveFactory< Scalar >::isCompatible const LinearOpSourceBase< Scalar > &  fwdOpSrc  )  const
 

Definition at line 137 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
Teuchos::RefCountPtr< LinearOpWithSolveBase< Scalar > > Thyra::BelosLinearOpWithSolveFactory< Scalar >::createOp  )  const
 

Definition at line 148 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::initializeOp const Teuchos::RefCountPtr< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
LinearOpWithSolveBase< Scalar > *  Op,
const ESupportSolveUse  supportSolveUse
const
 

Definition at line 154 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::initializeAndReuseOp const Teuchos::RefCountPtr< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
LinearOpWithSolveBase< Scalar > *  Op
const
 

Definition at line 165 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::uninitializeOp LinearOpWithSolveBase< Scalar > *  Op,
Teuchos::RefCountPtr< const LinearOpSourceBase< Scalar > > *  fwdOpSrc,
Teuchos::RefCountPtr< const PreconditionerBase< Scalar > > *  prec,
Teuchos::RefCountPtr< const LinearOpSourceBase< Scalar > > *  approxFwdOpSrc,
ESupportSolveUse *  supportSolveUse
const
 

Definition at line 209 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
bool Thyra::BelosLinearOpWithSolveFactory< Scalar >::supportsPreconditionerInputType const EPreconditionerInputType  precOpType  )  const
 

Definition at line 175 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::initializePreconditionedOp const Teuchos::RefCountPtr< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
const Teuchos::RefCountPtr< const PreconditionerBase< Scalar > > &  prec,
LinearOpWithSolveBase< Scalar > *  Op,
const ESupportSolveUse  supportSolveUse
const
 

Definition at line 185 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::initializeApproxPreconditionedOp const Teuchos::RefCountPtr< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
const Teuchos::RefCountPtr< const LinearOpSourceBase< Scalar > > &  approxFwdOpSrc,
LinearOpWithSolveBase< Scalar > *  Op,
const ESupportSolveUse  supportSolveUse
const
 

Definition at line 197 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::setParameterList Teuchos::RefCountPtr< Teuchos::ParameterList > const &  paramList  ) 
 

Definition at line 242 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
Teuchos::RefCountPtr< Teuchos::ParameterList > Thyra::BelosLinearOpWithSolveFactory< Scalar >::getParameterList  ) 
 

Definition at line 267 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
Teuchos::RefCountPtr< Teuchos::ParameterList > Thyra::BelosLinearOpWithSolveFactory< Scalar >::unsetParameterList  ) 
 

Definition at line 274 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const Teuchos::ParameterList > Thyra::BelosLinearOpWithSolveFactory< Scalar >::getParameterList  )  const
 

Definition at line 283 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
Teuchos::RefCountPtr< const Teuchos::ParameterList > Thyra::BelosLinearOpWithSolveFactory< Scalar >::getValidParameters  )  const
 

Definition at line 290 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::description  )  const
 

Definition at line 298 of file Thyra_BelosLinearOpWithSolveFactory.hpp.


Member Data Documentation

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::SolverType_name = "Solver Type" [static]
 

Definition at line 26 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::SolverType_default = "GMRES" [static]
 

Definition at line 28 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::MaxIters_name = "Max Iters" [static]
 

Definition at line 30 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const int Thyra::BelosLinearOpWithSolveFactory< Scalar >::MaxIters_default = 400 [static]
 

Definition at line 32 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::MaxRestarts_name = "Max Restarts" [static]
 

Definition at line 34 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const int Thyra::BelosLinearOpWithSolveFactory< Scalar >::MaxRestarts_default = 25 [static]
 

Definition at line 36 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::BlockSize_name = "Block Size" [static]
 

Definition at line 38 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const int Thyra::BelosLinearOpWithSolveFactory< Scalar >::BlockSize_default = 1 [static]
 

Definition at line 40 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::AdjustableBlockSize_name = "Adjustable Block Size" [static]
 

Definition at line 42 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const bool Thyra::BelosLinearOpWithSolveFactory< Scalar >::AdjustableBlockSize_default = true [static]
 

Definition at line 44 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::DefaultRelResNorm_name = "Default Rel Res Norm" [static]
 

Definition at line 46 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const BelosLinearOpWithSolveFactory< Scalar >::MagnitudeType Thyra::BelosLinearOpWithSolveFactory< Scalar >::DefaultRelResNorm_default = 1e-6 [static]
 

Definition at line 49 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::GMRES_name = "GMRES" [static]
 

Definition at line 51 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::GMRES_MaxNumberOfKrylovVectors_name = "Max Number of Krylov Vectors" [static]
 

Definition at line 53 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const int Thyra::BelosLinearOpWithSolveFactory< Scalar >::GMRES_MaxNumberOfKrylovVectors_default = 300 [static]
 

Definition at line 55 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::GMRES_Variant_name = "Variant" [static]
 

Definition at line 57 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::GMRES_Variant_default = "Standard" [static]
 

Definition at line 59 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::Outputter_name = "Outputter" [static]
 

Definition at line 61 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::Outputter_OutputFrequency_name = "Output Frequency" [static]
 

Definition at line 63 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const int Thyra::BelosLinearOpWithSolveFactory< Scalar >::Outputter_OutputFrequency_default = 10 [static]
 

Definition at line 65 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::Outputter_OutputMaxResOnly_name = "Output Max Res Only" [static]
 

Definition at line 67 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar>
const bool Thyra::BelosLinearOpWithSolveFactory< Scalar >::Outputter_OutputMaxResOnly_default = true [static]
 

Definition at line 69 of file Thyra_BelosLinearOpWithSolveFactory.hpp.


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