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::AdjointLinearOpWithSolveFactory< Scalar > Class Template Reference

Create a LinearOpWithSolveFactory for an adjoint linear op. More...

#include <Thyra_AdjointLinearOpWithSolveFactory.hpp>

Inheritance diagram for Thyra::AdjointLinearOpWithSolveFactory< Scalar >:

Public Member Functions

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

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP< const
AdjointLinearOpWithSolveFactory
< Scalar > > 		adjointLinearOpWithSolveFactory (const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &lowsf)
 Nonmember constructor. More...
 
template<class Scalar >
RCP
< AdjointLinearOpWithSolveFactory
< Scalar > > 		nonconstAdjointLinearOpWithSolveFactory (const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf)
 Nonmember constructor. More...
 

Detailed Description

template<class Scalar>
class Thyra::AdjointLinearOpWithSolveFactory< Scalar >

Create a LinearOpWithSolveFactory for an adjoint linear op.

Definition at line 24 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

Member Typedef Documentation

template<class Scalar >
typedef Teuchos::ConstNonconstObjectContainer<LinearOpWithSolveFactoryBase<Scalar> > Thyra::AdjointLinearOpWithSolveFactory< Scalar >::LOWSF_t
private

Definition at line 166 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

Constructor & Destructor Documentation

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

Construct to uninitialized.

Definition at line 33 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

Member Function Documentation

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

returns false.

Definition at line 316 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 382 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 253 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 282 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 298 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Returns null .

Definition at line 339 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 235 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 243 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 306 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Overridden from Teuchos::VerboseObjectBase.

Definition at line 573 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

template<class Scalar >
void Thyra::AdjointLinearOpWithSolveFactory< Scalar >::initialize ( const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &  lowsf)

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

Preconditions:

  • !is_null(lowsf)

Definition at line 222 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 422 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

template<class Scalar >
void Thyra::AdjointLinearOpWithSolveFactory< 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_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 390 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

template<class Scalar >
void Thyra::AdjointLinearOpWithSolveFactory< 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 499 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 367 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

template<class Scalar >
void Thyra::AdjointLinearOpWithSolveFactory< Scalar >::nonconstInitialize ( const RCP< LinearOpWithSolveFactoryBase< Scalar > > &  lowsf)

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

Preconditions:

  • !is_null(lowsf)

Definition at line 209 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 272 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Throws exception.

Definition at line 324 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 489 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

template<class Scalar >
void Thyra::AdjointLinearOpWithSolveFactory< 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 452 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Definition at line 290 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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

Throws exception.

Definition at line 351 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

Friends And Related Function Documentation

template<class Scalar >
RCP< const AdjointLinearOpWithSolveFactory< Scalar > > adjointLinearOpWithSolveFactory ( const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &  lowsf)
related

Nonmember constructor.

Definition at line 178 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

template<class Scalar >
RCP< AdjointLinearOpWithSolveFactory< Scalar > > nonconstAdjointLinearOpWithSolveFactory ( const RCP< LinearOpWithSolveFactoryBase< Scalar > > &  lowsf)
related

Nonmember constructor.

Definition at line 194 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

Member Data Documentation

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

Definition at line 168 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

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