Thyra
Version of the Day
|
This class wraps any ModelEvaluator object and allows the client to capture the final point that is returned by a client. More...
#include <Thyra_DefaultFinalPointCaptureModelEvaluator.hpp>
Constructors/initializers/accessors/utilities. | |
DefaultFinalPointCaptureModelEvaluator () | |
DefaultFinalPointCaptureModelEvaluator (const Teuchos::RCP< ModelEvaluator< Scalar > > &thyraModel) | |
const ModelEvaluatorBase::InArgs < Scalar > & | getFinalPoint () const |
bool | finalPointWasSolved () const |
Public functions overridden from Teuchos::Describable. | |
std::string | description () const |
Public functions overridden from ModelEvaulator. | |
void | reportFinalPoint (const ModelEvaluatorBase::InArgs< Scalar > &finalPoint, const bool wasSolved) |
Additional Inherited Members | |
Public Member Functions inherited from Thyra::ModelEvaluatorDelegatorBase< Scalar > | |
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 bool | isUnderlyingModelConst () const |
virtual RCP< ModelEvaluator < Scalar > > | getNonconstUnderlyingModel () |
virtual RCP< const ModelEvaluator< Scalar > > | getUnderlyingModel () const |
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) |
Public Member Functions inherited from Thyra::ModelEvaluatorDefaultBase< Scalar > | |
int | Np () const |
int | Ng () const |
RCP< LinearOpBase< Scalar > > | create_DfDp_op (int l) const |
RCP< LinearOpBase< Scalar > > | create_DgDx_dot_op (int j) const |
RCP< LinearOpBase< Scalar > > | create_DgDx_op (int j) const |
RCP< LinearOpBase< Scalar > > | create_DgDp_op (int j, int l) const |
ModelEvaluatorBase::OutArgs < Scalar > | createOutArgs () const |
void | evalModel (const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const |
Public Member Functions inherited from Thyra::ModelEvaluator< Scalar > | |
Public Member Functions inherited from Thyra::ModelEvaluatorBase | |
ModelEvaluatorBase () | |
constructor More... | |
Static Public Attributes inherited from Thyra::ModelEvaluatorBase | |
static const int | NUM_E_IN_ARGS_MEMBERS =13 |
static const int | NUM_E_OUT_ARGS_MEMBERS =7 |
Protected Member Functions inherited from Thyra::ModelEvaluatorDelegatorBase< Scalar > | |
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... | |
Protected Member Functions inherited from Thyra::ModelEvaluatorDefaultBase< Scalar > | |
ModelEvaluatorDefaultBase () | |
void | initializeDefaultBase () |
Function called by subclasses to fully initialize this object on any important change. More... | |
void | resetDefaultBase () |
Sets the the DefaultBase to an uninitialized state, forcing lazy initialization when needed. More... | |
Related Functions inherited from Thyra::ModelEvaluatorDefaultBase< Scalar > | |
template<class Scalar > | |
RCP < ModelEvaluatorBase::InArgs < Scalar > > | clone (const ModelEvaluatorBase::InArgs< Scalar > &inArgs) |
Create a clone of an InArgs object. More... | |
template<class Scalar > | |
ModelEvaluatorBase::Derivative < Scalar > | derivativeGradient (const RCP< MultiVectorBase< Scalar > > &grad) |
template<class Scalar > | |
ModelEvaluatorBase::DerivativeMultiVector < Scalar > | create_DfDp_mv (const ModelEvaluator< Scalar > &model, int l, ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation) |
template<class Scalar > | |
ModelEvaluatorBase::DerivativeMultiVector < Scalar > | create_DgDx_dot_mv (const ModelEvaluator< Scalar > &model, int j, ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation) |
template<class Scalar > | |
ModelEvaluatorBase::DerivativeMultiVector < Scalar > | create_DgDx_mv (const ModelEvaluator< Scalar > &model, int j, ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation) |
template<class Scalar > | |
ModelEvaluatorBase::DerivativeMultiVector < Scalar > | create_DgDp_mv (const ModelEvaluator< Scalar > &model, int j, int l, ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation) |
template<class Scalar > | |
ModelEvaluatorBase::DerivativeMultiVector < Scalar > | get_dmv (const ModelEvaluatorBase::Derivative< Scalar > &deriv, const std::string &derivName) |
template<class Scalar > | |
RCP< MultiVectorBase< Scalar > > | get_mv (const ModelEvaluatorBase::Derivative< Scalar > &deriv, const std::string &derivName, ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation) |
template<class Scalar > | |
void | assertDerivSpaces (const std::string &modelEvalDescription, const ModelEvaluatorBase::Derivative< Scalar > &deriv, const std::string &deriv_name, const VectorSpaceBase< Scalar > &fnc_space, const std::string &fnc_space_name, const VectorSpaceBase< Scalar > &var_space, const std::string &var_space_name) |
Assert that that Thyra objects imbedded in a Derivative object matches its function and variable spaces. More... | |
template<class Scalar > | |
void | assertInArgsOutArgsSetup (const std::string &modelEvalDescription, const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) |
Assert that an InArgs and OutArgs object are setup consistently. More... | |
template<class Scalar > | |
void | assertInArgsEvalObjects (const ModelEvaluator< Scalar > &model, const ModelEvaluatorBase::InArgs< Scalar > &inArgs) |
Assert that the objects in an InArgs object match a given model. More... | |
template<class Scalar > | |
void | assertOutArgsEvalObjects (const ModelEvaluator< Scalar > &model, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs, const ModelEvaluatorBase::InArgs< Scalar > *inArgs=0) |
Assert that the objects in an OutArgs object match a given model. More... | |
Related Functions inherited from Thyra::ModelEvaluatorBase | |
std::string | toString (ModelEvaluatorBase::EInArgsMembers) |
std::string | toString (ModelEvaluatorBase::EOutArgsMembers) |
std::string | toString (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation) |
ModelEvaluatorBase::EDerivativeMultiVectorOrientation | getOtherDerivativeMultiVectorOrientation (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation) |
This class wraps any ModelEvaluator object and allows the client to capture the final point that is returned by a client.
ToDo: Finish documentation!
Definition at line 64 of file Thyra_DefaultFinalPointCaptureModelEvaluator.hpp.
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Thyra::DefaultFinalPointCaptureModelEvaluator< Scalar >::ScalarMag |
Definition at line 70 of file Thyra_DefaultFinalPointCaptureModelEvaluator.hpp.
Thyra::DefaultFinalPointCaptureModelEvaluator< Scalar >::DefaultFinalPointCaptureModelEvaluator | ( | ) |
Definition at line 139 of file Thyra_DefaultFinalPointCaptureModelEvaluator.hpp.
Thyra::DefaultFinalPointCaptureModelEvaluator< Scalar >::DefaultFinalPointCaptureModelEvaluator | ( | const Teuchos::RCP< ModelEvaluator< Scalar > > & | thyraModel | ) |
Definition at line 145 of file Thyra_DefaultFinalPointCaptureModelEvaluator.hpp.
const ModelEvaluatorBase::InArgs< Scalar > & Thyra::DefaultFinalPointCaptureModelEvaluator< Scalar >::getFinalPoint | ( | ) | const |
Definition at line 158 of file Thyra_DefaultFinalPointCaptureModelEvaluator.hpp.
bool Thyra::DefaultFinalPointCaptureModelEvaluator< Scalar >::finalPointWasSolved | ( | ) | const |
Definition at line 170 of file Thyra_DefaultFinalPointCaptureModelEvaluator.hpp.
|
virtual |
Reimplemented from Teuchos::Describable.
Definition at line 180 of file Thyra_DefaultFinalPointCaptureModelEvaluator.hpp.
|
virtual |
Implements Thyra::ModelEvaluator< Scalar >.
Definition at line 200 of file Thyra_DefaultFinalPointCaptureModelEvaluator.hpp.