Thyra
Version of the Day
|
This is a base class that delegetes almost all function to a wrapped model evaluator object. More...
#include <Thyra_ModelEvaluatorDelegatorBase.hpp>
Constructors/initializers | |
ModelEvaluatorDelegatorBase () | |
Constructs to uninitialized. More... | |
ModelEvaluatorDelegatorBase (const RCP< ModelEvaluator< Scalar > > &model) | |
Calls initialize() . More... | |
ModelEvaluatorDelegatorBase (const RCP< const ModelEvaluator< Scalar > > &model) | |
Calls initialize() . More... | |
void | initialize (const RCP< ModelEvaluator< Scalar > > &model) |
Initialize given a non-const model evaluator. More... | |
void | initialize (const RCP< const ModelEvaluator< Scalar > > &model) |
Initialize given a const model evaluator. More... | |
void | uninitialize () |
Uninitialize. More... | |
Virtual functions that can overridden | |
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 |
Teuchos::ArrayView< const std::string > | get_g_names (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< PreconditionerBase< Scalar > > | create_W_prec () 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. More... | |
Teuchos::EVerbosityLevel | readLocalVerbosityLevelValidatedParameter (ParameterList ¶mList) const |
Read the local verbosity level parameter. More... | |
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 82 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
Thyra::ModelEvaluatorDelegatorBase< Scalar >::ModelEvaluatorDelegatorBase | ( | ) |
Constructs to uninitialized.
Definition at line 321 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
Thyra::ModelEvaluatorDelegatorBase< Scalar >::ModelEvaluatorDelegatorBase | ( | const RCP< ModelEvaluator< Scalar > > & | model | ) |
Calls initialize()
.
Definition at line 326 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
Thyra::ModelEvaluatorDelegatorBase< Scalar >::ModelEvaluatorDelegatorBase | ( | const RCP< const ModelEvaluator< Scalar > > & | model | ) |
Calls initialize()
.
Definition at line 335 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
void Thyra::ModelEvaluatorDelegatorBase< Scalar >::initialize | ( | const RCP< ModelEvaluator< Scalar > > & | model | ) |
Initialize given a non-const model evaluator.
Definition at line 344 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
void Thyra::ModelEvaluatorDelegatorBase< Scalar >::initialize | ( | const RCP< const ModelEvaluator< Scalar > > & | model | ) |
Initialize given a const model evaluator.
Definition at line 353 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
void Thyra::ModelEvaluatorDelegatorBase< Scalar >::uninitialize | ( | ) |
Uninitialize.
Definition at line 362 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Definition at line 372 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Definition at line 380 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Definition at line 388 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Reimplemented in Thyra::DefaultStateEliminationModelEvaluator< Scalar >.
Definition at line 399 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Reimplemented in Thyra::DefaultStateEliminationModelEvaluator< Scalar >.
Definition at line 407 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Definition at line 415 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Definition at line 423 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Definition at line 431 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Definition at line 439 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Reimplemented in Thyra::DefaultStateEliminationModelEvaluator< Scalar >.
Definition at line 447 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Reimplemented in Thyra::DefaultStateEliminationModelEvaluator< Scalar >.
Definition at line 455 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Reimplemented in Thyra::DefaultStateEliminationModelEvaluator< Scalar >.
Definition at line 463 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Reimplemented from Thyra::ModelEvaluatorDefaultBase< Scalar >.
Reimplemented in Thyra::DefaultStateEliminationModelEvaluator< Scalar >.
Definition at line 471 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Reimplemented in Thyra::DefaultStateEliminationModelEvaluator< Scalar >.
Definition at line 479 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Definition at line 487 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Definition at line 495 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Reimplemented in Thyra::DefaultStateEliminationModelEvaluator< Scalar >.
Definition at line 503 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Definition at line 512 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
protected |
Set a valid parameter for reading the local verbosity level.
Definition at line 528 of file Thyra_ModelEvaluatorDelegatorBase.hpp.
|
protected |
Read the local verbosity level parameter.
Definition at line 551 of file Thyra_ModelEvaluatorDelegatorBase.hpp.