Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar > Class Template Reference

This class wraps any ModelEvaluator object and logs the evaluation of various functions. More...

#include <Thyra_DefaultEvaluationLoggerModelEvaluator.hpp>

Inheritance diagram for Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >:

List of all members.

Private Member Functions
void	printHeader (const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
void	printLine (const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
Private Attributes
RCP< std::ostream >	tableOut_
Teuchos::Time	timer_
bool	headerPrinted_
bool	supports_f_
bool	supports_W_
Static Private Attributes
static const int	flt_width_ = 25
static const int	flt_sciPrec_ = 16
static const int	flt_prec_ = 16
static const char	flt_line_ [] = "-------------------------"
static const int	int_width_ = 10
static const char	int_line_ [] = "----------"
Constructors/initializers/accessors/utilities.
	DefaultEvaluationLoggerModelEvaluator ()
	DefaultEvaluationLoggerModelEvaluator (const RCP< ModelEvaluator< Scalar > > &thyraModel, const RCP< std::ostream > &tableOut)
void	initialize (const RCP< ModelEvaluator< Scalar > > &thyraModel, const RCP< std::ostream > &tableOut)
	Initalize.
Public functions overridden from Teuchos::Describable.
std::string	description () const
Private functions overridden from ModelEvaulatorDefaultBase
void	evalModelImpl (const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const

---

Detailed Description

template<class Scalar>
class Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >

This class wraps any ModelEvaluator object and logs the evaluation of various functions.

ToDo: Finish documentation!

Definition at line 47 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

---

Constructor & Destructor Documentation

template<class Scalar >

Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::DefaultEvaluationLoggerModelEvaluator

(

)

Definition at line 144 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::DefaultEvaluationLoggerModelEvaluator	(	const RCP< ModelEvaluator< Scalar > > &	thyraModel,
		const RCP< std::ostream > &	tableOut
	)

Definition at line 149 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

---

Member Function Documentation

template<class Scalar >

void Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::initialize	(	const RCP< ModelEvaluator< Scalar > > &	thyraModel,
		const RCP< std::ostream > &	tableOut
	)

Initalize.

Parameters:

thyraModel

[in] Model being wrapped.

Preconditions:

• thyraModel.get()!=NULL

Postconditions:

• this->getUnderlyingModel.get() == thyraModel.get()

Definition at line 159 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Referenced by Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::DefaultEvaluationLoggerModelEvaluator().

template<class Scalar >

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

(

)

const

Definition at line 176 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

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

Implements Thyra::ModelEvaluatorDefaultBase< Scalar >.

Definition at line 196 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

References THYRA_MODEL_EVALUATOR_DECORATOR_EVAL_MODEL_BEGIN, and THYRA_MODEL_EVALUATOR_DECORATOR_EVAL_MODEL_END.

template<class Scalar >

void Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::printHeader

(

const ModelEvaluatorBase::OutArgs< Scalar > &

outArgs

)

const [private]

Definition at line 223 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

References Thyra::ModelEvaluatorBase::OutArgs< Scalar >::Ng(), and Thyra::ModelEvaluatorBase::OutArgs< Scalar >::supports().

template<class Scalar >

void Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::printLine

(

const ModelEvaluatorBase::OutArgs< Scalar > &

outArgs

)

const [private]

Definition at line 272 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

References Thyra::ModelEvaluatorBase::OutArgs< Scalar >::get_f(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::get_g(), Thyra::ModelEvaluatorBase::OutArgs< Scalar >::get_W(), and Thyra::ModelEvaluatorBase::OutArgs< Scalar >::Ng().

---

Member Data Documentation

template<class Scalar >

RCP<std::ostream> Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::tableOut_ [private]

Definition at line 106 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

Teuchos::Time Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::timer_ [private]

Definition at line 107 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

bool Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::headerPrinted_ [mutable, private]

Definition at line 109 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

bool Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::supports_f_ [mutable, private]

Definition at line 110 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

bool Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::supports_W_ [mutable, private]

Definition at line 111 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

const int Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::flt_width_ = 25 [static, private]

Definition at line 113 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

const int Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::flt_sciPrec_ = 16 [static, private]

Definition at line 114 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

const int Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::flt_prec_ = 16 [static, private]

Definition at line 115 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

const char Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::flt_line_ = "-------------------------" [static, private]

Definition at line 116 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

const int Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::int_width_ = 10 [static, private]

Definition at line 117 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar >

const char Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::int_line_ = "----------" [static, private]

Definition at line 118 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

---

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

• Thyra_DefaultEvaluationLoggerModelEvaluator.hpp