#include <Thyra_DummyTestModelEvaluator_decl.hpp>

Inheritance diagram for Thyra::DummyTestModelEvaluator< Scalar >:

[legend]

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, const bool supports_derivatives=false)
	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 >
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...

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, const bool supports_derivatives=false)

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)

void	change_p_size_incorrectly (const Ordinal new_size)

void	change_p_size_correctly (const Ordinal new_size)

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 }
	. More...

enum	EInArgs_p_mp { IN_ARG_p_mp }
	. More...

enum	EEvalType { }
	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 }
	. More...

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

virtual RCP< const VectorSpaceBase< Scalar > >	get_f_multiplier_space () const

virtual RCP< const VectorSpaceBase< Scalar > >	get_g_multiplier_space (int j) 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
	. More...

static const int	NUM_E_OUT_ARGS_MEMBERS =7
	. 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...

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 98 of file Thyra_DummyTestModelEvaluator_decl.hpp.

Constructor & Destructor Documentation

◆ DummyTestModelEvaluator()

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`,
		const bool	supports_derivatives = `false`
	)

Definition at line 86 of file Thyra_DummyTestModelEvaluator_def.hpp.

Member Function Documentation

◆ get_x_space()

template<class Scalar >

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

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 169 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ get_p_space()

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 177 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ get_p_names()

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 185 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ get_f_space()

template<class Scalar >

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

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 193 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ get_g_space()

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 201 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ get_g_names()

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 209 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ getNominalValues()

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DummyTestModelEvaluator< Scalar >::getNominalValues

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 217 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ getLowerBounds()

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DummyTestModelEvaluator< Scalar >::getLowerBounds

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 225 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ getUpperBounds()

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DummyTestModelEvaluator< Scalar >::getUpperBounds

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 233 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ create_W_op()

template<class Scalar >

Teuchos::RCP< LinearOpBase< Scalar > > Thyra::DummyTestModelEvaluator< Scalar >::create_W_op

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 241 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ create_W_prec()

template<class Scalar >

Teuchos::RCP< PreconditionerBase< Scalar > > Thyra::DummyTestModelEvaluator< Scalar >::create_W_prec

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 251 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ get_W_factory()

template<class Scalar >

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

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 263 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ createInArgs()

template<class Scalar >

ModelEvaluatorBase::InArgs< Scalar > Thyra::DummyTestModelEvaluator< Scalar >::createInArgs

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 271 of file Thyra_DummyTestModelEvaluator_def.hpp.

◆ reportFinalPoint()

template<class Scalar >

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

virtual

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 278 of file Thyra_DummyTestModelEvaluator_def.hpp.

Friends And Related Function Documentation

◆ dummyTestModelEvaluator()

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`,
		const bool	supports_derivatives = `false`
	)

Definition at line 67 of file Thyra_DummyTestModelEvaluator_def.hpp.

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

Related Functions

Initializers/Accessors

Public functions overridden from ModelEvaulator.

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ DummyTestModelEvaluator()

Member Function Documentation

◆ get_x_space()

◆ get_p_space()

◆ get_p_names()

◆ get_f_space()

◆ get_g_space()

◆ get_g_names()

◆ getNominalValues()

◆ getLowerBounds()

◆ getUpperBounds()

◆ create_W_op()

◆ create_W_prec()

◆ get_W_factory()

◆ createInArgs()

◆ reportFinalPoint()

Friends And Related Function Documentation

◆ dummyTestModelEvaluator()

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