Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar > Class Template Reference

This class wraps any ModelEvaluator object and allows the client to overide the state contained in the nominal values and the upper and lower bounds. More...

#include <Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp>

Inheritance diagram for Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >:

[legend]
List of all members.

Constructors/initializers/accessors/utilities.

 DefaultNominalBoundsOverrideModelEvaluator ()
 
 DefaultNominalBoundsOverrideModelEvaluator (const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &thyraModel, const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &nominalValues, const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &lowerBounds=Teuchos::null, const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &upperBounds=Teuchos::null)
 
void initialize (const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &thyraModel, const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &nominalValues, const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &lowerBounds=Teuchos::null, const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &upperBounds=Teuchos::null)
 Initalize.
void setNominalValues (const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &nominalValues)
 Set only nominal values.

Public functions overridden from ModelEvaulator.

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

Public functions overridden from Teuchos::Describable.

std::string description () const
 

Public Types

typedef Teuchos::ScalarTraits<
Scalar >::magnitudeType 
ScalarMag
 

Detailed Description

template<class Scalar>
class Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >

This class wraps any ModelEvaluator object and allows the client to overide the state contained in the nominal values and the upper and lower bounds.

Hint: To only overide some of the nominal values and bounds you can do:

   template<class Scalar>
   Teuchos::RefCountPtr<DefaultNominalBoundsOverrideModelEvaluator<Scalar> >
   override(
     const Teuchos::RefCountPtr<ModelEvaluator<Scalar> >   &thyraModel
     ...
     )
   {
     // Get the defaults
     typedef ModelEvaluatorBase MEB;
     MEB::InArgs<Scalar>  nominalValues = thyraModel->getNominalValues();
     MEB::InArgs<Scalar>  lowerBounds   = thyraModel->getLowerBounds();
     MEB::InArgs<Scalar>  upperBounds   = thyraModel->getUpperBounds();
     // Override selected components ...
     ...
     // Initialize the overridden state
     return Teuchos::rcp(
       new DefaultNominalBoundsOverrideModelEvaluator<Scalar>(
         thyraModel,nominalValues,lowerBounds,upperBounds
         )
       );
   }

ToDo: Finish documentation!

Definition at line 74 of file Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp.


Member Typedef Documentation

template<class Scalar>
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >::ScalarMag
 

Definition at line 80 of file Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp.


Constructor & Destructor Documentation

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

Definition at line 169 of file Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp.

template<class Scalar>
Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >::DefaultNominalBoundsOverrideModelEvaluator const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &  thyraModel,
const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &  nominalValues,
const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &  lowerBounds = Teuchos::null,
const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &  upperBounds = Teuchos::null
 

Definition at line 173 of file Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp.


Member Function Documentation

template<class Scalar>
void Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >::initialize const Teuchos::RefCountPtr< ModelEvaluator< Scalar > > &  thyraModel,
const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &  nominalValues,
const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &  lowerBounds = Teuchos::null,
const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &  upperBounds = Teuchos::null
 

Initalize.

Parameters:
thyraModel [in] Model being wrapped.
nominalValues [in] Completely overrides thyraModel->getNominalValues()
lowerBounds [in] If non-null, completely overrides thyraModel->getLowerBounds()
upperBounds [in] If non-null, completely overrides thyraModel->getUpperBounds()
Preconditions:
  • thyraModel.get()!=NULL

Postconditions:

  • this->getUnderlyingModel.get() == thyraModel.get()
  • [nominalValues.get()] this->getNominalValues() returns *nominalValues
  • [lowerBounds.get()] this->getLowerBounds() returns *lowerBounds
  • [upperBounds.get()] this->getUpperBounds() returns *upperBounds

Definition at line 184 of file Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp.

template<class Scalar>
void Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >::setNominalValues const Teuchos::RefCountPtr< const ModelEvaluatorBase::InArgs< Scalar > > &  nominalValues  ) 
 

Set only nominal values.

Definition at line 198 of file Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp.

template<class Scalar>
ModelEvaluatorBase::InArgs< Scalar > Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >::getNominalValues  )  const
 

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 209 of file Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp.

template<class Scalar>
ModelEvaluatorBase::InArgs< Scalar > Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >::getLowerBounds  )  const
 

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 217 of file Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp.

template<class Scalar>
ModelEvaluatorBase::InArgs< Scalar > Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >::getUpperBounds  )  const
 

Reimplemented from Thyra::ModelEvaluatorDelegatorBase< Scalar >.

Definition at line 225 of file Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp.

template<class Scalar>
void Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >::evalModel const ModelEvaluatorBase::InArgs< Scalar > &  inArgs,
const ModelEvaluatorBase::OutArgs< Scalar > &  outArgs
const
 

Definition at line 232 of file Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp.

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

Definition at line 294 of file Thyra_DefaultNominalBoundsOverrideModelEvaluator.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:32:49 2008 for Thyra Nonlinear Model Evaluator Support by doxygen 1.3.9.1