Concrete LinearOpWithSolveBase subclass for diagonal linear operators. More...

#include <Thyra_DefaultDiagonalLinearOpWithSolve_decl.hpp>

Inheritance diagram for Thyra::DefaultDiagonalLinearOpWithSolve< Scalar >:

[legend]

Related Symbols
(Note that these are not member symbols.)
template<class Scalar >
RCP< DefaultDiagonalLinearOpWithSolve< Scalar > >	defaultDiagonalLinearOpWithSolve ()
	Nonmember constructor.

template<class Scalar >
RCP< DefaultDiagonalLinearOpWithSolve< Scalar > >	defaultDiagonalLinearOpWithSolve (const RCP< const VectorBase< Scalar > > &diag)
	Nonmember constructor.

Related Symbols inherited from Thyra::DefaultDiagonalLinearOp< Scalar >
template<class Scalar >
RCP< const LinearOpBase< Scalar > >	diagonal (const RCP< VectorBase< Scalar > > &diag, const std::string &label="")
	Nonmember constructor function.

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>(...)`.

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.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
SolveStatus< Scalar >	solve (const LinearOpWithSolveBase< Scalar > &A, const EOpTransp A_trans, const RCP< const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraB, const RCP< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &tpetraX, const Ptr< const SolveCriteria< Scalar > > solveCriteria=Teuchos::null)
	Call `solve()` as a non-member function.

Constructors/initializers/accessors
	DefaultDiagonalLinearOpWithSolve ()
	Constructs to uninitialized.

	DefaultDiagonalLinearOpWithSolve (const RCP< const VectorBase< Scalar > > &diag)
	Calls `initialize()`

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

Additional Inherited Members
Public Member Functions inherited from Thyra::DefaultDiagonalLinearOp< Scalar >
	DefaultDiagonalLinearOp ()
	Constructs to uninitialized.

	DefaultDiagonalLinearOp (const RCP< const VectorSpaceBase< Scalar > > &space)
	Calls `initialize()` to construct given a vector space.

	DefaultDiagonalLinearOp (const RCP< VectorBase< Scalar > > &diag)
	Calls `initialize()` to construct for a non-const diagonal vector.

	DefaultDiagonalLinearOp (const RCP< const VectorBase< Scalar > > &diag)
	Calls `initialize()` to construct for a const diagonal vector.

void	initialize (const RCP< const VectorSpaceBase< Scalar > > &space)
	Initialize given a vector space which allocates a vector internally.

void	initialize (const RCP< VectorBase< Scalar > > &diag)
	Initialize given a non-const diagonal vector.

void	initialize (const RCP< const VectorBase< Scalar > > &diag)
	Initialize given a const diagonal vector.

void	uninitialize ()
	Uninitialize.

bool	isDiagConst () const

RCP< VectorBase< Scalar > >	getNonconstDiag ()

RCP< const VectorBase< Scalar > >	getDiag () const

RCP< const VectorSpaceBase< Scalar > >	range () const
	Returns `this->getDiag()->space()`.

RCP< const VectorSpaceBase< Scalar > >	domain () const
	Returns `this->getDiag()->space()`.

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

Public Member Functions inherited from Thyra::DiagonalLinearOpBase< Scalar >
Public Member Functions inherited from Thyra::LinearOpBase< Scalar >
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`.

Public Member Functions inherited from Thyra::LinearOpWithSolveBase< Scalar >
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.

Protected Member Functions inherited from Thyra::DefaultDiagonalLinearOp< Scalar >
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

Protected Member Functions inherited from Thyra::LinearOpBase< Scalar >
Protected Member Functions inherited from Thyra::LinearOpWithSolveBase< Scalar >
virtual bool	solveSupportsNewImpl (EOpTransp, const Ptr< const SolveCriteria< Scalar > >) const
	Virtual implementation of `solveSupports()`.

Detailed Description

template<class Scalar>
class Thyra::DefaultDiagonalLinearOpWithSolve< Scalar >

Concrete LinearOpWithSolveBase subclass for diagonal linear operators.

This class represents a diagonal linear operator M of the form:

M = diag(diag)

where diag is a VectorBase object.

The defined operator implements this->apply() as follows:

y = alpha*op(M)*x + beta*y

=>

y(i) = alpha*diag(i)*x(i) + beta*y(i), for i = 0 ... n-1

where n = this->domain()->dim().

The defined operator implements this->solve() as follows:

x = inv(op(M))*b

=>

x(i) = b(i)/diag(i), for i = 0 ... n-1

where n = this->domain()->dim().

That is all there is to this subclass.

Definition at line 60 of file Thyra_DefaultDiagonalLinearOpWithSolve_decl.hpp.

Constructor & Destructor Documentation

◆ DefaultDiagonalLinearOpWithSolve() [1/2]

template<class Scalar >

Thyra::DefaultDiagonalLinearOpWithSolve< Scalar >::DefaultDiagonalLinearOpWithSolve ( )

Constructs to uninitialized.

Postconditions:

this->getDiag().get()==NULL

Definition at line 28 of file Thyra_DefaultDiagonalLinearOpWithSolve_def.hpp.

◆ DefaultDiagonalLinearOpWithSolve() [2/2]

template<class Scalar >

Thyra::DefaultDiagonalLinearOpWithSolve< Scalar >::DefaultDiagonalLinearOpWithSolve ( const RCP< const VectorBase< Scalar > > & diag )

Calls initialize()

Definition at line 33 of file Thyra_DefaultDiagonalLinearOpWithSolve_def.hpp.

Member Function Documentation

◆ solveSupportsImpl()

template<class Scalar >

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

protectedvirtual

Reimplemented from Thyra::LinearOpWithSolveBase< Scalar >.

Definition at line 49 of file Thyra_DefaultDiagonalLinearOpWithSolve_def.hpp.

◆ solveSupportsSolveMeasureTypeImpl()

template<class Scalar >

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

protectedvirtual

Reimplemented from Thyra::LinearOpWithSolveBase< Scalar >.

Definition at line 59 of file Thyra_DefaultDiagonalLinearOpWithSolve_def.hpp.

◆ solveImpl()

template<class Scalar >

SolveStatus< Scalar > Thyra::DefaultDiagonalLinearOpWithSolve< 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 68 of file Thyra_DefaultDiagonalLinearOpWithSolve_def.hpp.

Friends And Related Symbol Documentation

◆ defaultDiagonalLinearOpWithSolve() [1/2]

template<class Scalar >

RCP< DefaultDiagonalLinearOpWithSolve< Scalar > > defaultDiagonalLinearOpWithSolve ( )

Definition at line 109 of file Thyra_DefaultDiagonalLinearOpWithSolve_decl.hpp.

◆ defaultDiagonalLinearOpWithSolve() [2/2]

template<class Scalar >

RCP< DefaultDiagonalLinearOpWithSolve< Scalar > > defaultDiagonalLinearOpWithSolve ( const RCP< const VectorBase< Scalar > > & diag )

Definition at line 121 of file Thyra_DefaultDiagonalLinearOpWithSolve_decl.hpp.

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

Related Symbols

Constructors/initializers/accessors

Overridden from LinearOpWithSolveBase

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DefaultDiagonalLinearOpWithSolve() [1/2]

◆ DefaultDiagonalLinearOpWithSolve() [2/2]

Member Function Documentation

◆ solveSupportsImpl()

◆ solveSupportsSolveMeasureTypeImpl()

◆ solveImpl()

Friends And Related Symbol Documentation

◆ defaultDiagonalLinearOpWithSolve() [1/2]

◆ defaultDiagonalLinearOpWithSolve() [2/2]