Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar > Class Template Reference

Forward sensitivity transient ModelEvaluator node interface class. More...

#include <Rythmos_ForwardSensitivityModelEvaluatorBase.hpp>

Inheritance diagram for Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >:

Public Member Functions
virtual void	initializeStructure (const RCP< const Thyra::ModelEvaluator< Scalar > > &stateModel, const int p_index)=0
	Initialize the structure of the model. More...
virtual void	initializeStructureInitCondOnly (const RCP< const Thyra::ModelEvaluator< Scalar > > &stateModel, const RCP< const Thyra::VectorSpaceBase< Scalar > > &p_space)=0
	Initialize the structure of the model for an initial condition only sensitivity problem. More...
virtual RCP< const Thyra::ModelEvaluator< Scalar > >	getStateModel () const =0
virtual RCP < Thyra::ModelEvaluator < Scalar > >	getNonconstStateModel () const =0
virtual int	get_p_index () const =0
virtual RCP< const Thyra::DefaultMultiVectorProductVectorSpace < Scalar > >	get_s_bar_space () const =0
virtual RCP< const Thyra::VectorSpaceBase< Scalar > >	get_p_sens_space () const =0
virtual void	initializePointState (Ptr< StepperBase< Scalar > > stateStepper, bool forceUpToDateW)=0

Detailed Description

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

Forward sensitivity transient ModelEvaluator node interface class.

This base interface class provides the generalities 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

Initialize the structure of the model.

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::ForwardSensitivityImplicitModelEvaluator< Scalar >, and Rythmos::ForwardSensitivityExplicitModelEvaluator< Scalar >.

template<class Scalar>

virtual void Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >::initializeStructureInitCondOnly ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  stateModel, const RCP< const Thyra::VectorSpaceBase< Scalar > > &  p_space  )

pure virtual

Initialize the structure of the model for an initial condition only sensitivity problem.

Parameters

stateModel	[in,persisting] The ModelEvaluator that defines the parameterized state model f(x_dot,x,p).
p_space	[in] The vector space for the parameterized initial condition parameters.

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::ForwardSensitivityImplicitModelEvaluator< Scalar >, and Rythmos::ForwardSensitivityExplicitModelEvaluator< Scalar >.

template<class Scalar>

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

pure virtual

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

template<class Scalar>

virtual RCP<Thyra::ModelEvaluator<Scalar> > Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >::getNonconstStateModel ( ) const

pure virtual

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

template<class Scalar>

virtual int Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >::get_p_index ( ) const

pure virtual

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

template<class Scalar>

virtual RCP<const Thyra::DefaultMultiVectorProductVectorSpace<Scalar> > Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >::get_s_bar_space ( ) const

pure virtual

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

template<class Scalar>

virtual RCP<const Thyra::VectorSpaceBase<Scalar> > Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >::get_p_sens_space ( ) const

pure virtual

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

template<class Scalar>

virtual void Rythmos::ForwardSensitivityModelEvaluatorBase< Scalar >::initializePointState ( Ptr< StepperBase< Scalar > >  stateStepper, bool  forceUpToDateW  )

pure virtual

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

---

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

• Rythmos_ForwardSensitivityModelEvaluatorBase.hpp