Thyra::StateFuncModelEvaluatorBase< Scalar > Class Template Reference

This base class defines default function implementations appropritate for a set of nonlinear state functions of the form x -> f(x). More...

#include <Thyra_StateFuncModelEvaluatorBase.hpp>

Inheritance diagram for Thyra::StateFuncModelEvaluatorBase< Scalar >:

List of all members.

Public functions overridden from ModelEvaulator.
RCP< const VectorSpaceBase < Scalar > >	get_p_space (int l) const
	Throws exception.
RCP< const Teuchos::Array < std::string > >	get_p_names (int l) const
	Throws exception.
RCP< const VectorSpaceBase < Scalar > >	get_g_space (int j) 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< LinearOpBase< Scalar > >	create_W_op () const
	Throws exception.
RCP< const LinearOpWithSolveFactoryBase < Scalar > >	get_W_factory () const
	Returns null .
void	reportFinalPoint (const ModelEvaluatorBase::InArgs< Scalar > &finalPoint, const bool wasSolved)
	Ignores input and does nothing.

---

Detailed Description

template<class Scalar>
class Thyra::StateFuncModelEvaluatorBase< Scalar >

This base class defines default function implementations appropritate for a set of nonlinear state functions of the form x -> f(x).

The minimum that a subclass must do is to define implementations for get_x_space(), get_f_space(), createInArgs(), createOutArgsImpl, and evalModelImpl().

Definition at line 49 of file Thyra_StateFuncModelEvaluatorBase.hpp.

---

Member Function Documentation

template<class Scalar >

RCP< const VectorSpaceBase< Scalar > > Thyra::StateFuncModelEvaluatorBase< Scalar >::get_p_space

(

int

l

)

const [virtual]

Throws exception.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 91 of file Thyra_StateFuncModelEvaluatorBase.hpp.

template<class Scalar >

RCP< const Teuchos::Array< std::string > > Thyra::StateFuncModelEvaluatorBase< Scalar >::get_p_names

(

int

l

)

const [virtual]

Throws exception.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 104 of file Thyra_StateFuncModelEvaluatorBase.hpp.

template<class Scalar >

RCP< const VectorSpaceBase< Scalar > > Thyra::StateFuncModelEvaluatorBase< Scalar >::get_g_space

(

int

j

)

const [virtual]

Throws exception.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 117 of file Thyra_StateFuncModelEvaluatorBase.hpp.

template<class Scalar >

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

(

)

const [virtual]

Returns this->createInArgs().

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::Simple2DModelEvaluator< Scalar >, and Simple2DTpetraModelEvaluator< Scalar >.

Definition at line 131 of file Thyra_StateFuncModelEvaluatorBase.hpp.

template<class Scalar >

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

(

)

const [virtual]

Returns this->createInArgs().

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 137 of file Thyra_StateFuncModelEvaluatorBase.hpp.

template<class Scalar >

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

(

)

const [virtual]

Returns this->createInArgs().

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 143 of file Thyra_StateFuncModelEvaluatorBase.hpp.

template<class Scalar >

RCP< LinearOpBase< Scalar > > Thyra::StateFuncModelEvaluatorBase< Scalar >::create_W_op

(

)

const [virtual]

Throws exception.

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::Simple2DModelEvaluator< Scalar >, and Simple2DTpetraModelEvaluator< Scalar >.

Definition at line 149 of file Thyra_StateFuncModelEvaluatorBase.hpp.

template<class Scalar >

RCP< const LinearOpWithSolveFactoryBase< Scalar > > Thyra::StateFuncModelEvaluatorBase< Scalar >::get_W_factory

(

)

const [virtual]

Returns null .

Implements Thyra::ModelEvaluator< Scalar >.

Reimplemented in Thyra::Simple2DModelEvaluator< Scalar >.

Definition at line 163 of file Thyra_StateFuncModelEvaluatorBase.hpp.

template<class Scalar >

void Thyra::StateFuncModelEvaluatorBase< Scalar >::reportFinalPoint	(	const ModelEvaluatorBase::InArgs< Scalar > &	finalPoint,
		const bool	wasSolved
	)		[virtual]

Ignores input and does nothing.

Implements Thyra::ModelEvaluator< Scalar >.

Definition at line 170 of file Thyra_StateFuncModelEvaluatorBase.hpp.

---

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

• Thyra_StateFuncModelEvaluatorBase.hpp