This is a base class that delegetes almost all function to a wrapped model evaluator object. More...

#include <Thyra_ModelEvaluatorDelegatorBase.hpp>

Inheritance diagram for Thyra::ModelEvaluatorDelegatorBase< Scalar >:

Private Attributes
Teuchos::ConstNonconstObjectContainer < ModelEvaluator< Scalar > >	model_
Static Private Attributes
static RCP < Teuchos::StringToIntegralParameterEntryValidator < Teuchos::EVerbosityLevel > >	LocalVerbosityLevel_validator_
static const std::string	LocalVerbosityLevel_name_ = "Local Verbosity Level"
static const Teuchos::EVerbosityLevel	LocalVerbosityLevel_enum_default_ = Teuchos::VERB_DEFAULT
static const std::string	LocalVerbosityLevel_default_
Constructors/initializers
	ModelEvaluatorDelegatorBase ()
	Constructs to uninitialized.
	ModelEvaluatorDelegatorBase (const RCP< ModelEvaluator< Scalar > > &model)
	Calls `initialize()`.
	ModelEvaluatorDelegatorBase (const RCP< const ModelEvaluator< Scalar > > &model)
	Calls `initialize()`.
void	initialize (const RCP< ModelEvaluator< Scalar > > &model)
	Initialize given a non-const model evaluator.
void	initialize (const RCP< const ModelEvaluator< Scalar > > &model)
	Initialize given a const model evaluator.
void	uninitialize ()
	Uninitialize.
Virtual functions that can overriden
virtual bool	isUnderlyingModelConst () const

virtual RCP< ModelEvaluator < Scalar > >	getNonconstUnderlyingModel ()

virtual RCP< const ModelEvaluator< Scalar > >	getUnderlyingModel () const

Public functions overridden from ModelEvaulator.
RCP< const VectorSpaceBase < Scalar > >	get_x_space () const

RCP< const VectorSpaceBase < Scalar > >	get_f_space () const

RCP< const VectorSpaceBase < Scalar > >	get_p_space (int l) const

RCP< const Teuchos::Array < std::string > >	get_p_names (int l) const

RCP< const VectorSpaceBase < Scalar > >	get_g_space (int j) const

ModelEvaluatorBase::InArgs < Scalar >	getNominalValues () const

ModelEvaluatorBase::InArgs < Scalar >	getLowerBounds () const

ModelEvaluatorBase::InArgs < Scalar >	getUpperBounds () const

RCP< LinearOpWithSolveBase < Scalar > >	create_W () const

RCP< LinearOpBase< Scalar > >	create_W_op () const

RCP< const LinearOpWithSolveFactoryBase < Scalar > >	get_W_factory () const

ModelEvaluatorBase::InArgs < Scalar >	createInArgs () const

void	reportFinalPoint (const ModelEvaluatorBase::InArgs< Scalar > &finalPoint, const bool wasSolved)

Producted utility functions to be called by subclasses
void	setLocalVerbosityLevelValidatedParameter (ParameterList *paramList) const
	Set a valid parameter for reading the local verbosity level.
Teuchos::EVerbosityLevel	readLocalVerbosityLevelValidatedParameter (ParameterList &paramList) const
	Read the local verbosity level parameter.
Private functions overridden from ModelEvaluatorDefaultBase
RCP< LinearOpBase< Scalar > >	create_DfDp_op_impl (int l) const

RCP< LinearOpBase< Scalar > >	create_DgDx_dot_op_impl (int j) const

RCP< LinearOpBase< Scalar > >	create_DgDx_op_impl (int j) const

RCP< LinearOpBase< Scalar > >	create_DgDp_op_impl (int j, int l) const

ModelEvaluatorBase::OutArgs < Scalar >	createOutArgsImpl () const

Detailed Description

template<class Scalar>
class Thyra::ModelEvaluatorDelegatorBase< Scalar >

This is a base class that delegetes almost all function to a wrapped model evaluator object.

This class makes it easy to write many different types of decorator subclasses by only requiring those subclasses to override just the behavior that they need to overide and leave the rest alone. Note that whenever the definition of ModelEvaluator changes, this class will have to be updated. However, the decorator subclasses that derive from this base class might be able to remain unchanged. Note that changes in only the ModelEvaluatorBase::InArgs and ModelEvaluatorBase::OutArgs classes should not require any changes here.

The only functions that a client must override in order to create a concrete subcalss is the evalModel() function. All other functions have implementations here that simply delegate to the model evaluator object returned from getUnderlyingModel(). However, most decorator classes will need to override at least one other function.

This class provides a default implemntation of the machinary to store and access the wrapped model evaluator object. A subclass can choose to ignore this and override the functions isUnderlyingModelConst(), getConstUnderlyingModel(), and getUnderlyingModel().

Definition at line 69 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Thyra::ModelEvaluatorDelegatorBase< Scalar >::ModelEvaluatorDelegatorBase ( )

Constructs to uninitialized.

Definition at line 304 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

Thyra::ModelEvaluatorDelegatorBase< Scalar >::ModelEvaluatorDelegatorBase ( const RCP< ModelEvaluator< Scalar > > & model )

Calls initialize().

Definition at line 309 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

Thyra::ModelEvaluatorDelegatorBase< Scalar >::ModelEvaluatorDelegatorBase ( const RCP< const ModelEvaluator< Scalar > > & model )

Calls initialize().

Definition at line 318 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

Member Function Documentation

template<class Scalar >

void Thyra::ModelEvaluatorDelegatorBase< Scalar >::initialize ( const RCP< ModelEvaluator< Scalar > > & model )

Initialize given a non-const model evaluator.

Reimplemented in Thyra::DefaultInverseModelEvaluator< Scalar >, and Thyra::DefaultLumpedParameterModelEvaluator< Scalar >.

Definition at line 327 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

Referenced by Thyra::DefaultFinalPointCaptureModelEvaluator< Scalar >::DefaultFinalPointCaptureModelEvaluator(), Thyra::DefaultStateEliminationModelEvaluator< Scalar >::initialize(), Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >::initialize(), Thyra::DefaultModelEvaluatorWithSolveFactory< Scalar >::initialize(), Thyra::DefaultLumpedParameterModelEvaluator< Scalar >::initialize(), Thyra::DefaultInverseModelEvaluator< Scalar >::initialize(), Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >::initialize(), and Thyra::DefaultEvaluationLoggerModelEvaluator< Scalar >::initialize().

template<class Scalar >

void Thyra::ModelEvaluatorDelegatorBase< Scalar >::initialize ( const RCP< const ModelEvaluator< Scalar > > & model )

Initialize given a const model evaluator.

Definition at line 336 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

void Thyra::ModelEvaluatorDelegatorBase< Scalar >::uninitialize ( )

Uninitialize.

Definition at line 345 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

Referenced by Thyra::DefaultStateEliminationModelEvaluator< Scalar >::uninitialize(), Thyra::DefaultModelEvaluatorWithSolveFactory< Scalar >::uninitialize(), Thyra::DefaultLumpedParameterModelEvaluator< Scalar >::uninitialize(), and Thyra::DefaultInverseModelEvaluator< Scalar >::uninitialize().

template<class Scalar >

bool Thyra::ModelEvaluatorDelegatorBase< Scalar >::isUnderlyingModelConst ( ) const [virtual]

Definition at line 355 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< ModelEvaluator< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::getNonconstUnderlyingModel ( ) [virtual]

Definition at line 363 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< const ModelEvaluator< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::getUnderlyingModel ( ) const [virtual]

Definition at line 371 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< const VectorSpaceBase< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::get_x_space ( ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultStateEliminationModelEvaluator< Scalar >.

Definition at line 382 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< const VectorSpaceBase< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::get_f_space ( ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultStateEliminationModelEvaluator< Scalar >.

Definition at line 390 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< const VectorSpaceBase< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::get_p_space ( int l ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultInverseModelEvaluator< Scalar >, and Thyra::DefaultLumpedParameterModelEvaluator< Scalar >.

Definition at line 398 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< const Teuchos::Array< std::string > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::get_p_names ( int l ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultLumpedParameterModelEvaluator< Scalar >.

Definition at line 406 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< const VectorSpaceBase< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::get_g_space ( int j ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultInverseModelEvaluator< Scalar >.

Definition at line 414 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::ModelEvaluatorDelegatorBase< Scalar >::getNominalValues ( ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultLumpedParameterModelEvaluator< Scalar >, Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >, and Thyra::DefaultStateEliminationModelEvaluator< Scalar >.

Definition at line 422 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::ModelEvaluatorDelegatorBase< Scalar >::getLowerBounds ( ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultLumpedParameterModelEvaluator< Scalar >, Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >, and Thyra::DefaultStateEliminationModelEvaluator< Scalar >.

Definition at line 430 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::ModelEvaluatorDelegatorBase< Scalar >::getUpperBounds ( ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultLumpedParameterModelEvaluator< Scalar >, Thyra::DefaultNominalBoundsOverrideModelEvaluator< Scalar >, and Thyra::DefaultStateEliminationModelEvaluator< Scalar >.

Definition at line 438 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< LinearOpWithSolveBase< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::create_W ( ) const [virtual]

Reimplemented from Thyra::ModelEvaluatorDefaultBase< Scalar >.

Reimplemented in Thyra::DefaultModelEvaluatorWithSolveFactory< Scalar >, and Thyra::DefaultStateEliminationModelEvaluator< Scalar >.

Definition at line 446 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::create_W_op ( ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultStateEliminationModelEvaluator< Scalar >.

Definition at line 454 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< const LinearOpWithSolveFactoryBase< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::get_W_factory ( ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 462 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::ModelEvaluatorDelegatorBase< Scalar >::createInArgs ( ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultInverseModelEvaluator< Scalar >, and Thyra::DefaultStateEliminationModelEvaluator< Scalar >.

Definition at line 470 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

References Thyra::ModelEvaluatorBase::InArgsSetup< Scalar >::setModelEvalDescription().

template<class Scalar >

void Thyra::ModelEvaluatorDelegatorBase< Scalar >::reportFinalPoint	(	const ModelEvaluatorBase::InArgs< Scalar > &	finalPoint,
		const bool	wasSolved
	)		`[virtual]`

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultFinalPointCaptureModelEvaluator< Scalar >, and Thyra::DefaultLumpedParameterModelEvaluator< Scalar >.

Definition at line 479 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

void Thyra::ModelEvaluatorDelegatorBase< Scalar >::setLocalVerbosityLevelValidatedParameter ( ParameterList * paramList ) const [protected]

Set a valid parameter for reading the local verbosity level.

Definition at line 495 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

Teuchos::EVerbosityLevel Thyra::ModelEvaluatorDelegatorBase< Scalar >::readLocalVerbosityLevelValidatedParameter ( ParameterList & paramList ) const [protected]

Read the local verbosity level parameter.

Definition at line 518 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::create_DfDp_op_impl ( int l ) const [private, virtual]

Reimplemented from Thyra::ModelEvaluatorDefaultBase< Scalar >.

Definition at line 535 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::create_DgDx_dot_op_impl ( int j ) const [private, virtual]

Reimplemented from Thyra::ModelEvaluatorDefaultBase< Scalar >.

Definition at line 543 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::create_DgDx_op_impl ( int j ) const [private, virtual]

Reimplemented from Thyra::ModelEvaluatorDefaultBase< Scalar >.

Definition at line 553 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::create_DgDp_op_impl	(	int	j,
		int	l
	)		const `[private, virtual]`

Reimplemented from Thyra::ModelEvaluatorDefaultBase< Scalar >.

Definition at line 563 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

ModelEvaluatorBase::OutArgs< Scalar > Thyra::ModelEvaluatorDelegatorBase< Scalar >::createOutArgsImpl ( ) const [private, virtual]

Implements Thyra::ModelEvaluatorDefaultBase< Scalar >.

Reimplemented in Thyra::DefaultFiniteDifferenceModelEvaluator< Scalar >, Thyra::DefaultInverseModelEvaluator< Scalar >, Thyra::DefaultLumpedParameterModelEvaluator< Scalar >, Thyra::DefaultModelEvaluatorWithSolveFactory< Scalar >, and Thyra::DefaultStateEliminationModelEvaluator< Scalar >.

Definition at line 573 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

References Thyra::ModelEvaluatorBase::OutArgsSetup< Scalar >::setModelEvalDescription().

Member Data Documentation

template<class Scalar >

Teuchos::ConstNonconstObjectContainer<ModelEvaluator<Scalar> > Thyra::ModelEvaluatorDelegatorBase< Scalar >::model_ [private]

Definition at line 191 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

RCP< Teuchos::StringToIntegralParameterEntryValidator< Teuchos::EVerbosityLevel > > Thyra::ModelEvaluatorDelegatorBase< Scalar >::LocalVerbosityLevel_validator_ [static, private]

Definition at line 198 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

const std::string Thyra::ModelEvaluatorDelegatorBase< Scalar >::LocalVerbosityLevel_name_ = "Local Verbosity Level" [static, private]

Definition at line 199 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

const Teuchos::EVerbosityLevel Thyra::ModelEvaluatorDelegatorBase< Scalar >::LocalVerbosityLevel_enum_default_ = Teuchos::VERB_DEFAULT [static, private]

Definition at line 200 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

template<class Scalar >

const std::string Thyra::ModelEvaluatorDelegatorBase< Scalar >::LocalVerbosityLevel_default_ [static, private]

Initial value:

 getVerbosityLevelParameterValueName(
  ModelEvaluatorDelegatorBase<Scalar>::LocalVerbosityLevel_enum_default_
  )

Definition at line 201 of file Thyra_ModelEvaluatorDelegatorBase.hpp.

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

Thyra_ModelEvaluatorDelegatorBase.hpp

Private Attributes

Static Private Attributes

Constructors/initializers

Virtual functions that can overriden

Public functions overridden from ModelEvaulator.

Producted utility functions to be called by subclasses

Private functions overridden from ModelEvaluatorDefaultBase

Detailed Description

template<class Scalar> class Thyra::ModelEvaluatorDelegatorBase< Scalar >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Scalar>
class Thyra::ModelEvaluatorDelegatorBase< Scalar >