Thyra  Version of the Day
Public Member Functions | Related Functions | List of all members
Thyra::LinearSolverBuilderBase< Scalar > Class Template Referenceabstract

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

#include <Thyra_LinearSolverBuilderBase.hpp>

Inherits ParameterListAcceptor.

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. More...
 
virtual Teuchos::RCP< PreconditionerFactoryBase< Scalar > > createPreconditioningStrategy (const std::string &preconditioningStrategyName) const =0
 Create a new PreconditionerFactoryBase object purely specified by the parameter list. More...
 

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 60 of file Thyra_LinearSolverBuilderBase.hpp.

Member Function Documentation

◆ createLinearSolveStrategy()

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.

◆ createPreconditioningStrategy()

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.

Friends And Related Function Documentation

◆ createLinearSolveStrategy()

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

Definition at line 151 of file Thyra_LinearSolverBuilderBase.hpp.

◆ createPreconditioningStrategy()

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

Definition at line 167 of file Thyra_LinearSolverBuilderBase.hpp.


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