This base class defines default function implementations appropritate for a response-only model evaluator (p) -> g(j), for j=0...Ng-1. More...

#include <Thyra_ResponseOnlyModelEvaluatorBase.hpp>

Inheritance diagram for Thyra::ResponseOnlyModelEvaluatorBase< Scalar >:

[legend]

Public functions overridden from ModelEvaulator.
RCP< const VectorSpaceBase< Scalar > >	get_x_space () const
	Throws exception.

RCP< const Teuchos::Array< std::string > >	get_p_names (int l) const
	Returns null.

Teuchos::ArrayView< const std::string >	get_g_names (int j) const
	Returns null.

RCP< const VectorSpaceBase< Scalar > >	get_f_space () const
	Throws exception.

ModelEvaluatorBase::InArgs< Scalar >	getNominalValues () const
	Returns this->createInArgs().

ModelEvaluatorBase::InArgs< Scalar >	getLowerBounds () const
	Returns this->createInArgs().

ModelEvaluatorBase::InArgs< Scalar >	getUpperBounds () const
	Returns this->createInArgs().

RCP< LinearOpWithSolveBase< Scalar > >	create_W () const
	Thorws exception.

RCP< LinearOpBase< Scalar > >	create_W_op () const
	Thorws exception.

RCP< PreconditionerBase< Scalar > >	create_W_prec () const
	Thorws exception.

RCP< const LinearOpWithSolveFactoryBase< Scalar > >	get_W_factory () const
	Thorws exception.

void	reportFinalPoint (const ModelEvaluatorBase::InArgs< Scalar > &finalPoint, const bool wasSolved)
	Does nothing and ignores input.

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

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 >
virtual RCP< const VectorSpaceBase< Scalar > >	get_p_space (int l) const =0
	Return the vector space for the auxiliary parameters `p(l) <: RE^n_p_l`.

virtual RCP< const VectorSpaceBase< Scalar > >	get_g_space (int j) const =0
	Return the vector space for the auxiliary response functions `g(j) <: RE^n_g_j`.

virtual ModelEvaluatorBase::InArgs< Scalar >	createInArgs () const =0
	Create an empty input arguments object that can be set up and passed to `evalModel()`.

Public Member Functions inherited from Thyra::ModelEvaluatorBase
	ModelEvaluatorBase ()
	constructor

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.

void	resetDefaultBase ()
	Sets the the DefaultBase to an uninitialized state, forcing lazy initialization when needed.

Related Symbols 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.

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.

Detailed Description

template<class Scalar>
class Thyra::ResponseOnlyModelEvaluatorBase< Scalar >

This base class defines default function implementations appropritate for a response-only model evaluator (p) -> g(j), for j=0...Ng-1.

The minimum that a subclass must to is to define implementations for get_p_space(), get_g_space(), createInArgs(), createOutArgsImpl, and evalModelImpl().

Definition at line 32 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

Member Function Documentation

◆ get_x_space()

template<class Scalar >

RCP< const VectorSpaceBase< Scalar > > Thyra::ResponseOnlyModelEvaluatorBase< Scalar >::get_x_space ( ) const

virtual

Throws exception.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 80 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

◆ get_p_names()

template<class Scalar >

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

virtual

Returns null.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 88 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

◆ get_g_names()

template<class Scalar >

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

virtual

Returns null.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 101 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

◆ get_f_space()

template<class Scalar >

RCP< const VectorSpaceBase< Scalar > > Thyra::ResponseOnlyModelEvaluatorBase< Scalar >::get_f_space ( ) const

virtual

Throws exception.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 113 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

◆ getNominalValues()

template<class Scalar >

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

virtual

Returns this->createInArgs().

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 121 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

◆ getLowerBounds()

template<class Scalar >

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

virtual

Returns this->createInArgs().

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 127 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

◆ getUpperBounds()

template<class Scalar >

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

virtual

Returns this->createInArgs().

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 133 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

◆ create_W()

template<class Scalar >

RCP< LinearOpWithSolveBase< Scalar > > Thyra::ResponseOnlyModelEvaluatorBase< Scalar >::create_W ( ) const

virtual

Thorws exception.

Reimplemented from Thyra::ModelEvaluatorDefaultBase< Scalar >.

Definition at line 139 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

◆ create_W_op()

template<class Scalar >

RCP< LinearOpBase< Scalar > > Thyra::ResponseOnlyModelEvaluatorBase< Scalar >::create_W_op ( ) const

virtual

Thorws exception.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 153 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

◆ create_W_prec()

template<class Scalar >

RCP< PreconditionerBase< Scalar > > Thyra::ResponseOnlyModelEvaluatorBase< Scalar >::create_W_prec ( ) const

virtual

Thorws exception.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 167 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

◆ get_W_factory()

template<class Scalar >

RCP< const LinearOpWithSolveFactoryBase< Scalar > > Thyra::ResponseOnlyModelEvaluatorBase< Scalar >::get_W_factory ( ) const

virtual

Thorws exception.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 181 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

◆ reportFinalPoint()

template<class Scalar >

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

virtual

Does nothing and ignores input.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 194 of file Thyra_ResponseOnlyModelEvaluatorBase.hpp.

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

Thyra_ResponseOnlyModelEvaluatorBase.hpp

Public functions overridden from ModelEvaulator.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_x_space()

◆ get_p_names()

◆ get_g_names()

◆ get_f_space()

◆ getNominalValues()

◆ getLowerBounds()

◆ getUpperBounds()

◆ create_W()

◆ create_W_op()

◆ create_W_prec()

◆ get_W_factory()

◆ reportFinalPoint()