Concrete LinearOpWithSolveBase subclass in terms of Amesos2. More...

#include <Thyra_Amesos2LinearOpWithSolve_decl.hpp>

Inherits LinearOpWithSolveBase< Scalar >.

Public Types
using	MAT = Tpetra::CrsMatrix< Scalar >

using	Op = Tpetra::Operator< Scalar >

using	MV = Tpetra::MultiVector< Scalar >

using	Solver = ::Amesos2::Solver< MAT, MV >

using	ConverterT = TpetraOperatorVectorExtraction< Scalar >

Private Member Functions
void	assertInitialized () const

Private Attributes
Teuchos::RCP< const LinearOpBase< Scalar > >	fwdOp_

Teuchos::RCP< const LinearOpSourceBase< Scalar > >	fwdOpSrc_

Teuchos::RCP< Solver >	amesos2Solver_

Constructors/initializers/accessors
	Amesos2LinearOpWithSolve ()
	Construct to uninitialized. More...

	Amesos2LinearOpWithSolve (const Teuchos::RCP< const LinearOpBase< Scalar > > &fwdOp, const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const Teuchos::RCP< Solver > &amesos2Solver, const EOpTransp amesos2SolverTransp, const Scalar amesos2SolverScalar)
	Calls `this->initialize()`. More...

void	initialize (const Teuchos::RCP< const LinearOpBase< Scalar > > &fwdOp, const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const Teuchos::RCP< Solver > &amesos2Solver)
	Initialize after construction. More...

Teuchos::RCP< const LinearOpSourceBase< Scalar > >	extract_fwdOpSrc ()
	Extract the forward `LinearOpSourceBase<double>` object so that it can be modified and remove it from this object. More...

Teuchos::RCP< const LinearOpBase< Scalar > >	get_fwdOp () const

Teuchos::RCP< Solver >	get_amesos2Solver ()

Teuchos::RCP< const LinearOpSourceBase< Scalar > >	get_fwdOpSrc () const

Overridden public functions from LinearOpBase
Teuchos::RCP< const VectorSpaceBase< Scalar > >	range () const

Teuchos::RCP< const VectorSpaceBase< Scalar > >	domain () const

Teuchos::RCP< const LinearOpBase< Scalar > >	clone () const

Overridden public functions from Teuchos::Describable
std::string	description () const

void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

Overridden from LinearOpBase
virtual bool	opSupportedImpl (EOpTransp M_trans) const

virtual void	applyImpl (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const

Overridden from LinearOpWithSolveBase.
virtual bool	solveSupportsImpl (EOpTransp M_trans) const

virtual bool	solveSupportsSolveMeasureTypeImpl (EOpTransp M_trans, const SolveMeasureType &solveMeasureType) const

SolveStatus< Scalar >	solveImpl (const EOpTransp M_trans, const MultiVectorBase< Scalar > &B, const Ptr< MultiVectorBase< Scalar > > &X, const Ptr< const SolveCriteria< Scalar > > solveCriteria) const

Detailed Description

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

Concrete LinearOpWithSolveBase subclass in terms of Amesos2.

ToDo: Finish documentation!

Definition at line 38 of file Thyra_Amesos2LinearOpWithSolve_decl.hpp.

Member Typedef Documentation

template<typename Scalar>

using Thyra::Amesos2LinearOpWithSolve< Scalar >::MAT = Tpetra::CrsMatrix<Scalar>

Definition at line 41 of file Thyra_Amesos2LinearOpWithSolve_decl.hpp.

template<typename Scalar>

using Thyra::Amesos2LinearOpWithSolve< Scalar >::Op = Tpetra::Operator<Scalar>

Definition at line 42 of file Thyra_Amesos2LinearOpWithSolve_decl.hpp.

template<typename Scalar>

using Thyra::Amesos2LinearOpWithSolve< Scalar >::MV = Tpetra::MultiVector<Scalar>

Definition at line 43 of file Thyra_Amesos2LinearOpWithSolve_decl.hpp.

template<typename Scalar>

using Thyra::Amesos2LinearOpWithSolve< Scalar >::Solver = ::Amesos2::Solver<MAT, MV>

Definition at line 44 of file Thyra_Amesos2LinearOpWithSolve_decl.hpp.

template<typename Scalar>

using Thyra::Amesos2LinearOpWithSolve< Scalar >::ConverterT = TpetraOperatorVectorExtraction<Scalar>

Definition at line 45 of file Thyra_Amesos2LinearOpWithSolve_decl.hpp.

Constructor & Destructor Documentation

template<typename Scalar >

Thyra::Amesos2LinearOpWithSolve< Scalar >::Amesos2LinearOpWithSolve ( )

Construct to uninitialized.

Definition at line 23 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

Thyra::Amesos2LinearOpWithSolve< Scalar >::Amesos2LinearOpWithSolve	(	const Teuchos::RCP< const LinearOpBase< Scalar > > &	fwdOp,
		const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &	fwdOpSrc,
		const Teuchos::RCP< Solver > &	amesos2Solver,
		const EOpTransp	amesos2SolverTransp,
		const Scalar	amesos2SolverScalar
	)

Calls this->initialize().

Definition at line 28 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

Member Function Documentation

template<typename Scalar >

void Thyra::Amesos2LinearOpWithSolve< Scalar >::initialize	(	const Teuchos::RCP< const LinearOpBase< Scalar > > &	fwdOp,
		const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &	fwdOpSrc,
		const Teuchos::RCP< Solver > &	amesos2Solver
	)

Initialize after construction.

Definition at line 41 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

Teuchos::RCP< const LinearOpSourceBase< Scalar > > Thyra::Amesos2LinearOpWithSolve< Scalar >::extract_fwdOpSrc ( )

Extract the forward LinearOpSourceBase<double> object so that it can be modified and remove it from this object.

Postconditions:

return.get() is the same as this->get_fwdOpSrc().get() before call.
this->get_fwdOpSrc().get()==NULL

Definition at line 58 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

Teuchos::RCP< const LinearOpBase< Scalar > > Thyra::Amesos2LinearOpWithSolve< Scalar >::get_fwdOp ( ) const

inline

Definition at line 158 of file Thyra_Amesos2LinearOpWithSolve_decl.hpp.

template<typename Scalar >

Teuchos::RCP< typename Amesos2LinearOpWithSolve< Scalar >::Solver > Thyra::Amesos2LinearOpWithSolve< Scalar >::get_amesos2Solver ( )

inline

Definition at line 166 of file Thyra_Amesos2LinearOpWithSolve_decl.hpp.

template<typename Scalar >

Teuchos::RCP< const LinearOpSourceBase< Scalar > > Thyra::Amesos2LinearOpWithSolve< Scalar >::get_fwdOpSrc ( ) const

inline

Definition at line 174 of file Thyra_Amesos2LinearOpWithSolve_decl.hpp.

template<typename Scalar >

Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::Amesos2LinearOpWithSolve< Scalar >::range ( ) const

Definition at line 72 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::Amesos2LinearOpWithSolve< Scalar >::domain ( ) const

Definition at line 80 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

Teuchos::RCP< const LinearOpBase< Scalar > > Thyra::Amesos2LinearOpWithSolve< Scalar >::clone ( ) const

Definition at line 88 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

std::string Thyra::Amesos2LinearOpWithSolve< Scalar >::description ( ) const

Definition at line 98 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

void Thyra::Amesos2LinearOpWithSolve< Scalar >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel
	)		const

Definition at line 112 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

bool Thyra::Amesos2LinearOpWithSolve< Scalar >::opSupportedImpl ( EOpTransp M_trans ) const

protectedvirtual

Definition at line 155 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

void Thyra::Amesos2LinearOpWithSolve< Scalar >::applyImpl	(	const EOpTransp	M_trans,
		const MultiVectorBase< Scalar > &	X,
		const Ptr< MultiVectorBase< Scalar > > &	Y,
		const Scalar	alpha,
		const Scalar	beta
	)		const

protectedvirtual

Definition at line 162 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

bool Thyra::Amesos2LinearOpWithSolve< Scalar >::solveSupportsImpl ( EOpTransp M_trans ) const

protectedvirtual

Definition at line 177 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

bool Thyra::Amesos2LinearOpWithSolve< Scalar >::solveSupportsSolveMeasureTypeImpl	(	EOpTransp	M_trans,
		const SolveMeasureType &	solveMeasureType
	)		const

protectedvirtual

Definition at line 189 of file Thyra_Amesos2LinearOpWithSolve_def.hpp.

template<typename Scalar >

SolveStatus< Scalar > Thyra::Amesos2LinearOpWithSolve< Scalar >::solveImpl	(	const EOpTransp	M_trans,
		const MultiVectorBase< Scalar > &	B,
		const Ptr< MultiVectorBase< Scalar > > &	X,
		const Ptr< const SolveCriteria< Scalar > >	solveCriteria
	)		const