Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar > Class Template Reference

This class wraps any ModelEvaluator object and computes certain derivatives using finite differences. More...

#include <Thyra_DefaultFiniteDifferenceModelEvaluator.hpp>

Inheritance diagram for Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >:

[legend]List of all members.

Constructors/initializers/accessors/utilities.
	STANDARD_COMPOSITION_MEMBERS (Thyra::DirectionalFiniteDiffCalculator< Scalar >, direcFiniteDiffCalculator)
	Utility object that computes directional finite differences.
	DefaultFiniteDifferenceModelEvaluator ()
void	initialize (const RCP< ModelEvaluator< Scalar > > &thyraModel, const RCP< Thyra::DirectionalFiniteDiffCalculator< Scalar > > &direcFiniteDiffCalculator)
void	uninitialize (RCP< ModelEvaluator< Scalar > > *thyraModel, RCP< Thyra::DirectionalFiniteDiffCalculator< Scalar > > *direcFiniteDiffCalculator)
Public functions overridden from Teuchos::Describable.
std::string	description () const
Related Functions
(Note that these are not member functions.)
RCP< DefaultFiniteDifferenceModelEvaluator< Scalar > >	defaultFiniteDifferenceModelEvaluator (const RCP< ModelEvaluator< Scalar > > &thyraModel, const RCP< Thyra::DirectionalFiniteDiffCalculator< Scalar > > &direcFiniteDiffCalculator)
	Nonmember constructor.

---

Detailed Description

template<class Scalar>
class Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >

This class wraps any ModelEvaluator object and computes certain derivatives using finite differences.

ToDo: Finish documentation!

Definition at line 50 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::DefaultFiniteDifferenceModelEvaluator

(

)

Definition at line 131 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

---

Member Function Documentation

template<class Scalar>

Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::STANDARD_COMPOSITION_MEMBERS	(	Thyra::DirectionalFiniteDiffCalculator< Scalar >	,
		direcFiniteDiffCalculator
	)

Utility object that computes directional finite differences.

template<class Scalar>

void Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::initialize	(	const RCP< ModelEvaluator< Scalar > > &	thyraModel,
		const RCP< Thyra::DirectionalFiniteDiffCalculator< Scalar > > &	direcFiniteDiffCalculator
	)

Definition at line 136 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

template<class Scalar>

void Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::uninitialize	(	RCP< ModelEvaluator< Scalar > > *	thyraModel,
		RCP< Thyra::DirectionalFiniteDiffCalculator< Scalar > > *	direcFiniteDiffCalculator
	)

Definition at line 147 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

template<class Scalar>

std::string Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::description

(

)

const [virtual]

Reimplemented from Teuchos::Describable.

Definition at line 163 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

---

Friends And Related Function Documentation

template<class Scalar>

RCP< DefaultFiniteDifferenceModelEvaluator< Scalar > > defaultFiniteDifferenceModelEvaluator	(	const RCP< ModelEvaluator< Scalar > > &	thyraModel,
		const RCP< Thyra::DirectionalFiniteDiffCalculator< Scalar > > &	direcFiniteDiffCalculator
	)			[related]

Nonmember constructor.

Definition at line 111 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

---

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

• Thyra_DefaultFiniteDifferenceModelEvaluator.hpp

---