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

Related Symbols

(Note that these are not member symbols.)

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

Overridden from LinearOpWithSolveFactoyBase

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

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

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

◆ LOWSF_t

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

◆ AdjointLinearOpWithSolveFactory()

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

Construct to uninitialized.

Definition at line 33 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

Member Function Documentation

◆ nonconstInitialize()

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 208 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ initialize()

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 221 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ getUnderlyingLOWSF() [1/2]

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

Definition at line 234 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ getUnderlyingLOWSF() [2/2]

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

Definition at line 242 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ description()

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

Definition at line 252 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ setParameterList()

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

Definition at line 271 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ getNonconstParameterList()

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

Definition at line 281 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ unsetParameterList()

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

Definition at line 289 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ getParameterList()

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

Definition at line 297 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ getValidParameters()

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

Definition at line 305 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ acceptsPreconditionerFactory()

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

returns false.

Definition at line 315 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ setPreconditionerFactory()

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

Throws exception.

Definition at line 323 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ getPreconditionerFactory()

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

Returns null .

Definition at line 338 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ unsetPreconditionerFactory()

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

Throws exception.

Definition at line 350 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ isCompatible()

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

Definition at line 366 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ createOp()

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

Definition at line 381 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ initializeOp()

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 389 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ initializeAndReuseOp()

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

Definition at line 421 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ uninitializeOp()

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 451 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ supportsPreconditionerInputType()

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

Definition at line 488 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ initializePreconditionedOp()

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 498 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ initializeApproxPreconditionedOp()

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 534 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

◆ informUpdatedVerbosityState()

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

Overridden from Teuchos::VerboseObjectBase.

Definition at line 572 of file Thyra_AdjointLinearOpWithSolveFactory.hpp.

Friends And Related Symbol Documentation

◆ adjointLinearOpWithSolveFactory()

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.

◆ nonconstAdjointLinearOpWithSolveFactory()

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

◆ lowsf_

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: