Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar > Class Template Reference

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

#include <Thyra_DefaultFiniteDifferenceModelEvaluator_decl.hpp>

Inheritance diagram for Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >:

List of all members.

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP < DefaultFiniteDifferenceModelEvaluator < Scalar > >	defaultFiniteDifferenceModelEvaluator ()
	Nonmember constructor.
template<class Scalar >
RCP < DefaultFiniteDifferenceModelEvaluator < Scalar > >	defaultFiniteDifferenceModelEvaluator (const RCP< ModelEvaluator< Scalar > > &thyraModel, const RCP< DirectionalFiniteDiffCalculator< Scalar > > &direcFiniteDiffCalculator)
	Nonmember constructor.
Constructors/initializers/accessors/utilities.
	STANDARD_COMPOSITION_MEMBERS (DirectionalFiniteDiffCalculator< Scalar >, direcFiniteDiffCalculator)
	Utility object that computes directional finite differences.
	DefaultFiniteDifferenceModelEvaluator ()
void	initialize (const RCP< ModelEvaluator< Scalar > > &thyraModel, const RCP< DirectionalFiniteDiffCalculator< Scalar > > &direcFiniteDiffCalculator)
Public functions overridden from Teuchos::Describable.
std::string	description () const
Private functions overridden from ModelEvaulatorDefaultBase.
ModelEvaluatorBase::OutArgs < Scalar >	createOutArgsImpl () const
void	evalModelImpl (const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const

---

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 49 of file Thyra_DefaultFiniteDifferenceModelEvaluator_decl.hpp.

---

Constructor & Destructor Documentation

template<class Scalar >

Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::DefaultFiniteDifferenceModelEvaluator

(

)

Definition at line 42 of file Thyra_DefaultFiniteDifferenceModelEvaluator_def.hpp.

---

Member Function Documentation

template<class Scalar >

Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::STANDARD_COMPOSITION_MEMBERS	(	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< DirectionalFiniteDiffCalculator< Scalar > > &	direcFiniteDiffCalculator
	)

Definition at line 47 of file Thyra_DefaultFiniteDifferenceModelEvaluator_def.hpp.

References Thyra::ModelEvaluatorDelegatorBase< Scalar >::initialize().

template<class Scalar >

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

(

)

const

Definition at line 61 of file Thyra_DefaultFiniteDifferenceModelEvaluator_def.hpp.

template<class Scalar >

ModelEvaluatorBase::OutArgs< Scalar > Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::createOutArgsImpl

(

)

const [private, virtual]

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 82 of file Thyra_DefaultFiniteDifferenceModelEvaluator_def.hpp.

template<class Scalar >

void Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::evalModelImpl	(	const ModelEvaluatorBase::InArgs< Scalar > &	inArgs,
		const ModelEvaluatorBase::OutArgs< Scalar > &	outArgs
	)		const [private, virtual]

Implements Thyra::ModelEvaluatorDefaultBase< Scalar >.

Definition at line 110 of file Thyra_DefaultFiniteDifferenceModelEvaluator_def.hpp.

References Thyra::ModelEvaluatorBase::OutArgs< Scalar >::get_DfDp(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::get_DgDp(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::get_f(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::get_g(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::Ng(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::Np(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::setFailed(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::supports(), THYRA_MODEL_EVALUATOR_DECORATOR_EVAL_MODEL_BEGIN, and THYRA_MODEL_EVALUATOR_DECORATOR_EVAL_MODEL_END.

---

Friends And Related Function Documentation

template<class Scalar >

RCP< DefaultFiniteDifferenceModelEvaluator< Scalar > > defaultFiniteDifferenceModelEvaluator

(

)

[related]

Nonmember constructor.

Definition at line 104 of file Thyra_DefaultFiniteDifferenceModelEvaluator_decl.hpp.

template<class Scalar >

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

Nonmember constructor.

Definition at line 116 of file Thyra_DefaultFiniteDifferenceModelEvaluator_decl.hpp.

---

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

• Thyra_DefaultFiniteDifferenceModelEvaluator_decl.hpp
• Thyra_DefaultFiniteDifferenceModelEvaluator_def.hpp