Rythmos - Transient Integration for Differential Equations Version of the Day
Public Member Functions
Rythmos::ForwardResponseSensitivityComputer< Scalar > Class Template Reference

Concrete utility class for computing (assembling) forward transient response sensitivities. More...

#include <Rythmos_ForwardResponseSensitivityComputer.hpp>

List of all members.

Public Member Functions

 ForwardResponseSensitivityComputer ()
 
void dumpSensitivities (const bool &dumpSensitivities_in)
 
void setResponseFunction (const RCP< const Thyra::ModelEvaluator< Scalar > > &responseFunc, const Thyra::ModelEvaluatorBase::InArgs< Scalar > &basePoint, const int p_index, const int g_index)
 Set the response function for the first time.
void resetResponseFunction (const RCP< const Thyra::ModelEvaluator< Scalar > > &responseFunc, const Thyra::ModelEvaluatorBase::InArgs< Scalar > &basePoint)
 Reset the point-specific response function along with its base point.
const RCP< Thyra::VectorBase
< Scalar > > 
create_g_hat () const
 
const RCP
< Thyra::MultiVectorBase
< Scalar > > 
create_D_g_hat_D_p () const
 
void computeResponse (const Thyra::VectorBase< Scalar > *x_dot, const Thyra::VectorBase< Scalar > &x, const Scalar t, Thyra::VectorBase< Scalar > *g_hat) const
 Compute the reduced response at a point (xdot,x,t).
void computeResponseAndSensitivity (const Thyra::VectorBase< Scalar > *x_dot, const Thyra::MultiVectorBase< Scalar > *S_dot, const Thyra::VectorBase< Scalar > &x, const Thyra::MultiVectorBase< Scalar > &S, const Scalar t, Thyra::VectorBase< Scalar > *g_hat, Thyra::MultiVectorBase< Scalar > *D_g_hat_D_p) const
 Compute the reduced sensitivity and perhaps the response itself at a point (xdot,x,t).

Detailed Description

template<class Scalar>
class Rythmos::ForwardResponseSensitivityComputer< Scalar >

Concrete utility class for computing (assembling) forward transient response sensitivities.

ToDo: Finish documentation!

Definition at line 49 of file Rythmos_ForwardResponseSensitivityComputer.hpp.


Constructor & Destructor Documentation


Member Function Documentation

template<class Scalar >
void Rythmos::ForwardResponseSensitivityComputer< Scalar >::dumpSensitivities ( const bool &  dumpSensitivities_in) [inline]
template<class Scalar >
void Rythmos::ForwardResponseSensitivityComputer< Scalar >::setResponseFunction ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  responseFunc,
const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  basePoint,
const int  p_index,
const int  g_index 
)

Set the response function for the first time.

Parameters:
responseFunc[in,persisting] The response function that gives the structure of response.
basePoint[in] The base point for the calculation of the response function. Note that this must also include the current values of the parameters! This can be empty as long as it will be given later.
p_index[in] The index of the parameter subvector in the response function.
g_index[in] The index of the response function(s).

This sets the structure of the response function.

Definition at line 203 of file Rythmos_ForwardResponseSensitivityComputer.hpp.

template<class Scalar >
void Rythmos::ForwardResponseSensitivityComputer< Scalar >::resetResponseFunction ( const RCP< const Thyra::ModelEvaluator< Scalar > > &  responseFunc,
const Thyra::ModelEvaluatorBase::InArgs< Scalar > &  basePoint 
)

Reset the point-specific response function along with its base point.

Definition at line 241 of file Rythmos_ForwardResponseSensitivityComputer.hpp.

template<class Scalar >
const RCP< Thyra::VectorBase< Scalar > > Rythmos::ForwardResponseSensitivityComputer< Scalar >::create_g_hat ( ) const
template<class Scalar >
const RCP< Thyra::MultiVectorBase< Scalar > > Rythmos::ForwardResponseSensitivityComputer< Scalar >::create_D_g_hat_D_p ( ) const
template<class Scalar >
void Rythmos::ForwardResponseSensitivityComputer< Scalar >::computeResponse ( const Thyra::VectorBase< Scalar > *  x_dot,
const Thyra::VectorBase< Scalar > &  x,
const Scalar  t,
Thyra::VectorBase< Scalar > *  g_hat 
) const

Compute the reduced response at a point (xdot,x,t).

Parameters:
xdot[in,optional]
x[in] The x vector.
t[in] The time point
g_hat[out,optional] The output response function, if set. This can be created by calling this->create_g_hat().

Definition at line 270 of file Rythmos_ForwardResponseSensitivityComputer.hpp.

template<class Scalar >
void Rythmos::ForwardResponseSensitivityComputer< Scalar >::computeResponseAndSensitivity ( const Thyra::VectorBase< Scalar > *  x_dot,
const Thyra::MultiVectorBase< Scalar > *  S_dot,
const Thyra::VectorBase< Scalar > &  x,
const Thyra::MultiVectorBase< Scalar > &  S,
const Scalar  t,
Thyra::VectorBase< Scalar > *  g_hat,
Thyra::MultiVectorBase< Scalar > *  D_g_hat_D_p 
) const

Compute the reduced sensitivity and perhaps the response itself at a point (xdot,x,t).

Parameters:
x_dot[in,optional]
S_dot[in,optional]
x[in]
S[in]
t[in]
g_hat[out,optional] The output response function, if set. This can be created by calling this->create_g_hat().
D_g_hat_D_p[out] The output response function reduced parameter derivative. This can be created by calling this->create_D_g_hat_D_p().

Definition at line 282 of file Rythmos_ForwardResponseSensitivityComputer.hpp.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Friends