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

Implicit subclass that takes a blocked triangular LOWB object and turns it into a LOWSB object. More...

#include <Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp>

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

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP< BlockedTriangularLinearOpWithSolveFactory< Scalar > > blockedTriangularLinearOpWithSolveFactory (const Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > > &lowsf)
 Nonmember constructor.
 
template<class Scalar >
RCP< BlockedTriangularLinearOpWithSolveFactory< Scalar > > blockedTriangularLinearOpWithSolveFactory (const Array< RCP< const LinearOpWithSolveFactoryBase< Scalar > > > &lowsf)
 Nonmember constructor.
 

Overridden from LinearOpWithSolveFactoyBase

typedef Teuchos::ConstNonconstObjectContainer< LinearOpWithSolveFactoryBase< Scalar > > LOWSF_t
 
Array< LOWSF_tlowsf_
 
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.
 
 BlockedTriangularLinearOpWithSolveFactory ()
 

Overridden from Constructors/Initializers/Accessors

 BlockedTriangularLinearOpWithSolveFactory (const Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > > &lowsf)
 Create given an array of non-const LOWSFB objects.
 
 BlockedTriangularLinearOpWithSolveFactory (const Array< RCP< const LinearOpWithSolveFactoryBase< Scalar > > > &lowsf)
 Create given an array of const LOWSFB objects.
 
Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > > getUnderlyingLOWSF ()
 
Array< 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::BlockedTriangularLinearOpWithSolveFactory< Scalar >

Implicit subclass that takes a blocked triangular LOWB object and turns it into a LOWSB object.

This class takes any upper or lower triangular PhysicallyBlockedLinearOpBase object and compatible LinearOpWithSolveFactoryBase object(s) and creates a LOWSB version by creating LOWSB objects along the diagonal.

For example, consider the lower block triangular linear operator:

      [ M(0,0)                   ]
  M = [ M(1,0)   M(1,1)          ]
      [ M(2,0)   M(2,1)   M(2,2) ]

This class object will then create a new LOWSB object (of type DefaultBlockedTriangularLinearOpWithSolve) that looks like:

         [ invM(0,0)                       ]
  invM = [ M(1,0)     invM(1,1)            ]
         [ M(2,0)     M(2,1)     invM(2,2) ]

where invM(k,k) are LOWSB objects created from the LOB objects M(k,k) given a LOWSFB object.

This class is not very compliciated, see the function initializeOp() see what this class actually does!

Note, this is basically the same as DefaultBlockedTriangularLinearOpWithSolveFactory except this version allows you to set a different LOWSF for each diagonal block.

Definition at line 61 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

Member Typedef Documentation

◆ LOWSF_t

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

Constructor & Destructor Documentation

◆ BlockedTriangularLinearOpWithSolveFactory() [1/3]

template<class Scalar >
Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::BlockedTriangularLinearOpWithSolveFactory ( const Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > > &  lowsf)

Create given an array of non-const LOWSFB objects.

Parameters
lowsf[in,persisting] The LOWSFB objects that will be used to create the LOWSB objects for the diagonal blocks.

Preconditions:

  • !is_null(lowsf)

Definition at line 244 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ BlockedTriangularLinearOpWithSolveFactory() [2/3]

template<class Scalar >
Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::BlockedTriangularLinearOpWithSolveFactory ( const Array< RCP< const LinearOpWithSolveFactoryBase< Scalar > > > &  lowsf)

Create given an array of const LOWSFB objects.

Parameters
lowsf[in,persisting] The LOWSFB objects that will be used to create the LOWSB objects for the diagonal blocks.

Preconditions:

  • !is_null(lowsf)

Definition at line 258 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ BlockedTriangularLinearOpWithSolveFactory() [3/3]

template<class Scalar >
Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::BlockedTriangularLinearOpWithSolveFactory ( )
private

Member Function Documentation

◆ getUnderlyingLOWSF() [1/2]

template<class Scalar >
Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF

◆ getUnderlyingLOWSF() [2/2]

template<class Scalar >
Array< RCP< const LinearOpWithSolveFactoryBase< Scalar > > > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF

◆ description()

template<class Scalar >
std::string Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::description

◆ setParameterList()

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

◆ getNonconstParameterList()

template<class Scalar >
RCP< ParameterList > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getNonconstParameterList

◆ unsetParameterList()

template<class Scalar >
RCP< ParameterList > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::unsetParameterList

◆ getParameterList()

template<class Scalar >
RCP< const ParameterList > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getParameterList

◆ getValidParameters()

template<class Scalar >
RCP< const ParameterList > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getValidParameters

◆ acceptsPreconditionerFactory()

template<class Scalar >
bool Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::acceptsPreconditionerFactory
virtual

returns false.

Definition at line 372 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ setPreconditionerFactory()

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

Throws exception.

Definition at line 380 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ getPreconditionerFactory()

template<class Scalar >
RCP< PreconditionerFactoryBase< Scalar > > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::getPreconditionerFactory
virtual

Returns null .

Definition at line 392 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ unsetPreconditionerFactory()

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

Throws exception.

Definition at line 399 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ isCompatible()

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

◆ createOp()

template<class Scalar >
RCP< LinearOpWithSolveBase< Scalar > > Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::createOp
virtual

◆ initializeOp()

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

◆ initializeAndReuseOp()

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

◆ uninitializeOp()

template<class Scalar >
void Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::uninitializeOp ( LinearOpWithSolveBase< Scalar > *  Op,
RCP< const LinearOpSourceBase< Scalar > > *  fwdOpSrc,
RCP< const PreconditionerBase< Scalar > > *  prec,
RCP< const LinearOpSourceBase< Scalar > > *  approxFwdOpSrc,
ESupportSolveUse *  supportSolveUse 
) const
virtual

◆ supportsPreconditionerInputType()

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

◆ initializePreconditionedOp()

template<class Scalar >
void Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::initializePreconditionedOp ( const RCP< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
const RCP< const PreconditionerBase< Scalar > > &  prec,
LinearOpWithSolveBase< Scalar > *  Op,
const ESupportSolveUse  supportSolveUse 
) const
virtual

◆ initializeApproxPreconditionedOp()

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

◆ informUpdatedVerbosityState()

template<class Scalar >
void Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::informUpdatedVerbosityState
protected

Overridden from Teuchos::VerboseObjectBase.

Definition at line 594 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

Friends And Related Function Documentation

◆ blockedTriangularLinearOpWithSolveFactory() [1/2]

template<class Scalar >
RCP< BlockedTriangularLinearOpWithSolveFactory< Scalar > > blockedTriangularLinearOpWithSolveFactory ( const Array< RCP< LinearOpWithSolveFactoryBase< Scalar > > > &  lowsf)
related

Nonmember constructor.

Definition at line 216 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

◆ blockedTriangularLinearOpWithSolveFactory() [2/2]

template<class Scalar >
RCP< BlockedTriangularLinearOpWithSolveFactory< Scalar > > blockedTriangularLinearOpWithSolveFactory ( const Array< RCP< const LinearOpWithSolveFactoryBase< Scalar > > > &  lowsf)
related

Nonmember constructor.

Definition at line 232 of file Thyra_BlockedTriangularLinearOpWithSolveFactory.hpp.

Member Data Documentation

◆ lowsf_

template<class Scalar >
Array<LOWSF_t> Thyra::BlockedTriangularLinearOpWithSolveFactory< Scalar >::lowsf_
private

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