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 >:

[legend]
List of all members.

Constructors/initializers/accessors/utilities.

 DefaultEvaluationLoggerModelEvaluator ()
 
 DefaultEvaluationLoggerModelEvaluator (const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &thyraModel, const Teuchos::RefCountPtr< std::ostream > &tableOut)
 
void initialize (const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &thyraModel, const Teuchos::RefCountPtr< std::ostream > &tableOut)
 Initalize.

Public functions overridden from ModelEvaulator.

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

Public functions overridden from Teuchos::Describable.

std::string description () const
 

Private Member Functions

void printHeader (const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
void printLine (const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const

Private Attributes

Teuchos::RefCountPtr< std::ostream > tableOut_
Teuchos::Time timer_
bool headerPrinted_
bool supports_f_
bool supports_W_

Static Private Attributes

const int flt_width_ = 25
const int flt_sciPrec_ = 16
const int flt_prec_ = 16
const char flt_line_ [] = "-------------------------"
const int int_width_ = 10
const char int_line_ [] = "----------"

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 45 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.


Constructor & Destructor Documentation

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

Definition at line 140 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar>
Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::DefaultEvaluationLoggerModelEvaluator const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &  thyraModel,
const Teuchos::RefCountPtr< std::ostream > &  tableOut
 

Definition at line 145 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::initialize const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &  thyraModel,
const Teuchos::RefCountPtr< std::ostream > &  tableOut
 

Initalize.

Parameters:
thyraModel [in] Model being wrapped.
Preconditions:
  • thyraModel.get()!=NULL

Postconditions:

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

Definition at line 155 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar>
void Thyra::DefaultEvaluationLoggerModelEvaluator< 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_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Definition at line 208 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar>
void Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::printHeader const ModelEvaluatorBase::OutArgs< Scalar > &  outArgs  )  const [private]
 

Definition at line 226 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

template<class Scalar>
void Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::printLine const ModelEvaluatorBase::OutArgs< Scalar > &  outArgs  )  const [private]
 

Definition at line 275 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.


Member Data Documentation

template<class Scalar>
Teuchos::RefCountPtr<std::ostream> Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::tableOut_ [private]
 

Definition at line 102 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Definition at line 103 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Definition at line 105 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Definition at line 106 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Definition at line 107 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Definition at line 127 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Definition at line 129 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Definition at line 131 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Definition at line 133 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Definition at line 135 of file Thyra_DefaultEvaluationLoggerModelEvaluator.hpp.

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

Definition at line 137 of file Thyra_DefaultEvaluationLoggerModelEvaluator.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