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.

typedef Teuchos::RefCountPtr<
Thyra::DirectionalFiniteDiffCalculator<
Scalar > > 
direcFiniteDiffCalculator_ptr_t
void set_direcFiniteDiffCalculator (const Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator< Scalar > > &direcFiniteDiffCalculator)
 Utility object that computes directional finite differences.
Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator<
Scalar > > 
get_direcFiniteDiffCalculator () const
Thyra::DirectionalFiniteDiffCalculator<
Scalar > & 
direcFiniteDiffCalculator ()
const Thyra::DirectionalFiniteDiffCalculator<
Scalar > & 
direcFiniteDiffCalculator () const
 DefaultFiniteDifferenceModelEvaluator ()
 
 DefaultFiniteDifferenceModelEvaluator (const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &thyraModel, const Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator< Scalar > > &direcFiniteDiffCalculator)
 
void initialize (const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &thyraModel, const Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator< Scalar > > &direcFiniteDiffCalculator)
 
void uninitialize (Teuchos::RefCountPtr< ModelEvaluator< Scalar > > *thyraModel, Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator< Scalar > > *direcFiniteDiffCalculator)
 
Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator<
Scalar > > 
direcFiniteDiffCalculator_

Public functions overridden from ModelEvaulator.

ModelEvaluatorBase::OutArgs<
Scalar > 
createOutArgs () const
 
void evalModel (const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
 

Public functions overridden from Teuchos::Describable.

std::string description () 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 48 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.


Member Typedef Documentation

template<class Scalar>
typedef Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator<Scalar> > Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::direcFiniteDiffCalculator_ptr_t
 

Definition at line 57 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.


Constructor & Destructor Documentation

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

Definition at line 110 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

template<class Scalar>
Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::DefaultFiniteDifferenceModelEvaluator const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &  thyraModel,
const Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator< Scalar > > &  direcFiniteDiffCalculator
 

Definition at line 114 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::set_direcFiniteDiffCalculator const Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator< Scalar > > &  direcFiniteDiffCalculator  )  [inline]
 

Utility object that computes directional finite differences.

Definition at line 57 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

template<class Scalar>
Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator<Scalar> > Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::get_direcFiniteDiffCalculator  )  const [inline]
 

Definition at line 57 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

template<class Scalar>
Thyra::DirectionalFiniteDiffCalculator<Scalar>& Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::direcFiniteDiffCalculator  )  [inline]
 

Definition at line 57 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

template<class Scalar>
const Thyra::DirectionalFiniteDiffCalculator<Scalar>& Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::direcFiniteDiffCalculator  )  const [inline]
 

Definition at line 57 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

template<class Scalar>
void Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::initialize const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &  thyraModel,
const Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator< Scalar > > &  direcFiniteDiffCalculator
 

Definition at line 123 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

template<class Scalar>
void Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::uninitialize Teuchos::RefCountPtr< ModelEvaluator< Scalar > > *  thyraModel,
Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator< Scalar > > *  direcFiniteDiffCalculator
 

Definition at line 133 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

template<class Scalar>
ModelEvaluatorBase::OutArgs< Scalar > Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::createOutArgs  )  const [virtual]
 

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 148 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

template<class Scalar>
void Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::evalModel const ModelEvaluatorBase::InArgs< Scalar > &  inArgs,
const ModelEvaluatorBase::OutArgs< Scalar > &  outArgs
const [virtual]
 

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 170 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.

template<class Scalar>
std::string Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::description  )  const
 

Definition at line 284 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.


Member Data Documentation

template<class Scalar>
Teuchos::RefCountPtr< Thyra::DirectionalFiniteDiffCalculator<Scalar> > Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::direcFiniteDiffCalculator_ [private]
 

Definition at line 57 of file Thyra_DefaultFiniteDifferenceModelEvaluator.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:33:12 2008 for Thyra Package Browser (Single Doxygen Collection) by doxygen 1.3.9.1