Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
Related Symbols | List of all members
Thyra::AdjointPreconditionerFactory< Scalar > Class Template Reference

Concrete PreconditionerFactoryBase subclass that wraps a preconditioner in AdjointPreconditioner. More...

#include <Thyra_AdjointPreconditionerFactory.hpp>

Inheritance diagram for Thyra::AdjointPreconditionerFactory< Scalar >:
Thyra::PreconditionerFactoryBase< Scalar >

Related Symbols

(Note that these are not member symbols.)

template<class Scalar >
RCP< AdjointPreconditionerFactory< Scalar > > adjointPreconditionerFactory ()
 Nonmember constructor function.
 
template<class Scalar >
RCP< AdjointPreconditionerFactory< Scalar > > nonconstAdjointPreconditionerFactory (const RCP< PreconditionerFactoryBase< Scalar > > &prec_fac)
 Nonmember constructor function.
 
template<class Scalar >
RCP< AdjointPreconditionerFactory< Scalar > > adjointPreconditionerFactory (const RCP< const PreconditionerFactoryBase< Scalar > > &prec_fac)
 Nonmember constructor function.
 

Overridden from PreconditionerFactoryBase

typedef Teuchos::ConstNonconstObjectContainer< PreconditionerFactoryBase< Scalar > > CNPFB
 
CNPFB prec_fac_
 
bool isCompatible (const LinearOpSourceBase< Scalar > &fwdOpSrc) const
 
RCP< PreconditionerBase< Scalar > > createPrec () const
 
void initializePrec (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, PreconditionerBase< Scalar > *precOp, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED) const
 
void uninitializePrec (PreconditionerBase< Scalar > *precOp, RCP< const LinearOpSourceBase< Scalar > > *fwdOpSrc=NULL, ESupportSolveUse *supportSolveUse=NULL) const
 
static void validateInitialize (const RCP< const PreconditionerFactoryBase< Scalar > > &prec_fac)
 

Constructors/initializers/accessors

 AdjointPreconditionerFactory ()
 Construct to uninitialized.
 
void nonconstInitialize (const RCP< PreconditionerFactoryBase< Scalar > > &prec_fac)
 
void initialize (const RCP< const PreconditionerFactoryBase< Scalar > > &prec_fac)
 
RCP< PreconditionerFactoryBase< Scalar > > getNonconstPreconditionerFactory ()
 
RCP< const PreconditionerFactoryBase< Scalar > > getPreconditionerFactory () const
 
void uninitialize ()
 

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::AdjointPreconditionerFactory< Scalar >

Concrete PreconditionerFactoryBase subclass that wraps a preconditioner in AdjointPreconditioner.

Definition at line 24 of file Thyra_AdjointPreconditionerFactory.hpp.

Member Typedef Documentation

◆ CNPFB

template<class Scalar >
typedef Teuchos::ConstNonconstObjectContainer< PreconditionerFactoryBase<Scalar> > Thyra::AdjointPreconditionerFactory< Scalar >::CNPFB
private

Definition at line 168 of file Thyra_AdjointPreconditionerFactory.hpp.

Constructor & Destructor Documentation

◆ AdjointPreconditionerFactory()

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

Construct to uninitialized.

Definition at line 31 of file Thyra_AdjointPreconditionerFactory.hpp.

Member Function Documentation

◆ nonconstInitialize()

template<class Scalar >
void Thyra::AdjointPreconditionerFactory< Scalar >::nonconstInitialize ( const RCP< PreconditionerFactoryBase< Scalar > > &  prec_fac)
inline

Definition at line 33 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ initialize()

template<class Scalar >
void Thyra::AdjointPreconditionerFactory< Scalar >::initialize ( const RCP< const PreconditionerFactoryBase< Scalar > > &  prec_fac)
inline

Definition at line 40 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ getNonconstPreconditionerFactory()

template<class Scalar >
RCP< PreconditionerFactoryBase< Scalar > > Thyra::AdjointPreconditionerFactory< Scalar >::getNonconstPreconditionerFactory ( )
inline

Definition at line 46 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ getPreconditionerFactory()

template<class Scalar >
RCP< const PreconditionerFactoryBase< Scalar > > Thyra::AdjointPreconditionerFactory< Scalar >::getPreconditionerFactory ( ) const
inline

Definition at line 51 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ uninitialize()

template<class Scalar >
void Thyra::AdjointPreconditionerFactory< Scalar >::uninitialize ( )
inline

Definition at line 56 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ description()

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

Definition at line 61 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ setParameterList()

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

Definition at line 80 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ getNonconstParameterList()

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

Definition at line 85 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ unsetParameterList()

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

Definition at line 90 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ getParameterList()

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

Definition at line 95 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ getValidParameters()

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

Definition at line 100 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ isCompatible()

template<class Scalar >
bool Thyra::AdjointPreconditionerFactory< Scalar >::isCompatible ( const LinearOpSourceBase< Scalar > &  fwdOpSrc) const
inline

Definition at line 112 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ createPrec()

template<class Scalar >
RCP< PreconditionerBase< Scalar > > Thyra::AdjointPreconditionerFactory< Scalar >::createPrec ( ) const
inline

Definition at line 117 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ initializePrec()

template<class Scalar >
void Thyra::AdjointPreconditionerFactory< Scalar >::initializePrec ( const RCP< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
PreconditionerBase< Scalar > *  precOp,
const ESupportSolveUse  supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED 
) const
inline

Definition at line 122 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ uninitializePrec()

template<class Scalar >
void Thyra::AdjointPreconditionerFactory< Scalar >::uninitializePrec ( PreconditionerBase< Scalar > *  precOp,
RCP< const LinearOpSourceBase< Scalar > > *  fwdOpSrc = NULL,
ESupportSolveUse *  supportSolveUse = NULL 
) const
inline

Definition at line 140 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ validateInitialize()

template<class Scalar >
static void Thyra::AdjointPreconditionerFactory< Scalar >::validateInitialize ( const RCP< const PreconditionerFactoryBase< Scalar > > &  prec_fac)
inlinestaticprivate

Definition at line 178 of file Thyra_AdjointPreconditionerFactory.hpp.

Friends And Related Symbol Documentation

◆ adjointPreconditionerFactory() [1/2]

template<class Scalar >
RCP< AdjointPreconditionerFactory< Scalar > > adjointPreconditionerFactory ( )
related

Nonmember constructor function.

Definition at line 194 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ nonconstAdjointPreconditionerFactory()

template<class Scalar >
RCP< AdjointPreconditionerFactory< Scalar > > nonconstAdjointPreconditionerFactory ( const RCP< PreconditionerFactoryBase< Scalar > > &  prec_fac)
related

Nonmember constructor function.

Definition at line 204 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ adjointPreconditionerFactory() [2/2]

template<class Scalar >
RCP< AdjointPreconditionerFactory< Scalar > > adjointPreconditionerFactory ( const RCP< const PreconditionerFactoryBase< Scalar > > &  prec_fac)
related

Nonmember constructor function.

Definition at line 218 of file Thyra_AdjointPreconditionerFactory.hpp.

Member Data Documentation

◆ prec_fac_

template<class Scalar >
CNPFB Thyra::AdjointPreconditionerFactory< Scalar >::prec_fac_
private

Definition at line 173 of file Thyra_AdjointPreconditionerFactory.hpp.

The documentation for this class was generated from the following file:
Generated on Thu Oct 9 2025 20:59:11 for Tempus by doxygen 1.9.8