Thyra::DummyTestModelEvaluator< Scalar > Class Template Reference

Test helper ModelEvaluator. More...

#include <Thyra_DummyTestModelEvaluator_decl.hpp>

Inheritance diagram for Thyra::DummyTestModelEvaluator< Scalar >:

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP< DummyTestModelEvaluator < Scalar > >	dummyTestModelEvaluator (const Ordinal x_size=2, const ArrayView< const Ordinal > &p_sizes=Teuchos::null, const ArrayView< const Ordinal > &g_sizes=Teuchos::null, const bool supports_x_dot=false, const bool supports_x_dot_dot=false, const bool supports_extended_inargs=true, const bool supports_extended_outargs=true)
	Nonmember constuctor. 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)

Initializers/Accessors
	DummyTestModelEvaluator (const Ordinal x_size, const ArrayView< const Ordinal > &p_sizes, const ArrayView< const Ordinal > &g_sizes, const bool supports_x_dot=false, const bool supports_x_dot_dot=false, const bool supports_extended_inargs=true, const bool supports_extended_outargs=true)

Public functions overridden from ModelEvaulator.
RCP< const VectorSpaceBase < Scalar > >	get_x_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_f_space () 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< 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)

Additional Inherited Members
Public Types inherited from Thyra::ModelEvaluator< Scalar >
typedef Teuchos::ScalarTraits < Scalar >::magnitudeType	ScalarMag
Public Types inherited from Thyra::ModelEvaluatorBase
enum	EInArgsMembers {   IN_ARG_x_dot_dot, IN_ARG_x_dot, IN_ARG_x, IN_ARG_x_dot_poly,   IN_ARG_x_poly, IN_ARG_x_dot_mp, IN_ARG_x_mp, IN_ARG_t,   IN_ARG_alpha, IN_ARG_beta, IN_ARG_W_x_dot_dot_coeff, IN_ARG_step_size,   IN_ARG_stage_number }
enum	EInArgs_p_mp { IN_ARG_p_mp }
enum	EEvalType { , EVAL_TYPE_APPROX_DERIV, EVAL_TYPE_VERY_APPROX_DERIV }
	The type of an evaluation. More...
enum	EDerivativeMultiVectorOrientation { DERIV_MV_JACOBIAN_FORM, DERIV_MV_GRADIENT_FORM, DERIV_MV_BY_COL = DERIV_MV_JACOBIAN_FORM, DERIV_TRANS_MV_BY_ROW = DERIV_MV_GRADIENT_FORM }
enum	EDerivativeLinearOp { DERIV_LINEAR_OP }
enum	EDerivativeLinearity { DERIV_LINEARITY_UNKNOWN, DERIV_LINEARITY_CONST, DERIV_LINEARITY_NONCONST }
enum	ERankStatus { DERIV_RANK_UNKNOWN, DERIV_RANK_FULL, DERIV_RANK_DEFICIENT }
enum	EOutArgsMembers {   OUT_ARG_f, OUT_ARG_W, OUT_ARG_f_mp, OUT_ARG_W_mp,   OUT_ARG_W_op, OUT_ARG_W_prec, OUT_ARG_f_poly }
enum	EOutArgsDfDp { OUT_ARG_DfDp }
enum	EOutArgsDgDx_dot { OUT_ARG_DgDx_dot }
enum	EOutArgsDgDx { OUT_ARG_DgDx }
enum	EOutArgsDgDp { OUT_ARG_DgDp }
enum	EOutArgsDfDp_mp { OUT_ARG_DfDp_mp }
enum	EOutArgs_g_mp { OUT_ARG_g_mp }
enum	EOutArgsDgDx_dot_mp { OUT_ARG_DgDx_dot_mp }
enum	EOutArgsDgDx_mp { OUT_ARG_DgDx_mp }
enum	EOutArgsDgDp_mp { OUT_ARG_DgDp_mp }
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
RCP< LinearOpWithSolveBase < Scalar > >	create_W () 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::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...

Detailed Description

template<class Scalar>
class Thyra::DummyTestModelEvaluator< Scalar >

Test helper ModelEvaluator.

This class is used to help unit test the various ModelEvaluator support software, that is it.

Definition at line 71 of file Thyra_DummyTestModelEvaluator_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Thyra::DummyTestModelEvaluator< Scalar >::DummyTestModelEvaluator	(	const Ordinal	x_size,
		const ArrayView< const Ordinal > &	p_sizes,
		const ArrayView< const Ordinal > &	g_sizes,
		const bool	supports_x_dot = false,
		const bool	supports_x_dot_dot = false,
		const bool	supports_extended_inargs = true,
		const bool	supports_extended_outargs = true
	)

Definition at line 85 of file Thyra_DummyTestModelEvaluator_def.hpp.

Member Function Documentation

template<class Scalar >

Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DummyTestModelEvaluator< Scalar >::get_x_space ( ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 156 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DummyTestModelEvaluator< Scalar >::get_p_space ( int  l ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 164 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

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

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 172 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DummyTestModelEvaluator< Scalar >::get_f_space ( ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 180 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

Teuchos::RCP< const VectorSpaceBase< Scalar > > Thyra::DummyTestModelEvaluator< Scalar >::get_g_space ( int  j ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 188 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

Teuchos::ArrayView< const std::string > Thyra::DummyTestModelEvaluator< Scalar >::get_g_names ( int  j ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 196 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DummyTestModelEvaluator< Scalar >::getNominalValues ( ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 204 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DummyTestModelEvaluator< Scalar >::getLowerBounds ( ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 212 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DummyTestModelEvaluator< Scalar >::getUpperBounds ( ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 220 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

Teuchos::RCP< LinearOpBase< Scalar > > Thyra::DummyTestModelEvaluator< Scalar >::create_W_op ( ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 228 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

Teuchos::RCP< PreconditionerBase< Scalar > > Thyra::DummyTestModelEvaluator< Scalar >::create_W_prec ( ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 238 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

Teuchos::RCP< const LinearOpWithSolveFactoryBase< Scalar > > Thyra::DummyTestModelEvaluator< Scalar >::get_W_factory ( ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 250 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DummyTestModelEvaluator< Scalar >::createInArgs ( ) const

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 258 of file Thyra_DummyTestModelEvaluator_def.hpp.

template<class Scalar >

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

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 265 of file Thyra_DummyTestModelEvaluator_def.hpp.

Friends And Related Function Documentation

template<class Scalar >

RCP< DummyTestModelEvaluator< Scalar > > dummyTestModelEvaluator ( const Ordinal  x_size = 2, const ArrayView< const Ordinal > &  p_sizes = Teuchos::null, const ArrayView< const Ordinal > &  g_sizes = Teuchos::null, const bool  supports_x_dot = false, const bool  supports_x_dot_dot = false, const bool  supports_extended_inargs = true, const bool  supports_extended_outargs = true  )

related

Nonmember constuctor.

Definition at line 67 of file Thyra_DummyTestModelEvaluator_def.hpp.

---

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

• Thyra_DummyTestModelEvaluator_decl.hpp
• Thyra_DummyTestModelEvaluator_def.hpp