Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar > Class Template Reference

Forward sensitivity transient ModelEvaluator subclass. More...

#include <Rythmos_ForwardSensitivityModelEvaluatorBase.hpp>

Inheritance diagram for Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >:

[legend]List of all members.

Public Member Functions
virtual void	initializeStructure (const RCP< const Thyra::ModelEvaluator< Scalar > > &stateModel, const int p_index)=0
	Intialize the with the model structure.
virtual RCP< const Thyra::ModelEvaluator< Scalar > >	getStateModel () const =0
virtual int	get_p_index () const =0

---

Detailed Description

template<class Scalar>
class Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >

Forward sensitivity transient ModelEvaluator subclass.

This class provides a very general implemenation of a linear forward sensitivity model evaluator for a differential equation.

There are two derived classes which implement an implicit DAE and explicit ODE formulation of the sensitivity equations.

Definition at line 61 of file Rythmos_ForwardSensitivityModelEvaluatorBase.hpp.

---

Member Function Documentation

template<class Scalar>

virtual void Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >::initializeStructure	(	const RCP< const Thyra::ModelEvaluator< Scalar > > &	stateModel,
		const int	p_index
	)			[pure virtual]

Intialize the with the model structure.

Parameters:

	stateModel	[in,persisting] The ModelEvaluator that defines the parameterized state model f(x_dot,x,p).
	p_index	[in] The index of the parameter subvector in stateModel for which sensitivities will be computed for.

This function only intializes the spaces etc. needed to define structure of the problem. *this model object is not fully initialized at this point in that evalModel() will not work yet and will thrown exceptions if called. The function initalizeState() must be called later in order to fully initalize the model.

Implemented in Rythmos::ForwardSensitivityExplicitModelEvaluator< Scalar >, and Rythmos::ForwardSensitivityImplicitModelEvaluator< Scalar >.

template<class Scalar>

virtual RCP<const Thyra::ModelEvaluator<Scalar> > Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >::getStateModel

(

)

const [pure virtual]

Implemented in Rythmos::ForwardSensitivityExplicitModelEvaluator< Scalar >, and Rythmos::ForwardSensitivityImplicitModelEvaluator< Scalar >.

template<class Scalar>

virtual int Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >::get_p_index

(

)

const [pure virtual]

Implemented in Rythmos::ForwardSensitivityExplicitModelEvaluator< Scalar >, and Rythmos::ForwardSensitivityImplicitModelEvaluator< Scalar >.

---

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

• Rythmos_ForwardSensitivityModelEvaluatorBase.hpp

---