Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra::ModelEvaluatorBase::Derivative< Scalar > Class Template Reference

Simple aggregate class that stores a derivative object as a general linear operator or as a multi-vector. More...

#include <Thyra_ModelEvaluatorBase_decl.hpp>

Public Member Functions

 Derivative ()
 Derivative (const RCP< LinearOpBase< Scalar > > &lo)
 Derivative (const RCP< MultiVectorBase< Scalar > > &mv, const EDerivativeMultiVectorOrientation orientation=DERIV_MV_BY_COL)
 Derivative (const DerivativeMultiVector< Scalar > &dmv)
bool isEmpty () const
const Derivative< Scalar > & assert_not_null () const
RCP< LinearOpBase< Scalar > > getLinearOp () const
RCP< MultiVectorBase< Scalar > > getMultiVector () const
EDerivativeMultiVectorOrientation getMultiVectorOrientation () const
DerivativeMultiVector< Scalar > getDerivativeMultiVector () const
bool isSupportedBy (const DerivativeSupport &derivSupport) const
 Returns true if the form of the derivative contained here is supported by deriveSupport.
std::string description () const
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

Detailed Description

template<class Scalar>
class Thyra::ModelEvaluatorBase::Derivative< Scalar >

Simple aggregate class that stores a derivative object as a general linear operator or as a multi-vector.

Definition at line 505 of file Thyra_ModelEvaluatorBase_decl.hpp.

Constructor & Destructor Documentation

◆ Derivative() [1/4]

template<class Scalar>
Thyra::ModelEvaluatorBase::Derivative< Scalar >::Derivative ( )
inline

Definition at line 508 of file Thyra_ModelEvaluatorBase_decl.hpp.

◆ Derivative() [2/4]

template<class Scalar>
Thyra::ModelEvaluatorBase::Derivative< Scalar >::Derivative ( const RCP< LinearOpBase< Scalar > > & lo)
inline

Definition at line 510 of file Thyra_ModelEvaluatorBase_decl.hpp.

◆ Derivative() [3/4]

template<class Scalar>
Thyra::ModelEvaluatorBase::Derivative< Scalar >::Derivative ( const RCP< MultiVectorBase< Scalar > > & mv,
const EDerivativeMultiVectorOrientation orientation = DERIV_MV_BY_COL )
inline

Definition at line 513 of file Thyra_ModelEvaluatorBase_decl.hpp.

◆ Derivative() [4/4]

template<class Scalar>
Thyra::ModelEvaluatorBase::Derivative< Scalar >::Derivative ( const DerivativeMultiVector< Scalar > & dmv)
inline

Definition at line 518 of file Thyra_ModelEvaluatorBase_decl.hpp.

Member Function Documentation

◆ isEmpty()

template<class Scalar>
bool Thyra::ModelEvaluatorBase::Derivative< Scalar >::isEmpty ( ) const
inline

Definition at line 521 of file Thyra_ModelEvaluatorBase_decl.hpp.

◆ assert_not_null()

template<class Scalar>
const Derivative< Scalar > & Thyra::ModelEvaluatorBase::Derivative< Scalar >::assert_not_null ( ) const
inline

Definition at line 524 of file Thyra_ModelEvaluatorBase_decl.hpp.

◆ getLinearOp()

template<class Scalar>
RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorBase::Derivative< Scalar >::getLinearOp ( ) const
inline

Definition at line 527 of file Thyra_ModelEvaluatorBase_decl.hpp.

◆ getMultiVector()

template<class Scalar>
RCP< MultiVectorBase< Scalar > > Thyra::ModelEvaluatorBase::Derivative< Scalar >::getMultiVector ( ) const
inline

Definition at line 530 of file Thyra_ModelEvaluatorBase_decl.hpp.

◆ getMultiVectorOrientation()

template<class Scalar>
EDerivativeMultiVectorOrientation Thyra::ModelEvaluatorBase::Derivative< Scalar >::getMultiVectorOrientation ( ) const
inline

Definition at line 533 of file Thyra_ModelEvaluatorBase_decl.hpp.

◆ getDerivativeMultiVector()

template<class Scalar>
DerivativeMultiVector< Scalar > Thyra::ModelEvaluatorBase::Derivative< Scalar >::getDerivativeMultiVector ( ) const
inline

Definition at line 536 of file Thyra_ModelEvaluatorBase_decl.hpp.

◆ isSupportedBy()

template<class Scalar>
bool Thyra::ModelEvaluatorBase::Derivative< Scalar >::isSupportedBy ( const DerivativeSupport & derivSupport) const
inline

Returns true if the form of the derivative contained here is supported by deriveSupport.

Definition at line 541 of file Thyra_ModelEvaluatorBase_decl.hpp.

◆ description()

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

Definition at line 777 of file Thyra_ModelEvaluatorBase_def.hpp.

◆ describe()

template<class Scalar>
void Thyra::ModelEvaluatorBase::Derivative< Scalar >::describe ( Teuchos::FancyOStream & out,
const Teuchos::EVerbosityLevel verbLevel ) const

Definition at line 797 of file Thyra_ModelEvaluatorBase_def.hpp.


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