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>

List of all members.

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
Private Attributes
RCP< LinearOpBase< Scalar > >	lo_
DerivativeMultiVector< Scalar >	dmv_

---

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 350 of file Thyra_ModelEvaluatorBase_decl.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

Thyra::ModelEvaluatorBase::Derivative< Scalar >::Derivative

(

)

[inline]

Definition at line 353 of file Thyra_ModelEvaluatorBase_decl.hpp.

template<class Scalar>

Thyra::ModelEvaluatorBase::Derivative< Scalar >::Derivative

(

const RCP< LinearOpBase< Scalar > > &

lo

)

[inline]

Definition at line 355 of file Thyra_ModelEvaluatorBase_decl.hpp.

template<class Scalar>

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

Definition at line 358 of file Thyra_ModelEvaluatorBase_decl.hpp.

template<class Scalar>

Thyra::ModelEvaluatorBase::Derivative< Scalar >::Derivative

(

const DerivativeMultiVector< Scalar > &

dmv

)

[inline]

Definition at line 363 of file Thyra_ModelEvaluatorBase_decl.hpp.

---

Member Function Documentation

template<class Scalar>

bool Thyra::ModelEvaluatorBase::Derivative< Scalar >::isEmpty

(

)

const [inline]

Definition at line 366 of file Thyra_ModelEvaluatorBase_decl.hpp.

References Thyra::ModelEvaluatorBase::Derivative< Scalar >::dmv_, and Thyra::ModelEvaluatorBase::Derivative< Scalar >::lo_.

Referenced by Thyra::eval_g_DgDp().

template<class Scalar>

const Derivative<Scalar>& Thyra::ModelEvaluatorBase::Derivative< Scalar >::assert_not_null

(

)

const [inline]

Definition at line 369 of file Thyra_ModelEvaluatorBase_decl.hpp.

References Thyra::ModelEvaluatorBase::Derivative< Scalar >::dmv_, and Thyra::ModelEvaluatorBase::Derivative< Scalar >::lo_.

template<class Scalar>

RCP<LinearOpBase<Scalar> > Thyra::ModelEvaluatorBase::Derivative< Scalar >::getLinearOp

(

)

const [inline]

Definition at line 372 of file Thyra_ModelEvaluatorBase_decl.hpp.

References Thyra::ModelEvaluatorBase::Derivative< Scalar >::lo_.

Referenced by Thyra::ModelEvaluatorDefaultBase< Scalar >::getOutArgImplForDefaultLinearOpSupport(), and Thyra::ModelEvaluatorBase::Derivative< Scalar >::isSupportedBy().

template<class Scalar>

RCP<MultiVectorBase<Scalar> > Thyra::ModelEvaluatorBase::Derivative< Scalar >::getMultiVector

(

)

const [inline]

Definition at line 375 of file Thyra_ModelEvaluatorBase_decl.hpp.

References Thyra::ModelEvaluatorBase::Derivative< Scalar >::dmv_.

Referenced by Thyra::DefaultLumpedParameterModelEvaluator< Scalar >::assembleParamDeriv(), Thyra::DefaultLumpedParameterModelEvaluator< Scalar >::create_deriv_wrt_p_orig(), and Thyra::ModelEvaluatorBase::Derivative< Scalar >::isSupportedBy().

template<class Scalar>

EDerivativeMultiVectorOrientation Thyra::ModelEvaluatorBase::Derivative< Scalar >::getMultiVectorOrientation

(

)

const [inline]

Definition at line 378 of file Thyra_ModelEvaluatorBase_decl.hpp.

References Thyra::ModelEvaluatorBase::Derivative< Scalar >::dmv_.

Referenced by Thyra::DefaultLumpedParameterModelEvaluator< Scalar >::assembleParamDeriv(), Thyra::DefaultLumpedParameterModelEvaluator< Scalar >::create_deriv_wrt_p_orig(), and Thyra::ModelEvaluatorBase::Derivative< Scalar >::isSupportedBy().

template<class Scalar>

DerivativeMultiVector<Scalar> Thyra::ModelEvaluatorBase::Derivative< Scalar >::getDerivativeMultiVector

(

)

const [inline]

Definition at line 381 of file Thyra_ModelEvaluatorBase_decl.hpp.

References Thyra::ModelEvaluatorBase::Derivative< Scalar >::dmv_.

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 386 of file Thyra_ModelEvaluatorBase_decl.hpp.

References Thyra::ModelEvaluatorBase::DERIV_LINEAR_OP, Thyra::ModelEvaluatorBase::Derivative< Scalar >::getLinearOp(), Thyra::ModelEvaluatorBase::Derivative< Scalar >::getMultiVector(), Thyra::ModelEvaluatorBase::Derivative< Scalar >::getMultiVectorOrientation(), Thyra::ModelEvaluatorBase::DerivativeSupport::none(), and Thyra::ModelEvaluatorBase::DerivativeSupport::supports().

Referenced by Thyra::ModelEvaluatorBase::OutArgs< Scalar >::assert_supports().

template<class Scalar >

std::string Thyra::ModelEvaluatorBase::Derivative< Scalar >::description

(

)

const

Definition at line 514 of file Thyra_ModelEvaluatorBase_def.hpp.

References Thyra::ModelEvaluatorBase::Derivative< Scalar >::description().

Referenced by Thyra::ModelEvaluatorBase::OutArgs< Scalar >::assert_supports(), and Thyra::ModelEvaluatorBase::Derivative< Scalar >::description().

template<class Scalar >

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

Definition at line 534 of file Thyra_ModelEvaluatorBase_def.hpp.

---

Member Data Documentation

template<class Scalar>

RCP<LinearOpBase<Scalar> > Thyra::ModelEvaluatorBase::Derivative< Scalar >::lo_ [private]

Definition at line 407 of file Thyra_ModelEvaluatorBase_decl.hpp.

Referenced by Thyra::ModelEvaluatorBase::Derivative< Scalar >::assert_not_null(), Thyra::ModelEvaluatorBase::Derivative< Scalar >::getLinearOp(), and Thyra::ModelEvaluatorBase::Derivative< Scalar >::isEmpty().

template<class Scalar>

DerivativeMultiVector<Scalar> Thyra::ModelEvaluatorBase::Derivative< Scalar >::dmv_ [private]

Definition at line 408 of file Thyra_ModelEvaluatorBase_decl.hpp.

Referenced by Thyra::ModelEvaluatorBase::Derivative< Scalar >::assert_not_null(), Thyra::ModelEvaluatorBase::Derivative< Scalar >::getDerivativeMultiVector(), Thyra::ModelEvaluatorBase::Derivative< Scalar >::getMultiVector(), Thyra::ModelEvaluatorBase::Derivative< Scalar >::getMultiVectorOrientation(), and Thyra::ModelEvaluatorBase::Derivative< Scalar >::isEmpty().

---

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

• Thyra_ModelEvaluatorBase_decl.hpp
• Thyra_ModelEvaluatorBase_def.hpp