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

Create a LinearOpWithSolveFactory for a flattened-out multi-vector. More...

#include <Thyra_MultiVectorLinearOpWithSolveFactory.hpp>

Inheritance diagram for Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >:
Thyra::LinearOpWithSolveFactoryBase< Scalar >

(Note that these are not member symbols.)

template<class Scalar>
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > nonconstMultiVectorLinearOpWithSolveFactory (const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 Nonmember constructor.
template<class Scalar>
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > nonconstMultiVectorLinearOpWithSolveFactory (const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const int num_blocks)
 Nonmember constructor.
template<class Scalar>
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > multiVectorLinearOpWithSolveFactory (const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 Nonmember constructor.
template<class Scalar>
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > multiVectorLinearOpWithSolveFactory (const RCP< const LinearOpWithSolveFactoryBase< Scalar > > &lowsf, const int num_blocks)
 Nonmember constructor.

Overridden from LinearOpWithSolveFactoyBase

typedef Teuchos::ConstNonconstObjectContainer< LinearOpWithSolveFactoryBase< Scalar > > LOWSF_t
LOWSF_t lowsf_
RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > multiVecRange_
RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > multiVecDomain_
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

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

Create a LinearOpWithSolveFactory for a flattened-out multi-vector.

Definition at line 25 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

Member Typedef Documentation

◆ LOWSF_t

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

Definition at line 175 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

Constructor & Destructor Documentation

◆ MultiVectorLinearOpWithSolveFactory()

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

Construct to uninitialized.

Definition at line 34 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

Member Function Documentation

◆ nonconstInitialize()

template<class Scalar>
void Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::nonconstInitialize ( const RCP< LinearOpWithSolveFactoryBase< Scalar > > & lowsf,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > & multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > & multiVecDomain )

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.
multiVecRange[?] Description.
multiVecDomain[?] Description.

Preconditions:

  • !is_null(lowsf)

Definition at line 261 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ initialize()

template<class Scalar>
void Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::initialize ( const RCP< const LinearOpWithSolveFactoryBase< Scalar > > & lowsf,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > & multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > & multiVecDomain )

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.
multiVecRange[?] Description.
multiVecDomain[?] Description.

Preconditions:

  • !is_null(lowsf)

Definition at line 278 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getUnderlyingLOWSF() [1/2]

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

Definition at line 295 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getUnderlyingLOWSF() [2/2]

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

Definition at line 303 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ description()

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

Definition at line 313 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ setParameterList()

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

Definition at line 332 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getNonconstParameterList()

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

Definition at line 342 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ unsetParameterList()

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

Definition at line 350 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getParameterList()

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

Definition at line 358 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getValidParameters()

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

Definition at line 366 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ acceptsPreconditionerFactory()

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

returns false.

Definition at line 376 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ setPreconditionerFactory()

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

Throws exception.

Definition at line 384 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ getPreconditionerFactory()

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

Returns null .

Definition at line 399 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ unsetPreconditionerFactory()

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

Throws exception.

Definition at line 413 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ isCompatible()

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

Definition at line 431 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ createOp()

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

Definition at line 446 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ initializeOp()

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

Definition at line 457 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ initializeAndReuseOp()

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

Definition at line 489 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ uninitializeOp()

template<class Scalar>
void Thyra::MultiVectorLinearOpWithSolveFactory< 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 519 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ supportsPreconditionerInputType()

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

Definition at line 562 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ initializePreconditionedOp()

template<class Scalar>
void Thyra::MultiVectorLinearOpWithSolveFactory< 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 572 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ initializeApproxPreconditionedOp()

template<class Scalar>
void Thyra::MultiVectorLinearOpWithSolveFactory< 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 608 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ informUpdatedVerbosityState()

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

Overridden from Teuchos::VerboseObjectBase.

Definition at line 646 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ nonconstMultiVectorLinearOpWithSolveFactory() [1/2]

template<class Scalar>
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > nonconstMultiVectorLinearOpWithSolveFactory ( const RCP< LinearOpWithSolveFactoryBase< Scalar > > & lowsf,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > & multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > & multiVecDomain )
related

Nonmember constructor.

Definition at line 189 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ nonconstMultiVectorLinearOpWithSolveFactory() [2/2]

template<class Scalar>
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > nonconstMultiVectorLinearOpWithSolveFactory ( const RCP< LinearOpWithSolveFactoryBase< Scalar > > & lowsf,
const int num_blocks )
related

Nonmember constructor.

Definition at line 207 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ multiVectorLinearOpWithSolveFactory() [1/2]

template<class Scalar>
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > multiVectorLinearOpWithSolveFactory ( const RCP< const LinearOpWithSolveFactoryBase< Scalar > > & lowsf,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > & multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > & multiVecDomain )
related

Nonmember constructor.

Definition at line 226 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ multiVectorLinearOpWithSolveFactory() [2/2]

template<class Scalar>
RCP< MultiVectorLinearOpWithSolveFactory< Scalar > > multiVectorLinearOpWithSolveFactory ( const RCP< const LinearOpWithSolveFactoryBase< Scalar > > & lowsf,
const int num_blocks )
related

Nonmember constructor.

Definition at line 244 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

Member Data Documentation

◆ lowsf_

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

Definition at line 177 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ multiVecRange_

template<class Scalar>
RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::multiVecRange_
private

Definition at line 178 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

◆ multiVecDomain_

template<class Scalar>
RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > Thyra::MultiVectorLinearOpWithSolveFactory< Scalar >::multiVecDomain_
private

Definition at line 179 of file Thyra_MultiVectorLinearOpWithSolveFactory.hpp.

The documentation for this class was generated from the following file:
Generated by doxygen 1.17.0