Implicit subclass that takes a blocked triangular LOWB object and turns it into a LOWSB object. More...

#include <Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp>

Inheritance diagram for Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >:

Related Symbols
(Note that these are not member symbols.)
template<class Scalar >
RCP< BlockedTriangularLinearOpWithSolveFactory< Scalar > >	blockedTriangularLinearOpWithSolveFactory (const Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > > &lowsf)
	Nonmember constructor.

template<class Scalar >
RCP< BlockedTriangularLinearOpWithSolveFactory< Scalar > >	blockedTriangularLinearOpWithSolveFactory (const Array< RCP< const LinearOpWithSolveFactoryBase< Scalar > > > &lowsf)
	Nonmember constructor.

Overridden from LinearOpWithSolveFactoyBase
typedef Teuchos::ConstNonconstObjectContainer< LinearOpWithSolveFactoryBase< Scalar > >	LOWSF_t

Array< LOWSF_t >	lowsf_

virtual bool	acceptsPreconditionerFactory () const
	returns false.

virtual void	setPreconditionerFactory (const RCP< PreconditionerFactoryBase< Scalar > > &precFactory, const std::string &precFactoryName)
	Throws exception.

virtual RCP< PreconditionerFactoryBase< Scalar > >	getPreconditionerFactory () const
	Returns null .

virtual void	unsetPreconditionerFactory (RCP< PreconditionerFactoryBase< Scalar > > precFactory, std::string precFactoryName)
	Throws exception.

virtual bool	isCompatible (const LinearOpSourceBase< Scalar > &fwdOpSrc) const

virtual RCP< LinearOpWithSolveBase< Scalar > >	createOp () const

virtual void	initializeOp (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const

virtual void	initializeAndReuseOp (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, LinearOpWithSolveBase< Scalar > *Op) const

virtual void	uninitializeOp (LinearOpWithSolveBase< Scalar > Op, RCP< const LinearOpSourceBase< Scalar > > fwdOpSrc, RCP< const PreconditionerBase< Scalar > > prec, RCP< const LinearOpSourceBase< Scalar > > approxFwdOpSrc, ESupportSolveUse *supportSolveUse) const

virtual bool	supportsPreconditionerInputType (const EPreconditionerInputType precOpType) const

virtual void	initializePreconditionedOp (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const RCP< const PreconditionerBase< Scalar > > &prec, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const

virtual void	initializeApproxPreconditionedOp (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const RCP< const LinearOpSourceBase< Scalar > > &approxFwdOpSrc, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const

void	informUpdatedVerbosityState () const
	Overridden from Teuchos::VerboseObjectBase.

	BlockedTriangularLinearOpWithSolveFactory ()

Overridden from Constructors/Initializers/Accessors
	BlockedTriangularLinearOpWithSolveFactory (const Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > > &lowsf)
	Create given an array of non-const LOWSFB objects.

	BlockedTriangularLinearOpWithSolveFactory (const Array< RCP< const LinearOpWithSolveFactoryBase< Scalar > > > &lowsf)
	Create given an array of const LOWSFB objects.

Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > >	getUnderlyingLOWSF ()

Array< RCP< const LinearOpWithSolveFactoryBase< Scalar > > >	getUnderlyingLOWSF () const

Overridden from Teuchos::Describable.
std::string	description () const

Overridden from ParameterListAcceptor (simple forwarding functions)
void	setParameterList (RCP< ParameterList > const &paramList)

RCP< ParameterList >	getNonconstParameterList ()

RCP< ParameterList >	unsetParameterList ()

RCP< const ParameterList >	getParameterList () const

RCP< const ParameterList >	getValidParameters () const

Detailed Description

template<class Scalar>
class Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >

Implicit subclass that takes a blocked triangular LOWB object and turns it into a LOWSB object.

This class takes any upper or lower triangular PhysicallyBlockedLinearOpBase object and compatible LinearOpWithSolveFactoryBase object(s) and creates a LOWSB version by creating LOWSB objects along the diagonal.

For example, consider the lower block triangular linear operator:

      [ M(0,0)                   ]
  M = [ M(1,0)   M(1,1)          ]
      [ M(2,0)   M(2,1)   M(2,2) ]

This class object will then create a new LOWSB object (of type DefaultBlockedTriangularLinearOpWithSolve) that looks like:

         [ invM(0,0)                       ]
  invM = [ M(1,0)     invM(1,1)            ]
         [ M(2,0)     M(2,1)     invM(2,2) ]

where invM(k,k) are LOWSB objects created from the LOB objects M(k,k) given a LOWSFB object.

This class is not very compliciated, see the function initializeOp() see what this class actually does!

Note, this is basically the same as DefaultBlockedTriangularLinearOpWithSolveFactory except this version allows you to set a different LOWSF for each diagonal block.

Definition at line 62 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

Member Typedef Documentation

◆ LOWSF_t

template<class Scalar >

typedef Teuchos::ConstNonconstObjectContainer< LinearOpWithSolveFactoryBase<Scalar> > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::LOWSF_t

private

Definition at line 188 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

Constructor & Destructor Documentation

◆ BlockedTriangularLinearOpWithSolveFactory() [1/3]

template<class Scalar >

Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::BlockedTriangularLinearOpWithSolveFactory ( const Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > > & lowsf )

Create given an array of non-const LOWSFB objects.

Parameters

lowsf [in,persisting] The LOWSFB objects that will be used to create the LOWSB objects for the diagonal blocks.

Preconditions:

!is_null(lowsf)

Definition at line 225 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ BlockedTriangularLinearOpWithSolveFactory() [2/3]

template<class Scalar >

Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::BlockedTriangularLinearOpWithSolveFactory ( const Array< RCP< const LinearOpWithSolveFactoryBase< Scalar > > > & lowsf )

Create given an array of const LOWSFB objects.

Parameters

lowsf [in,persisting] The LOWSFB objects that will be used to create the LOWSB objects for the diagonal blocks.

Preconditions:

!is_null(lowsf)

Definition at line 239 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ BlockedTriangularLinearOpWithSolveFactory() [3/3]

template<class Scalar >

Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::BlockedTriangularLinearOpWithSolveFactory ( )

private

Member Function Documentation

◆ getUnderlyingLOWSF() [1/2]

template<class Scalar >

Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF ( )

Definition at line 254 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ getUnderlyingLOWSF() [2/2]

template<class Scalar >

Array< RCP< const LinearOpWithSolveFactoryBase< Scalar > > > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF ( ) const

Definition at line 265 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ description()

template<class Scalar >

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

Definition at line 277 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ setParameterList()

template<class Scalar >

void Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::setParameterList ( RCP< ParameterList > const & paramList )

Definition at line 298 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ getNonconstParameterList()

template<class Scalar >

RCP< ParameterList > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getNonconstParameterList ( )

Definition at line 308 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ unsetParameterList()

template<class Scalar >

RCP< ParameterList > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::unsetParameterList ( )

Definition at line 315 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ getParameterList()

template<class Scalar >

RCP< const ParameterList > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getParameterList ( ) const

Definition at line 326 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ getValidParameters()

template<class Scalar >

RCP< const ParameterList > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getValidParameters ( ) const

Definition at line 333 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ acceptsPreconditionerFactory()

template<class Scalar >

bool Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::acceptsPreconditionerFactory ( ) const

virtual

returns false.

Definition at line 342 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ setPreconditionerFactory()

template<class Scalar >

void Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::setPreconditionerFactory	(	const RCP< PreconditionerFactoryBase< Scalar > > &	precFactory,
		const std::string &	precFactoryName
	)

virtual

Throws exception.

Definition at line 348 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ getPreconditionerFactory()

template<class Scalar >

RCP< PreconditionerFactoryBase< Scalar > > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getPreconditionerFactory ( ) const

virtual

Returns null .

Definition at line 361 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ unsetPreconditionerFactory()

template<class Scalar >

void Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::unsetPreconditionerFactory	(	RCP< PreconditionerFactoryBase< Scalar > > *	precFactory,
		std::string *	precFactoryName
	)

virtual

Throws exception.

Definition at line 369 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ isCompatible()

template<class Scalar >

bool Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::isCompatible ( const LinearOpSourceBase< Scalar > & fwdOpSrc ) const

virtual

Definition at line 380 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ createOp()

template<class Scalar >

RCP< LinearOpWithSolveBase< Scalar > > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::createOp ( ) const

virtual

Definition at line 390 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ initializeOp()

template<class Scalar >

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

virtual

Definition at line 396 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ initializeAndReuseOp()

template<class Scalar >

void Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::initializeAndReuseOp	(	const RCP< const LinearOpSourceBase< Scalar > > &	fwdOpSrc,
		LinearOpWithSolveBase< Scalar > *	Op
	)		const

virtual

Definition at line 472 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ uninitializeOp()

template<class Scalar >

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

virtual

Definition at line 481 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ supportsPreconditionerInputType()

template<class Scalar >

bool Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::supportsPreconditionerInputType ( const EPreconditionerInputType precOpType ) const

virtual

Definition at line 507 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ initializePreconditionedOp()

template<class Scalar >

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

virtual

Definition at line 521 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ initializeApproxPreconditionedOp()

template<class Scalar >

void Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::initializeApproxPreconditionedOp	(	const RCP< const LinearOpSourceBase< Scalar > > &	fwdOpSrc,
		const RCP< const LinearOpSourceBase< Scalar > > &	approxFwdOpSrc,
		LinearOpWithSolveBase< Scalar > *	Op,
		const ESupportSolveUse	supportSolveUse
	)		const

virtual

Definition at line 535 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ informUpdatedVerbosityState()

template<class Scalar >

void Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::informUpdatedVerbosityState ( ) const

protected

Overridden from Teuchos::VerboseObjectBase.

Definition at line 552 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

Friends And Related Symbol Documentation

◆ blockedTriangularLinearOpWithSolveFactory() [1/2]

template<class Scalar >

RCP< BlockedTriangularLinearOpWithSolveFactory< Scalar > > blockedTriangularLinearOpWithSolveFactory ( const Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > > & lowsf )

Definition at line 202 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ blockedTriangularLinearOpWithSolveFactory() [2/2]

template<class Scalar >

RCP< BlockedTriangularLinearOpWithSolveFactory< Scalar > > blockedTriangularLinearOpWithSolveFactory ( const Array< RCP< const LinearOpWithSolveFactoryBase< Scalar > > > & lowsf )

Definition at line 215 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

Member Data Documentation

◆ lowsf_

template<class Scalar >

Array<LOWSF_t> Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::lowsf_

private

Definition at line 190 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

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

Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp

Related Symbols

Overridden from LinearOpWithSolveFactoyBase

Overridden from Constructors/Initializers/Accessors

Overridden from Teuchos::Describable.

Overridden from ParameterListAcceptor (simple forwarding functions)

Detailed Description

Member Typedef Documentation

◆ LOWSF_t

Constructor & Destructor Documentation

◆ BlockedTriangularLinearOpWithSolveFactory() [1/3]

◆ BlockedTriangularLinearOpWithSolveFactory() [2/3]

◆ BlockedTriangularLinearOpWithSolveFactory() [3/3]

Member Function Documentation

◆ getUnderlyingLOWSF() [1/2]

◆ getUnderlyingLOWSF() [2/2]

◆ description()

◆ setParameterList()

◆ getNonconstParameterList()

◆ unsetParameterList()

◆ getParameterList()

◆ getValidParameters()

◆ acceptsPreconditionerFactory()

◆ setPreconditionerFactory()

◆ getPreconditionerFactory()

◆ unsetPreconditionerFactory()

◆ isCompatible()

◆ createOp()

◆ initializeOp()

◆ initializeAndReuseOp()

◆ uninitializeOp()

◆ supportsPreconditionerInputType()

◆ initializePreconditionedOp()

◆ initializeApproxPreconditionedOp()

◆ informUpdatedVerbosityState()

Friends And Related Symbol Documentation

◆ blockedTriangularLinearOpWithSolveFactory() [1/2]

◆ blockedTriangularLinearOpWithSolveFactory() [2/2]

Member Data Documentation

◆ lowsf_