Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Private Types | Private Attributes | Related Functions | List of all members
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 >:

Public Member Functions

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
 

Protected Member Functions

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

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

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 >
bool Thyra::ReuseLinearOpWithSolveFactory< Scalar >::acceptsPreconditionerFactory ( ) const
virtual

returns false.

Definition at line 352 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

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

Definition at line 397 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

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

Definition at line 283 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

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

Definition at line 318 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

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

Definition at line 334 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

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

Returns null .

Definition at line 370 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 >
RCP< const ParameterList > Thyra::ReuseLinearOpWithSolveFactory< Scalar >::getValidParameters ( ) const

Definition at line 342 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.

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 >
void Thyra::ReuseLinearOpWithSolveFactory< Scalar >::initializeAndReuseOp ( const RCP< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
LinearOpWithSolveBase< Scalar > *  Op 
) const
virtual

Definition at line 417 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

Definition at line 467 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

Definition at line 405 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

Definition at line 453 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

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

Definition at line 387 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

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 >::setParameterList ( RCP< ParameterList > const &  paramList)

Definition at line 308 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.

Definition at line 360 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

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

Definition at line 443 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

Definition at line 428 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

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

Definition at line 326 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

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

Throws exception.

Definition at line 377 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: