Thyra::LinearSolverBuilderBase< Scalar > Class Template Reference

Abstract interface for an object that can create LinearOpWithSolveFactoryBase objects on demand. More...

#include <Thyra_LinearSolverBuilderBase.hpp>

Inheritance diagram for Thyra::LinearSolverBuilderBase< Scalar >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual Teuchos::RCP
< LinearOpWithSolveFactoryBase
< Scalar > > 
createLinearSolveStrategy (const std::string &linearSolveStrategyName) const =0
 Create a new LinearOpWithSolveFactoryBase object purely specified by the parameter list.
virtual Teuchos::RCP
< PreconditionerFactoryBase
< Scalar > > 
createPreconditioningStrategy (const std::string &preconditioningStrategyName) const =0
 Create a new PreconditionerFactoryBase object purely specified by the parameter list.

Private Member Functions

LinearSolverBuilderBase< Scalar > & operator= (const LinearSolverBuilderBase< Scalar > &)

Related Functions

(Note that these are not member functions.)



template<class Scalar >
Teuchos::RCP
< LinearOpWithSolveFactoryBase
< Scalar > > 
createLinearSolveStrategy (const LinearSolverBuilderBase< Scalar > &linearSolverBuilder, const std::string &linearSolveStrategyName="")
 
template<class Scalar >
Teuchos::RCP
< PreconditionerFactoryBase
< Scalar > > 
createPreconditioningStrategy (const LinearSolverBuilderBase< Scalar > &linearSolverBuilder, const std::string &preconditioningStrategyName="")
 

Detailed Description

template<class Scalar>
class Thyra::LinearSolverBuilderBase< Scalar >

Abstract interface for an object that can create LinearOpWithSolveFactoryBase objects on demand.

ToDo: Finish documentation!

Definition at line 47 of file Thyra_LinearSolverBuilderBase.hpp.


Member Function Documentation

template<class Scalar>
virtual Teuchos::RCP<LinearOpWithSolveFactoryBase<Scalar> > Thyra::LinearSolverBuilderBase< Scalar >::createLinearSolveStrategy ( const std::string &  linearSolveStrategyName  )  const [pure virtual]

Create a new LinearOpWithSolveFactoryBase object purely specified by the parameter list.

Parameters:
linearSolveStrategyName [in] The optional name of the linear solve strategy to create. The most typical use case will pass in an empty string but there will be cases where I client will want to try to select a specific linear solver strategy, even for just testing purposes.

This function is given no information about the nature of the linear operators to be used.

Referenced by Thyra::LinearSolverBuilderBase< Scalar >::createLinearSolveStrategy().

template<class Scalar>
virtual Teuchos::RCP<PreconditionerFactoryBase<Scalar> > Thyra::LinearSolverBuilderBase< Scalar >::createPreconditioningStrategy ( const std::string &  preconditioningStrategyName  )  const [pure virtual]

Create a new PreconditionerFactoryBase object purely specified by the parameter list.

Parameters:
preconditioningStrategyName [in] The optional name of the preconditioning strategy to create. The most typical use case will pass in an empty string but there will be cases where I client will want to try to select a specific linear solver strategy, even for just testing purposes.

This function is given no information about the nature of the linear operators to be used.

Referenced by Thyra::LinearSolverBuilderBase< Scalar >::createPreconditioningStrategy().

template<class Scalar>
LinearSolverBuilderBase<Scalar>& Thyra::LinearSolverBuilderBase< Scalar >::operator= ( const LinearSolverBuilderBase< Scalar > &   )  [private]

Friends And Related Function Documentation

template<class Scalar >
Teuchos::RCP< LinearOpWithSolveFactoryBase< Scalar > > createLinearSolveStrategy ( const LinearSolverBuilderBase< Scalar > &  linearSolverBuilder,
const std::string &  linearSolveStrategyName = "" 
) [related]
template<class Scalar >
Teuchos::RCP< PreconditionerFactoryBase< Scalar > > createPreconditioningStrategy ( const LinearSolverBuilderBase< Scalar > &  linearSolverBuilder,
const std::string &  preconditioningStrategyName = "" 
) [related]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:04:34 2011 for Thyra Package Browser (Single Doxygen Collection) by  doxygen 1.6.3