Thyra::ReuseLinearOpWithSolveFactory< Scalar > Class Template Reference

A LinearOpWithSolveFactory that is designed to reuse an already created/initialized preconditioner. More...

#include <Thyra_ReuseLinearOpWithSolveFactory.hpp>

Inheritance diagram for Thyra::ReuseLinearOpWithSolveFactory< Scalar >:

Private Types
typedef Teuchos::ConstNonconstObjectContainer < LinearOpWithSolveFactoryBase < Scalar > >	LOWSF_t

Private Attributes
LOWSF_t	lowsf_
RCP< PreconditionerBase< Scalar > >	prec_

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP < ReuseLinearOpWithSolveFactory < Scalar > >	nonconstReuseLinearOpWithSolveFactory (const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< PreconditionerBase< Scalar > > &prec)
	Nonmember constructor. More...
template<class Scalar >
RCP < ReuseLinearOpWithSolveFactory < Scalar > >	reuseLinearOpWithSolveFactory (const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< PreconditionerBase< Scalar > > &prec)
	Nonmember constructor. More...

Overridden from Constructors/Initializers/Accessors
	ReuseLinearOpWithSolveFactory ()
	Construct to uninitialized. More...
void	nonconstInitialize (const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< PreconditionerBase< Scalar > > &prec)
	Initialize given a single non-const LOWSFB object. More...
void	initialize (const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< PreconditionerBase< Scalar > > &prec)
	Initialize given a single const LOWSFB object. More...
RCP < LinearOpWithSolveFactoryBase < Scalar > >	getUnderlyingLOWSF ()
RCP< const LinearOpWithSolveFactoryBase < Scalar > >	getUnderlyingLOWSF () const
RCP< PreconditionerBase< Scalar > >	getUnderlyingPreconditioner ()
RCP< const PreconditionerBase < Scalar > >	getUnderlyingPreconditioner () 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

Overridden from LinearOpWithSolveFactoyBase
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...

Additional Inherited Members
Public Member Functions inherited from Thyra::LinearOpWithSolveFactoryBase< Scalar >
bool	isCompatible (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const LinearOpBase< Scalar > &fwdOp)
void	setDefaultObjectLabel (const LinearOpBase< Scalar > &fwdOp, const Ptr< LinearOpWithSolveBase< Scalar > > &Op)
void	initializeOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const RCP< const LinearOpBase< Scalar > > &fwdOp, const Ptr< LinearOpWithSolveBase< Scalar > > &Op, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
void	initializeAndReuseOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const RCP< const LinearOpBase< Scalar > > &fwdOp, const Ptr< LinearOpWithSolveBase< Scalar > > &Op)
void	initializePreconditionedOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const RCP< const LinearOpBase< Scalar > > &fwdOp, const RCP< const PreconditionerBase< Scalar > > &prec, const Ptr< LinearOpWithSolveBase< Scalar > > &Op, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
void	initializeApproxPreconditionedOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const RCP< const LinearOpBase< Scalar > > &fwdOp, const RCP< const LinearOpBase< Scalar > > &approxFwdOp, const Ptr< LinearOpWithSolveBase< Scalar > > &Op, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
RCP< LinearOpWithSolveBase < Scalar > >	linearOpWithSolve (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const RCP< const LinearOpBase< Scalar > > &fwdOp, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
RCP< LinearOpBase< Scalar > >	inverse (const LinearOpWithSolveFactoryBase< Scalar > &LOWSF, const RCP< const LinearOpBase< Scalar > > &fwdOp, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED, const Ptr< const SolveCriteria< Scalar > > &fwdSolveCriteria=Teuchos::null, const EThrowOnSolveFailure throwOnFwdSolveFailure=THROW_ON_SOLVE_FAILURE, const Ptr< const SolveCriteria< Scalar > > &adjSolveCriteria=Teuchos::null, const EThrowOnSolveFailure throwOnAdjSolveFailure=THROW_ON_SOLVE_FAILURE)
void	uninitializeOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const Ptr< LinearOpWithSolveBase< Scalar > > &Op, const Ptr< RCP< const LinearOpBase< Scalar > > > &fwdOp=Teuchos::null, const Ptr< RCP< const PreconditionerBase< Scalar > > > &prec=Teuchos::null, const Ptr< RCP< const LinearOpBase< Scalar > > > &approxFwdOp=Teuchos::null, const Ptr< ESupportSolveUse > &supportSolveUse=Teuchos::null)
Public Member Functions inherited from Teuchos::Describable
virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
virtual	~Describable ()
	LabeledObject ()
virtual	~LabeledObject ()
virtual void	setObjectLabel (const std::string &objectLabel)
virtual std::string	getObjectLabel () const
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
Public Member Functions inherited from Teuchos::ParameterListAcceptor
virtual void	setParameterList (const RCP< ParameterList > &paramList)=0
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Detailed Description

template<class Scalar>
class Thyra::ReuseLinearOpWithSolveFactory< Scalar >

A LinearOpWithSolveFactory that is designed to reuse an already created/initialized preconditioner.

Definition at line 21 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

Member Typedef Documentation

template<class Scalar >

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

private

Definition at line 171 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Thyra::ReuseLinearOpWithSolveFactory< Scalar >::ReuseLinearOpWithSolveFactory ( )

inline

Construct to uninitialized.

Definition at line 30 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

Member Function Documentation

template<class Scalar >

void Thyra::ReuseLinearOpWithSolveFactory< Scalar >::nonconstInitialize	(	const RCP< LinearOpWithSolveFactoryBase< Scalar > > &	lowsf,
		const RCP< PreconditionerBase< Scalar > > &	prec
	)

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.
prec	[?] Description.

Preconditions:

• !is_null(lowsf)

Definition at line 217 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

void Thyra::ReuseLinearOpWithSolveFactory< Scalar >::initialize	(	const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &	lowsf,
		const RCP< PreconditionerBase< Scalar > > &	prec
	)

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.
prec	[?] Description.

Preconditions:

• !is_null(lowsf)

Definition at line 233 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

RCP< LinearOpWithSolveFactoryBase< Scalar > > Thyra::ReuseLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF

(

)

Definition at line 249 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

RCP< const LinearOpWithSolveFactoryBase< Scalar > > Thyra::ReuseLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF

(

)

const

Definition at line 257 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

RCP< PreconditionerBase< Scalar > > Thyra::ReuseLinearOpWithSolveFactory< Scalar >::getUnderlyingPreconditioner

(

)

Definition at line 265 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

RCP< const PreconditionerBase< Scalar > > Thyra::ReuseLinearOpWithSolveFactory< Scalar >::getUnderlyingPreconditioner

(

)

const

Definition at line 273 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Reimplemented from Teuchos::Describable.

Definition at line 283 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

void Thyra::ReuseLinearOpWithSolveFactory< Scalar >::setParameterList

(

RCP< ParameterList > const &

paramList

)

Definition at line 308 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 318 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 326 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 334 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 342 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

returns false.

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 352 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Throws exception.

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 360 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Returns null .

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 370 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Throws exception.

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 377 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 387 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 397 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 405 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 417 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 428 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 443 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 453 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 467 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

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

protected

Overridden from Teuchos::VerboseObjectBase.

Definition at line 485 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

Friends And Related Function Documentation

template<class Scalar >

RCP< ReuseLinearOpWithSolveFactory< Scalar > > nonconstReuseLinearOpWithSolveFactory ( const RCP< LinearOpWithSolveFactoryBase< Scalar > > &  lowsf, const RCP< PreconditionerBase< Scalar > > &  prec  )

related

Nonmember constructor.

Definition at line 184 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

RCP< ReuseLinearOpWithSolveFactory< Scalar > > reuseLinearOpWithSolveFactory ( const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &  lowsf, const RCP< PreconditionerBase< Scalar > > &  prec  )

related

Nonmember constructor.

Definition at line 201 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

Member Data Documentation

template<class Scalar >

LOWSF_t Thyra::ReuseLinearOpWithSolveFactory< Scalar >::lowsf_

private

Definition at line 173 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

template<class Scalar >

RCP< PreconditionerBase<Scalar> > Thyra::ReuseLinearOpWithSolveFactory< Scalar >::prec_

private

Definition at line 174 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

---

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

• Thyra_ReuseLinearOpWithSolveFactory.hpp