Create a LinearOpWithSolveFactory for a flattened-out multi-vector. More...

#include <Thyra_MultiVectorLinearOpWithSolveFactory.hpp>

Inheritance diagram for Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >:

Public Member Functions
Overridden from Constructors/Initializers/Accessors
	MultiVectorLinearOpWithSolveFactory ()
	Construct to uninitialized. More...

void	nonconstInitialize (const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
	Initialize given a single non-const LOWSFB object. More...

void	initialize (const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
	Initialize given a single const LOWSFB object. More...

RCP< LinearOpWithSolveFactoryBase< Scalar > >	getUnderlyingLOWSF ()

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

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > >	nonconstMultiVectorLinearOpWithSolveFactory (const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
	Nonmember constructor. More...

template<class Scalar >
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > >	nonconstMultiVectorLinearOpWithSolveFactory (const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const int num_blocks)
	Nonmember constructor. More...

template<class Scalar >
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > >	multiVectorLinearOpWithSolveFactory (const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
	Nonmember constructor. More...

template<class Scalar >
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > >	multiVectorLinearOpWithSolveFactory (const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const int num_blocks)
	Nonmember constructor. More...

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

LOWSF_t	lowsf_

RCP< const DefaultMultiVectorProductVectorSpace< Scalar > >	multiVecRange_

RCP< const DefaultMultiVectorProductVectorSpace< Scalar > >	multiVecDomain_

virtual bool	acceptsPreconditionerFactory () const
	returns false. More...

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

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

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

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

Detailed Description

template<class Scalar>
class Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >

Create a LinearOpWithSolveFactory for a flattened-out multi-vector.

Definition at line 25 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

Member Typedef Documentation

◆ LOWSF_t

template<class Scalar >

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

private

Definition at line 175 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

Constructor & Destructor Documentation

◆ MultiVectorLinearOpWithSolveFactory()

template<class Scalar >

Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::MultiVectorLinearOpWithSolveFactory ( )

inline

Construct to uninitialized.

Definition at line 34 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

Member Function Documentation

◆ acceptsPreconditionerFactory()

template<class Scalar >

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

virtual

returns false.

Definition at line 377 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ createOp()

template<class Scalar >

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

virtual

Definition at line 447 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ description()

template<class Scalar >

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

Definition at line 314 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getNonconstParameterList()

template<class Scalar >

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

Definition at line 343 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getParameterList()

template<class Scalar >

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

Definition at line 359 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getPreconditionerFactory()

template<class Scalar >

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

virtual

Returns null .

Definition at line 400 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getUnderlyingLOWSF() [1/2]

template<class Scalar >

RCP< LinearOpWithSolveFactoryBase< Scalar > > Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF ( )

Definition at line 296 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getUnderlyingLOWSF() [2/2]

template<class Scalar >

RCP< const LinearOpWithSolveFactoryBase< Scalar > > Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF ( ) const

Definition at line 304 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getValidParameters()

template<class Scalar >

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

Definition at line 367 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ informUpdatedVerbosityState()

template<class Scalar >

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

protected

Overridden from Teuchos::VerboseObjectBase.

Definition at line 647 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ initialize()

template<class Scalar >

void Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::initialize	(	const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &	lowsf,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecRange,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecDomain
	)

Initialize given a single const LOWSFB object.

Parameters

lowsf	[in,persisting] The LOWSFB object that will be used to create the LOWSB object for the diagonal blocks.
multiVecRange	[?] Description.
multiVecDomain	[?] Description.

Preconditions:

!is_null(lowsf)

Definition at line 279 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ initializeAndReuseOp()

template<class Scalar >

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

virtual

Definition at line 490 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ initializeApproxPreconditionedOp()

template<class Scalar >

void Thyra::MultiVectorLinearOpWithSolveFactory< 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 609 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ initializeOp()

template<class Scalar >

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

virtual

Definition at line 458 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ initializePreconditionedOp()

template<class Scalar >

void Thyra::MultiVectorLinearOpWithSolveFactory< 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 573 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ isCompatible()

template<class Scalar >

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

virtual

Definition at line 432 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ nonconstInitialize()

template<class Scalar >

void Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::nonconstInitialize	(	const RCP< LinearOpWithSolveFactoryBase< Scalar > > &	lowsf,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecRange,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecDomain
	)

Initialize given a single non-const LOWSFB object.

Parameters

lowsf	[in,persisting] The LOWSFB object that will be used to create the LOWSB object for the diagonal blocks.
multiVecRange	[?] Description.
multiVecDomain	[?] Description.

Preconditions:

!is_null(lowsf)

Definition at line 262 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ setParameterList()

template<class Scalar >

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

Definition at line 333 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ setPreconditionerFactory()

template<class Scalar >

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

virtual

Throws exception.

Definition at line 385 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ supportsPreconditionerInputType()

template<class Scalar >

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

virtual

Definition at line 563 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ uninitializeOp()

template<class Scalar >

void Thyra::MultiVectorLinearOpWithSolveFactory< 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 520 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ unsetParameterList()

template<class Scalar >

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

Definition at line 351 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ unsetPreconditionerFactory()

template<class Scalar >

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

virtual

Throws exception.

Definition at line 414 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

Friends And Related Function Documentation

◆ multiVectorLinearOpWithSolveFactory() [1/2]

template<class Scalar >

RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > multiVectorLinearOpWithSolveFactory	(	const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &	lowsf,
		const int	num_blocks
	)

Definition at line 244 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ multiVectorLinearOpWithSolveFactory() [2/2]

template<class Scalar >

RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > multiVectorLinearOpWithSolveFactory	(	const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &	lowsf,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecRange,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecDomain
	)

Definition at line 226 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ nonconstMultiVectorLinearOpWithSolveFactory() [1/2]

template<class Scalar >

RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > nonconstMultiVectorLinearOpWithSolveFactory	(	const RCP< LinearOpWithSolveFactoryBase< Scalar > > &	lowsf,
		const int	num_blocks
	)

Definition at line 207 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ nonconstMultiVectorLinearOpWithSolveFactory() [2/2]

template<class Scalar >

RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > nonconstMultiVectorLinearOpWithSolveFactory	(	const RCP< LinearOpWithSolveFactoryBase< Scalar > > &	lowsf,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecRange,
		const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &	multiVecDomain
	)

Definition at line 189 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

Member Data Documentation

◆ lowsf_

template<class Scalar >

LOWSF_t Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::lowsf_

private

Definition at line 177 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ multiVecDomain_

template<class Scalar >

RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::multiVecDomain_

private

Definition at line 179 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ multiVecRange_

template<class Scalar >

RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::multiVecRange_

private

Definition at line 178 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

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

/home/abuild/rpmbuild/BUILD/Trilinos-trilinos-release-12-14-1/packages/tempus/src/Thyra_MultiVectorLinearOpWithSolveFactory.hpp

Public Member Functions

Related Functions

Overridden from LinearOpWithSolveFactoyBase

Detailed Description

template<class Scalar> class Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >

Member Typedef Documentation

◆ LOWSF_t

Constructor & Destructor Documentation

◆ MultiVectorLinearOpWithSolveFactory()

Member Function Documentation

◆ acceptsPreconditionerFactory()

◆ createOp()

◆ description()

◆ getNonconstParameterList()

◆ getParameterList()

◆ getPreconditionerFactory()

◆ getUnderlyingLOWSF() [1/2]

◆ getUnderlyingLOWSF() [2/2]

◆ getValidParameters()

◆ informUpdatedVerbosityState()

◆ initialize()

◆ initializeAndReuseOp()

◆ initializeApproxPreconditionedOp()

◆ initializeOp()

◆ initializePreconditionedOp()

◆ isCompatible()

◆ nonconstInitialize()

◆ setParameterList()

◆ setPreconditionerFactory()

◆ supportsPreconditionerInputType()

◆ uninitializeOp()

◆ unsetParameterList()

◆ unsetPreconditionerFactory()

Friends And Related Function Documentation

◆ multiVectorLinearOpWithSolveFactory() [1/2]

◆ multiVectorLinearOpWithSolveFactory() [2/2]

◆ nonconstMultiVectorLinearOpWithSolveFactory() [1/2]

◆ nonconstMultiVectorLinearOpWithSolveFactory() [2/2]

Member Data Documentation

◆ lowsf_

◆ multiVecDomain_

◆ multiVecRange_

template<class Scalar>
class Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >