Stratimikos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Types | List of all members
Thyra::Amesos2LinearOpWithSolveFactory< Scalar > Class Template Reference

#include <Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp>

Inherits LinearOpWithSolveFactoryBase< Scalar >.

Public Types

using ConverterT = typename Amesos2LinearOpWithSolve<Scalar>::ConverterT
 
using MAT = typename Amesos2LinearOpWithSolve<Scalar>::MAT
 
using MV = typename Amesos2LinearOpWithSolve<Scalar>::MV
 
using Solver = typename Amesos2LinearOpWithSolve<Scalar>::Solver
 

Parameter names for Paramter List

static const std::string SolverType_name = "Solver Type"
 
static const std::string RefactorizationPolicy_name = "Refactorization Policy"
 
static const std::string ThrowOnPreconditionerInput_name = "Throw on Preconditioner Input"
 
static const std::string Amesos2_Settings_name = "Amesos2 Settings"
 

Public functions overridden from Teuchos::Describable.

Amesos2::ESolverType solverType_
 
Amesos2::ERefactorizationPolicy refactorizationPolicy_
 
bool throwOnPrecInput_
 
Teuchos::RCP< Teuchos::ParameterList > paramList_
 
std::string description () const
 
static Teuchos::RCP< const Teuchos::ParameterList > generateAndGetValidParameters ()
 

Constructors/initializers/accessors

 ~Amesos2LinearOpWithSolveFactory ()
 
 Amesos2LinearOpWithSolveFactory (const Amesos2::ESolverType solverType=Amesos2::LAPACK, const Amesos2::ERefactorizationPolicy refactorizationPolicy=Amesos2::REPIVOT_ON_REFACTORIZATION, const bool throwOnPrecInput=true)
 Constructor which sets the defaults.
 

Overridden public functions from LinearOpWithSolveFactoryBase

bool isCompatible (const LinearOpSourceBase< Scalar > &fwdOpSrc) const
 
Teuchos::RCP< LinearOpWithSolveBase< Scalar > > createOp () const
 
void initializeOp (const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const
 
bool supportsPreconditionerInputType (const EPreconditionerInputType precOpType) const
 Returns false .
 
void initializePreconditionedOp (const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const Teuchos::RCP< const PreconditionerBase< Scalar > > &prec, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const
 Throws exception if this->throwOnPrecInput()==true and calls this->initializeOp(fwdOpSrc,Op) otherwise.
 
void initializePreconditionedOp (const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &approxFwdOpSrc, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const
 Throws exception if this->throwOnPrecInput()==true and calls this->initializeOp(fwdOpSrc,Op) otherwise.
 
void uninitializeOp (LinearOpWithSolveBase< Scalar > *Op, Teuchos::RCP< const LinearOpSourceBase< Scalar > > *fwdOpSrc, Teuchos::RCP< const PreconditionerBase< Scalar > > *prec, Teuchos::RCP< const LinearOpSourceBase< Scalar > > *approxFwdOpSrc, 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

template<typename Scalar>
class Thyra::Amesos2LinearOpWithSolveFactory< Scalar >

Definition at line 61 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

Member Typedef Documentation

◆ ConverterT

template<typename Scalar >
using Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::ConverterT = typename Amesos2LinearOpWithSolve<Scalar>::ConverterT

◆ MAT

template<typename Scalar >
using Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::MAT = typename Amesos2LinearOpWithSolve<Scalar>::MAT

◆ MV

template<typename Scalar >
using Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::MV = typename Amesos2LinearOpWithSolve<Scalar>::MV

◆ Solver

template<typename Scalar >
using Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::Solver = typename Amesos2LinearOpWithSolve<Scalar>::Solver

Constructor & Destructor Documentation

◆ ~Amesos2LinearOpWithSolveFactory()

template<typename Scalar >
Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::~Amesos2LinearOpWithSolveFactory ( )

◆ Amesos2LinearOpWithSolveFactory()

template<typename Scalar >
Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::Amesos2LinearOpWithSolveFactory ( const Amesos2::ESolverType solverType = Amesos2::LAPACK,
const Amesos2::ERefactorizationPolicy refactorizationPolicy = Amesos2::REPIVOT_ON_REFACTORIZATION,
const bool throwOnPrecInput = true )

Constructor which sets the defaults.

Definition at line 98 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

Member Function Documentation

◆ isCompatible()

template<typename Scalar >
bool Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::isCompatible ( const LinearOpSourceBase< Scalar > & fwdOpSrc) const

◆ createOp()

template<typename Scalar >
RCP< LinearOpWithSolveBase< Scalar > > Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::createOp ( ) const

◆ initializeOp()

template<typename Scalar >
void Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::initializeOp ( const Teuchos::RCP< const LinearOpSourceBase< Scalar > > & fwdOpSrc,
LinearOpWithSolveBase< Scalar > * Op,
const ESupportSolveUse supportSolveUse ) const

◆ supportsPreconditionerInputType()

template<typename Scalar >
bool Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::supportsPreconditionerInputType ( const EPreconditionerInputType precOpType) const

Returns false .

Definition at line 285 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

◆ initializePreconditionedOp() [1/2]

template<typename Scalar >
void Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::initializePreconditionedOp ( const Teuchos::RCP< const LinearOpSourceBase< Scalar > > & fwdOpSrc,
const Teuchos::RCP< const PreconditionerBase< Scalar > > & prec,
LinearOpWithSolveBase< Scalar > * Op,
const ESupportSolveUse supportSolveUse ) const

Throws exception if this->throwOnPrecInput()==true and calls this->initializeOp(fwdOpSrc,Op) otherwise.

◆ initializePreconditionedOp() [2/2]

template<typename Scalar >
void Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::initializePreconditionedOp ( const Teuchos::RCP< const LinearOpSourceBase< Scalar > > & fwdOpSrc,
const Teuchos::RCP< const LinearOpSourceBase< Scalar > > & approxFwdOpSrc,
LinearOpWithSolveBase< Scalar > * Op,
const ESupportSolveUse supportSolveUse ) const

Throws exception if this->throwOnPrecInput()==true and calls this->initializeOp(fwdOpSrc,Op) otherwise.

◆ uninitializeOp()

template<typename Scalar >
void Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::uninitializeOp ( LinearOpWithSolveBase< Scalar > * Op,
Teuchos::RCP< const LinearOpSourceBase< Scalar > > * fwdOpSrc,
Teuchos::RCP< const PreconditionerBase< Scalar > > * prec,
Teuchos::RCP< const LinearOpSourceBase< Scalar > > * approxFwdOpSrc,
ESupportSolveUse * supportSolveUse ) const

◆ setParameterList()

template<typename Scalar >
void Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::setParameterList ( Teuchos::RCP< Teuchos::ParameterList > const & paramList)

◆ getNonconstParameterList()

template<typename Scalar >
RCP< Teuchos::ParameterList > Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::getNonconstParameterList ( )

◆ unsetParameterList()

template<typename Scalar >
RCP< Teuchos::ParameterList > Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::unsetParameterList ( )

◆ getParameterList()

template<typename Scalar >
RCP< const Teuchos::ParameterList > Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::getParameterList ( ) const

◆ getValidParameters()

template<typename Scalar >
RCP< const Teuchos::ParameterList > Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::getValidParameters ( ) const

◆ description()

template<typename Scalar >
std::string Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::description ( ) const

◆ generateAndGetValidParameters()

template<typename Scalar >
RCP< const Teuchos::ParameterList > Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::generateAndGetValidParameters ( )
staticprivate

Member Data Documentation

◆ SolverType_name

template<typename Scalar >
const std::string Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::SolverType_name = "Solver Type"
static

◆ RefactorizationPolicy_name

template<typename Scalar >
const std::string Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::RefactorizationPolicy_name = "Refactorization Policy"
static

◆ ThrowOnPreconditionerInput_name

template<typename Scalar >
const std::string Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::ThrowOnPreconditionerInput_name = "Throw on Preconditioner Input"
static

◆ Amesos2_Settings_name

template<typename Scalar >
const std::string Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::Amesos2_Settings_name = "Amesos2 Settings"
static

◆ solverType_

template<typename Scalar >
Amesos2::ESolverType Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::solverType_
private

◆ refactorizationPolicy_

template<typename Scalar >
Amesos2::ERefactorizationPolicy Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::refactorizationPolicy_
private

◆ throwOnPrecInput_

template<typename Scalar >
bool Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::throwOnPrecInput_
private

◆ paramList_

template<typename Scalar >
Teuchos::RCP<Teuchos::ParameterList> Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::paramList_
private

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