Thyra::ModelEvaluatorDefaultBase< Scalar > Class Template Reference

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

#include <Thyra_ModelEvaluatorDefaultBase.hpp>

Inheritance diagram for Thyra::ModelEvaluatorDefaultBase< Scalar >:


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

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.
Protected Member Functions
	ModelEvaluatorDefaultBase ()

Related Functions
(Note that these are not member functions.)
RCP< ModelEvaluatorBase::InArgs< Scalar > >	clone (const ModelEvaluatorBase::InArgs< Scalar > &inArgs)
	Create a clone of an InArgs object.
ModelEvaluatorBase::DerivativeMultiVector< Scalar >	create_DfDp_mv (const ModelEvaluator< Scalar > &model, int l, ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)
ModelEvaluatorBase::DerivativeMultiVector< Scalar >	create_DgDx_dot_mv (const ModelEvaluator< Scalar > &model, int j, ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)
ModelEvaluatorBase::DerivativeMultiVector< Scalar >	create_DgDx_mv (const ModelEvaluator< Scalar > &model, int j, ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)
ModelEvaluatorBase::DerivativeMultiVector< Scalar >	create_DgDp_mv (const ModelEvaluator< Scalar > &model, int j, int l, ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)
ModelEvaluatorBase::DerivativeMultiVector< Scalar >	get_dmv (const ModelEvaluatorBase::Derivative< Scalar > &deriv, const std::string &derivName)
RCP< MultiVectorBase< Scalar > >	get_mv (const ModelEvaluatorBase::Derivative< Scalar > &deriv, const std::string &derivName, ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)
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.
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.
void	assertInArgsEvalObjects (const ModelEvaluator< Scalar > &model, const ModelEvaluatorBase::InArgs< Scalar > &inArgs)
	Assert that the objects in an InArgs object match a given model.
void	assertOutArgsEvalObjects (const ModelEvaluator< Scalar > &model, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs)
	Assert that the objects in an OutArgs object match a given model.

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:

Provide default implementations for other forms of derivatives in ModelEvaluatorBase::Derivative. For example, if a multi-vector form of a derivative (i.e. my column DhDy or by row DhDy^T) is provided then the other form will be provided assuming the range space has in-core vectors. Also, if any multi-vector form of a general derivative is provided, a LinearOpBase version is automatically supported.
Assert (in debug mode) that the underlying model has been set up correctly.

ToDo: Finish Documentation!

Definition at line 145 of file Thyra_ModelEvaluatorDefaultBase.hpp.

Constructor & Destructor Documentation

template<class Scalar>

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

Definition at line 848 of file Thyra_ModelEvaluatorDefaultBase.hpp.

Member Function Documentation

template<class Scalar>

int Thyra::ModelEvaluatorDefaultBase< Scalar >::Np ( ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultMultiPeriodModelEvaluator< Scalar >.

Definition at line 332 of file Thyra_ModelEvaluatorDefaultBase.hpp.

template<class Scalar>

int Thyra::ModelEvaluatorDefaultBase< Scalar >::Ng ( ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DefaultMultiPeriodModelEvaluator< Scalar >.

Definition at line 341 of file Thyra_ModelEvaluatorDefaultBase.hpp.

template<class Scalar>

RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDefaultBase< Scalar >::create_DfDp_op ( int l ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 351 of file Thyra_ModelEvaluatorDefaultBase.hpp.

template<class Scalar>

RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDefaultBase< Scalar >::create_DgDx_dot_op ( int j ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 373 of file Thyra_ModelEvaluatorDefaultBase.hpp.

template<class Scalar>

RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDefaultBase< Scalar >::create_DgDx_op ( int j ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 395 of file Thyra_ModelEvaluatorDefaultBase.hpp.

template<class Scalar>

RCP< LinearOpBase< Scalar > > Thyra::ModelEvaluatorDefaultBase< Scalar >::create_DgDp_op	(	int	j,
		int	l
	)			const `[virtual]`

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 417 of file Thyra_ModelEvaluatorDefaultBase.hpp.

template<class Scalar>

ModelEvaluatorBase::OutArgs< Scalar > Thyra::ModelEvaluatorDefaultBase< Scalar >::createOutArgs ( ) const [virtual]

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DirectionalFiniteDiffCalculatorTypes::OutArgsCreator< Scalar >.

Definition at line 440 of file Thyra_ModelEvaluatorDefaultBase.hpp.

template<class Scalar>

void Thyra::ModelEvaluatorDefaultBase< Scalar >::evalModel	(	const ModelEvaluatorBase::InArgs< Scalar > &	inArgs,
		const ModelEvaluatorBase::OutArgs< Scalar > &	outArgs
	)			const `[virtual]`

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::DirectionalFiniteDiffCalculatorTypes::OutArgsCreator< Scalar >.

Definition at line 449 of file Thyra_ModelEvaluatorDefaultBase.hpp.

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 632 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.

Definition at line 275 of file Thyra_ModelEvaluatorHelpers.hpp.

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.

Definition at line 413 of file Thyra_ModelEvaluatorHelpers.hpp.

template<class Scalar>

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