Implicit concrete LinearOpWithSolveBase subclass that takes a flattended out multi-vector and performs a multi-RHS solve with it. More...

#include <Thyra_DefaultMultiVectorLinearOpWithSolve_decl.hpp>

Inheritance diagram for Thyra::DefaultMultiVectorLinearOpWithSolve< Scalar >:

[legend]

Related Symbols
(Note that these are not member symbols.)
template<class Scalar>
RCP< DefaultMultiVectorLinearOpWithSolve< Scalar > >	multiVectorLinearOpWithSolve ()
	Nonmember constructor function.
template<class Scalar>
RCP< DefaultMultiVectorLinearOpWithSolve< Scalar > >	nonconstMultiVectorLinearOpWithSolve (const RCP< LinearOpWithSolveBase< Scalar > > &lows, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
	Nonmember constructor function.
template<class Scalar>
RCP< DefaultMultiVectorLinearOpWithSolve< Scalar > >	multiVectorLinearOpWithSolve (const RCP< const LinearOpWithSolveBase< Scalar > > &lows, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
	Nonmember constructor function.
Related Symbols inherited from Thyra::LinearOpWithSolveBase< Scalar >
template<class Scalar>
bool	solveSupports (const LinearOpWithSolveBase< Scalar > &A, const EOpTransp transp)
	Call solveSupports() as a non-member function.
template<class Scalar>
bool	solveSupports (const LinearOpWithSolveBase< Scalar > &A, const EOpTransp transp, const Ptr< const SolveCriteria< Scalar > > solveCriteria)
	Call solveSupports() as a non-member function.
template<class Scalar>
bool	solveSupportsSolveMeasureType (const LinearOpWithSolveBase< Scalar > &A, const EOpTransp transp, const SolveMeasureType &solveMeasureType)
	Call solveSupportsSolveMeasureType() as a non-member function.
template<class Scalar>
SolveStatus< Scalar >	solve (const LinearOpWithSolveBase< Scalar > &A, const EOpTransp A_trans, const MultiVectorBase< Scalar > &B, const Ptr< MultiVectorBase< Scalar > > &X, const Ptr< const SolveCriteria< Scalar > > solveCriteria=Teuchos::null)
	Call solve() as a non-member function.
template<class Scalar>
void	assertSolveSupports (const LinearOpWithSolveBase< Scalar > &lows, const EOpTransp M_trans, const Ptr< const SolveCriteria< Scalar > > solveCriteria=Teuchos::null)
	Assert that a LOWSB object supports a particular solve type.
Related Symbols inherited from Thyra::LinearOpBase< Scalar >
template<class Scalar>
bool	isFullyUninitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Fully Uninitialized" state or not.
template<class Scalar>
bool	isPartiallyInitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Partially Initialized" state or not.
template<class Scalar>
bool	isFullyInitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Fully Initialized" state or not.
template<class Scalar>
bool	opSupported (const LinearOpBase< Scalar > &M, EOpTransp M_trans)
	Determines if an operation is supported for a single scalar type.
template<class Scalar>
void	apply (const LinearOpBase< Scalar > &M, const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha=static_cast< Scalar >(1.0), const Scalar beta=static_cast< Scalar >(0.0))
	Non-member function call for M.apply(...).
void	apply (const LinearOpBase< double > &M, const EOpTransp M_trans, const MultiVectorBase< double > &X, const Ptr< MultiVectorBase< double > > &Y, const double alpha=1.0, const double beta=0.0)
	Calls apply<double>(...).

Overridden from LinearOpWithSolveBase
bool	solveSupportsImpl (EOpTransp M_trans) const
bool	solveSupportsSolveMeasureTypeImpl (EOpTransp M_trans, const SolveMeasureType &solveMeasureType) const
SolveStatus< Scalar >	solveImpl (const EOpTransp transp, const MultiVectorBase< Scalar > &B, const Ptr< MultiVectorBase< Scalar > > &X, const Ptr< const SolveCriteria< Scalar > > solveCriteria) const

Constructors/initializers/accessors
	DefaultMultiVectorLinearOpWithSolve ()
	Construct to uninitialized.
void	nonconstInitialize (const RCP< LinearOpWithSolveBase< Scalar > > &lows, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
void	initialize (const RCP< const LinearOpWithSolveBase< Scalar > > &lows, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
RCP< LinearOpWithSolveBase< Scalar > >	getNonconstLinearOpWithSolve ()
RCP< const LinearOpWithSolveBase< Scalar > >	getLinearOpWithSolve () const
void	uninitialize ()

Overridden from LinearOpBase
RCP< const VectorSpaceBase< Scalar > >	range () const
RCP< const VectorSpaceBase< Scalar > >	domain () const
RCP< const LinearOpBase< Scalar > >	clone () const
bool	opSupportedImpl (EOpTransp M_trans) const
void	applyImpl (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const

Additional Inherited Members
bool	solveSupports (EOpTransp transp) const
	Return if solve() supports the argument transp.
bool	solveSupports (EOpTransp transp, const Ptr< const SolveCriteria< Scalar > > solveCriteria) const
	Return if solve() supports a given transpose and solve criteria specification.
bool	solveSupportsSolveMeasureType (EOpTransp transp, const SolveMeasureType &solveMeasureType) const
	Return if solve() supports the given the solve measure type.
SolveStatus< Scalar >	solve (const EOpTransp A_trans, const MultiVectorBase< Scalar > &B, const Ptr< MultiVectorBase< Scalar > > &X, const Ptr< const SolveCriteria< Scalar > > solveCriteria=Teuchos::null) const
	Request the solution of a block linear system.
bool	opSupported (EOpTransp M_trans) const
	Return if the M_trans operation of apply() is supported or not.
void	apply (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
	Apply the linear operator to a multi-vector : Y = alphaop(M)X + beta*Y.
virtual bool	solveSupportsNewImpl (EOpTransp, const Ptr< const SolveCriteria< Scalar > >) const
	Virtual implementation of solveSupports().

Detailed Description

template<class Scalar>
class Thyra::DefaultMultiVectorLinearOpWithSolve< Scalar >

Implicit concrete LinearOpWithSolveBase subclass that takes a flattended out multi-vector and performs a multi-RHS solve with it.

ToDo: Finish documentation!

Definition at line 30 of file Thyra_DefaultMultiVectorLinearOpWithSolve_decl.hpp.

Constructor & Destructor Documentation

◆ DefaultMultiVectorLinearOpWithSolve()

template<class Scalar>

Thyra::DefaultMultiVectorLinearOpWithSolve< Scalar >::DefaultMultiVectorLinearOpWithSolve ( )

Construct to uninitialized.

Definition at line 29 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

Member Function Documentation

◆ nonconstInitialize()

template<class Scalar>

void Thyra::DefaultMultiVectorLinearOpWithSolve< Scalar >::nonconstInitialize	(	const RCP< LinearOpWithSolveBase< Scalar > > &	lows,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecRange,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecDomain )

Definition at line 34 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ initialize()

template<class Scalar>

void Thyra::DefaultMultiVectorLinearOpWithSolve< Scalar >::initialize	(	const RCP< const LinearOpWithSolveBase< Scalar > > &	lows,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecRange,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecDomain )

Definition at line 48 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ getNonconstLinearOpWithSolve()

template<class Scalar>

RCP< LinearOpWithSolveBase< Scalar > > Thyra::DefaultMultiVectorLinearOpWithSolve< Scalar >::getNonconstLinearOpWithSolve ( )

Definition at line 63 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ getLinearOpWithSolve()

template<class Scalar>

RCP< const LinearOpWithSolveBase< Scalar > > Thyra::DefaultMultiVectorLinearOpWithSolve< Scalar >::getLinearOpWithSolve ( ) const

Definition at line 71 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ uninitialize()

template<class Scalar>

void Thyra::DefaultMultiVectorLinearOpWithSolve< Scalar >::uninitialize ( )

Definition at line 78 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ range()

template<class Scalar>

RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultMultiVectorLinearOpWithSolve< Scalar >::range ( ) const

virtual

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 91 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ domain()

template<class Scalar>

RCP< const VectorSpaceBase< Scalar > > Thyra::DefaultMultiVectorLinearOpWithSolve< Scalar >::domain ( ) const

virtual

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 99 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ clone()

template<class Scalar>

RCP< const LinearOpBase< Scalar > > Thyra::DefaultMultiVectorLinearOpWithSolve< Scalar >::clone ( ) const

virtual

Reimplemented from Thyra::LinearOpBase< Scalar >.

Definition at line 107 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ opSupportedImpl()

template<class Scalar>

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

protectedvirtual

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 120 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ applyImpl()

template<class Scalar>

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

protectedvirtual

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 129 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ solveSupportsImpl()

template<class Scalar>

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

protectedvirtual

Reimplemented from Thyra::LinearOpWithSolveBase< Scalar >.

Definition at line 165 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ solveSupportsSolveMeasureTypeImpl()

template<class Scalar>

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

protectedvirtual

Reimplemented from Thyra::LinearOpWithSolveBase< Scalar >.

Definition at line 175 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ solveImpl()

template<class Scalar>

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

protectedvirtual

Implements Thyra::LinearOpWithSolveBase< Scalar >.

Definition at line 186 of file Thyra_DefaultMultiVectorLinearOpWithSolve_def.hpp.

◆ multiVectorLinearOpWithSolve() [1/2]

template<class Scalar>

RCP< DefaultMultiVectorLinearOpWithSolve< Scalar > > multiVectorLinearOpWithSolve ( )

Nonmember constructor function.

Definition at line 150 of file Thyra_DefaultMultiVectorLinearOpWithSolve_decl.hpp.

◆ nonconstMultiVectorLinearOpWithSolve()

template<class Scalar>

RCP< DefaultMultiVectorLinearOpWithSolve< Scalar > > nonconstMultiVectorLinearOpWithSolve	(	const RCP< LinearOpWithSolveBase< Scalar > > &	lows,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecRange,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecDomain )

Nonmember constructor function.

Definition at line 162 of file Thyra_DefaultMultiVectorLinearOpWithSolve_decl.hpp.

◆ multiVectorLinearOpWithSolve() [2/2]

template<class Scalar>

RCP< DefaultMultiVectorLinearOpWithSolve< Scalar > > multiVectorLinearOpWithSolve	(	const RCP< const LinearOpWithSolveBase< Scalar > > &	lows,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecRange,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecDomain )

Nonmember constructor function.

Definition at line 181 of file Thyra_DefaultMultiVectorLinearOpWithSolve_decl.hpp.

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

Related Symbols

Overridden from LinearOpWithSolveBase

Constructors/initializers/accessors

Overridden from LinearOpBase

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DefaultMultiVectorLinearOpWithSolve()

Member Function Documentation

◆ nonconstInitialize()

◆ initialize()

◆ getNonconstLinearOpWithSolve()

◆ getLinearOpWithSolve()

◆ uninitialize()

◆ range()

◆ domain()

◆ clone()

◆ opSupportedImpl()

◆ applyImpl()

◆ solveSupportsImpl()

◆ solveSupportsSolveMeasureTypeImpl()

◆ solveImpl()

Friends And Related Symbol Documentation

◆ multiVectorLinearOpWithSolve() [1/2]

◆ nonconstMultiVectorLinearOpWithSolve()

◆ multiVectorLinearOpWithSolve() [2/2]