Thyra Version of the Day
Protected Member Functions | Related Functions
Thyra::ModelEvaluatorDefaultBase< Scalar > Class Template Reference

Default base class for concrete model evaluators. More...

#include <Thyra_ModelEvaluatorDefaultBase.hpp>

Inheritance diagram for Thyra::ModelEvaluatorDefaultBase< Scalar >:
Inheritance graph
[legend]

List of all members.

Protected Member Functions

 ModelEvaluatorDefaultBase ()
 

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP
< ModelEvaluatorBase::InArgs
< Scalar > > 
clone (const ModelEvaluatorBase::InArgs< Scalar > &inArgs)
 Create a clone of an InArgs object.
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.
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.
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.
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.

Overridden from ModelEvaluator

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
 
RCP< LinearOpWithSolveBase
< Scalar > > 
create_W () const
 
ModelEvaluatorBase::OutArgs
< Scalar > 
createOutArgs () const
 
void evalModel (const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const
 

Setup functions called by subclasses

void initializeDefaultBase ()
 Function called by subclasses to fully initialize this object on any important change.

Detailed Description

template<class Scalar>
class Thyra::ModelEvaluatorDefaultBase< Scalar >

Default base class for concrete model evaluators.

The primary purposes of this base class are to:

ToDo: Finish Documentation!

Definition at line 188 of file Thyra_ModelEvaluatorDefaultBase.hpp.


Constructor & Destructor Documentation

template<class Scalar >
Thyra::ModelEvaluatorDefaultBase< Scalar >::ModelEvaluatorDefaultBase ( ) [protected]

Definition at line 947 of file Thyra_ModelEvaluatorDefaultBase.hpp.


Member Function Documentation

template<class Scalar >
int Thyra::ModelEvaluatorDefaultBase< Scalar >::Np ( ) const [virtual]
template<class Scalar >
int Thyra::ModelEvaluatorDefaultBase< Scalar >::Ng ( ) const [virtual]
template<class Scalar >
RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDefaultBase< Scalar >::create_DfDp_op ( int  l) const [virtual]
template<class Scalar >
RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDefaultBase< Scalar >::create_DgDx_dot_op ( int  j) const [virtual]
template<class Scalar >
RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDefaultBase< Scalar >::create_DgDx_op ( int  j) const [virtual]
template<class Scalar >
RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDefaultBase< Scalar >::create_DgDp_op ( int  j,
int  l 
) const [virtual]
template<class Scalar >
RCP< LinearOpWithSolveBase< Scalar > > Thyra::ModelEvaluatorDefaultBase< Scalar >::create_W ( ) const [virtual]
template<class Scalar >
ModelEvaluatorBase::OutArgs< Scalar > Thyra::ModelEvaluatorDefaultBase< Scalar >::createOutArgs ( ) const [virtual]
template<class Scalar>
void Thyra::ModelEvaluatorDefaultBase< Scalar >::evalModel ( const ModelEvaluatorBase::InArgs< Scalar > &  inArgs,
const ModelEvaluatorBase::OutArgs< Scalar > &  outArgs 
) const [virtual]
template<class Scalar >
void Thyra::ModelEvaluatorDefaultBase< Scalar >::initializeDefaultBase ( ) [protected]

Function called by subclasses to fully initialize this object on any important change.

Note: This class will automatically call this function the first time to set things up and does not need to be called by the client the first time. However, if the state of the object changes, then this function should be called to reset the state of this object's implemention!

Definition at line 720 of file Thyra_ModelEvaluatorDefaultBase.hpp.


Friends And Related Function Documentation

template<class Scalar >
RCP< ModelEvaluatorBase::InArgs< Scalar > > clone ( const ModelEvaluatorBase::InArgs< Scalar > &  inArgs) [related]

Create a clone of an InArgs object.

Warning! This function only creates a shallow copy of the underlying input objects. Therefore, be careful if you try to modify any of these.

template<class Scalar >
ModelEvaluatorBase::Derivative< Scalar > derivativeGradient ( const RCP< MultiVectorBase< Scalar > > &  grad) [related]
template<class Scalar >
ModelEvaluatorBase::DerivativeMultiVector< Scalar > create_DfDp_mv ( const ModelEvaluator< Scalar > &  model,
int  l,
ModelEvaluatorBase::EDerivativeMultiVectorOrientation  orientation 
) [related]
template<class Scalar >
ModelEvaluatorBase::DerivativeMultiVector< Scalar > create_DgDx_dot_mv ( const ModelEvaluator< Scalar > &  model,
int  j,
ModelEvaluatorBase::EDerivativeMultiVectorOrientation  orientation 
) [related]
template<class Scalar >
ModelEvaluatorBase::DerivativeMultiVector< Scalar > create_DgDx_mv ( const ModelEvaluator< Scalar > &  model,
int  j,
ModelEvaluatorBase::EDerivativeMultiVectorOrientation  orientation 
) [related]
template<class Scalar >
ModelEvaluatorBase::DerivativeMultiVector< Scalar > create_DgDp_mv ( const ModelEvaluator< Scalar > &  model,
int  j,
int  l,
ModelEvaluatorBase::EDerivativeMultiVectorOrientation  orientation 
) [related]
template<class Scalar >
ModelEvaluatorBase::DerivativeMultiVector< Scalar > get_dmv ( const ModelEvaluatorBase::Derivative< Scalar > &  deriv,
const std::string &  derivName 
) [related]
template<class Scalar >
RCP< MultiVectorBase< Scalar > > get_mv ( const ModelEvaluatorBase::Derivative< Scalar > &  deriv,
const std::string &  derivName,
ModelEvaluatorBase::EDerivativeMultiVectorOrientation  orientation 
) [related]
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 
) [related]

Assert that that Thyra objects imbedded in a Derivative object matches its function and variable spaces.

template<class Scalar >
void assertInArgsOutArgsSetup ( const std::string &  modelEvalDescription,
const ModelEvaluatorBase::InArgs< Scalar > &  inArgs,
const ModelEvaluatorBase::OutArgs< Scalar > &  outArgs 
) [related]

Assert that an InArgs and OutArgs object are setup consistently.

template<class Scalar >
void assertInArgsEvalObjects ( const ModelEvaluator< Scalar > &  model,
const ModelEvaluatorBase::InArgs< Scalar > &  inArgs 
) [related]

Assert that the objects in an InArgs object match a given model.

template<class Scalar >
void assertOutArgsEvalObjects ( const ModelEvaluator< Scalar > &  model,
const ModelEvaluatorBase::OutArgs< Scalar > &  outArgs,
const ModelEvaluatorBase::InArgs< Scalar > *  inArgs = 0 
) [related]

Assert that the objects in an OutArgs object match a given model.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines