Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Related Symbols | 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 >:
Thyra::LinearOpWithSolveFactoryBase< Scalar >

Related Symbols

(Note that these are not member symbols.)

template<class Scalar >
RCP< ReuseLinearOpWithSolveFactory< Scalar > > nonconstReuseLinearOpWithSolveFactory (const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< PreconditionerBase< Scalar > > &prec)
 Nonmember constructor.
 
template<class Scalar >
RCP< ReuseLinearOpWithSolveFactory< Scalar > > reuseLinearOpWithSolveFactory (const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< PreconditionerBase< Scalar > > &prec)
 Nonmember constructor.
 

Overridden from LinearOpWithSolveFactoyBase

typedef Teuchos::ConstNonconstObjectContainer< LinearOpWithSolveFactoryBase< Scalar > > LOWSF_t
 
LOWSF_t lowsf_
 
RCP< PreconditionerBase< Scalar > > prec_
 
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.
 

Overridden from Constructors/Initializers/Accessors

 ReuseLinearOpWithSolveFactory ()
 Construct to uninitialized.
 
void nonconstInitialize (const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< PreconditionerBase< Scalar > > &prec)
 Initialize given a single non-const LOWSFB object.
 
void initialize (const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< PreconditionerBase< Scalar > > &prec)
 Initialize given a single const LOWSFB object.
 
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
 

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

◆ LOWSF_t

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

◆ ReuseLinearOpWithSolveFactory()

template<class Scalar >
Thyra::ReuseLinearOpWithSolveFactory< Scalar >::ReuseLinearOpWithSolveFactory ( )
inline

Construct to uninitialized.

Definition at line 30 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

Member Function Documentation

◆ nonconstInitialize()

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 216 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ initialize()

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 232 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ getUnderlyingLOWSF() [1/2]

template<class Scalar >
RCP< LinearOpWithSolveFactoryBase< Scalar > > Thyra::ReuseLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF ( )

Definition at line 248 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ getUnderlyingLOWSF() [2/2]

template<class Scalar >
RCP< const LinearOpWithSolveFactoryBase< Scalar > > Thyra::ReuseLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF ( ) const

Definition at line 256 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ getUnderlyingPreconditioner() [1/2]

template<class Scalar >
RCP< PreconditionerBase< Scalar > > Thyra::ReuseLinearOpWithSolveFactory< Scalar >::getUnderlyingPreconditioner ( )

Definition at line 264 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ getUnderlyingPreconditioner() [2/2]

template<class Scalar >
RCP< const PreconditionerBase< Scalar > > Thyra::ReuseLinearOpWithSolveFactory< Scalar >::getUnderlyingPreconditioner ( ) const

Definition at line 272 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ description()

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

Definition at line 282 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ setParameterList()

template<class Scalar >
void Thyra::ReuseLinearOpWithSolveFactory< Scalar >::setParameterList ( RCP< ParameterList > const & paramList)

Definition at line 307 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ getNonconstParameterList()

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

Definition at line 317 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ unsetParameterList()

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

Definition at line 325 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ getParameterList()

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

Definition at line 333 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ getValidParameters()

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

Definition at line 341 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ acceptsPreconditionerFactory()

template<class Scalar >
bool Thyra::ReuseLinearOpWithSolveFactory< Scalar >::acceptsPreconditionerFactory ( ) const
virtual

returns false.

Definition at line 351 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ setPreconditionerFactory()

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

Throws exception.

Definition at line 359 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ getPreconditionerFactory()

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

Returns null .

Definition at line 369 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ unsetPreconditionerFactory()

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

Throws exception.

Definition at line 376 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ isCompatible()

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

Definition at line 386 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ createOp()

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

Definition at line 396 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ initializeOp()

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 404 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ initializeAndReuseOp()

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

Definition at line 416 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ uninitializeOp()

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 427 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ supportsPreconditionerInputType()

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

Definition at line 442 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ initializePreconditionedOp()

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 452 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ initializeApproxPreconditionedOp()

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 466 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ informUpdatedVerbosityState()

template<class Scalar >
void Thyra::ReuseLinearOpWithSolveFactory< Scalar >::informUpdatedVerbosityState ( ) const
protected

Overridden from Teuchos::VerboseObjectBase.

Definition at line 484 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

Friends And Related Symbol Documentation

◆ nonconstReuseLinearOpWithSolveFactory()

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.

◆ reuseLinearOpWithSolveFactory()

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

◆ lowsf_

template<class Scalar >
LOWSF_t Thyra::ReuseLinearOpWithSolveFactory< Scalar >::lowsf_
private

Definition at line 173 of file Thyra_ReuseLinearOpWithSolveFactory.hpp.

◆ prec_

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: