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

Static Private Member Functions
static Teuchos::RCP< const Teuchos::ParameterList >	generateAndGetValidParameters ()

Private Attributes
Amesos2::ESolverType	solverType_
Amesos2::ERefactorizationPolicy	refactorizationPolicy_
bool	throwOnPrecInput_
Teuchos::RCP < Teuchos::ParameterList >	paramList_

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"

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. More...

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 . More...
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. More...
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. More...
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

Public functions overridden from Teuchos::Describable.
std::string	description () const

Detailed Description

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

Definition at line 61 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

Member Typedef Documentation

template<typename Scalar >

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

Definition at line 63 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

template<typename Scalar >

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

Definition at line 64 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

template<typename Scalar >

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

Definition at line 65 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

template<typename Scalar >

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

Definition at line 66 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

Constructor & Destructor Documentation

template<typename Scalar >

Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::~Amesos2LinearOpWithSolveFactory

(

)

Definition at line 87 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

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

template<typename Scalar >

bool Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::isCompatible

(

const LinearOpSourceBase< Scalar > &

fwdOpSrc

)

const

Definition at line 112 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

template<typename Scalar >

RCP< LinearOpWithSolveBase< Scalar > > Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::createOp

(

)

const

Definition at line 126 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

template<typename Scalar >

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

Definition at line 132 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

template<typename Scalar >

bool Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::supportsPreconditionerInputType

(

const EPreconditionerInputType

precOpType

)

const

Returns false .

Definition at line 285 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

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.

Definition at line 291 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

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.

Definition at line 309 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

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

Definition at line 327 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

template<typename Scalar >

void Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::setParameterList

(

Teuchos::RCP< Teuchos::ParameterList > const &

paramList

)

Definition at line 350 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

template<typename Scalar >

RCP< Teuchos::ParameterList > Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::getNonconstParameterList

(

)

Definition at line 381 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

template<typename Scalar >

RCP< Teuchos::ParameterList > Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::unsetParameterList

(

)

Definition at line 388 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

template<typename Scalar >

RCP< const Teuchos::ParameterList > Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::getParameterList

(

)

const

Definition at line 397 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

template<typename Scalar >

RCP< const Teuchos::ParameterList > Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::getValidParameters

(

)

const

Definition at line 404 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

template<typename Scalar >

std::string Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::description

(

)

const

Definition at line 412 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

template<typename Scalar >

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

staticprivate

Definition at line 425 of file Thyra_Amesos2LinearOpWithSolveFactory_def.hpp.

Member Data Documentation

template<typename Scalar >

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

static

Definition at line 72 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

template<typename Scalar >

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

static

Definition at line 74 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

template<typename Scalar >

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

static

Definition at line 76 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

template<typename Scalar >

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

static

Definition at line 78 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

template<typename Scalar >

Amesos2::ESolverType Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::solverType_

private

Definition at line 183 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

template<typename Scalar >

Amesos2::ERefactorizationPolicy Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::refactorizationPolicy_

private

Definition at line 184 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

template<typename Scalar >

bool Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::throwOnPrecInput_

private

Definition at line 185 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

template<typename Scalar >

Teuchos::RCP<Teuchos::ParameterList> Thyra::Amesos2LinearOpWithSolveFactory< Scalar >::paramList_

private

Definition at line 186 of file Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp.

---

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

• Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp
• Thyra_Amesos2LinearOpWithSolveFactory_def.hpp