Rythmos - Transient Integration for Differential Equations Version of the Day
Loading...
Searching...
No Matches
Related Symbols | List of all members
Rythmos::ForwardResponseSensitivityComputerObserver< Scalar > Class Template Reference

Observer class that computes sensitivities at the end of each time step. More...

#include <Rythmos_ForwardResponseSensitivityComputerObserver.hpp>

Inheritance diagram for Rythmos::ForwardResponseSensitivityComputerObserver< Scalar >:
Inheritance graph
[legend]

Related Symbols

(Note that these are not member symbols.)

template<class Scalar >
RCP< ForwardResponseSensitivityComputerObserver< Scalar > > forwardResponseSensitivityComputerObserver ()
 Non-member constructor.
 
template<class Scalar >
RCP< ForwardResponseSensitivityComputerObserver< Scalar > > forwardResponseSensitivityComputerObserver (const RCP< const Thyra::ModelEvaluator< Scalar > > &responseFunc, const Thyra::ModelEvaluatorBase::InArgs< Scalar > &basePoint, const int p_index, const int g_index)
 Non-member constructor.
 

Overridden from IntegrationObserverBase

virtual RCP< IntegrationObserverBase< Scalar > > cloneIntegrationObserver () const
 
virtual void resetIntegrationObserver (const TimeRange< Scalar > &integrationTimeDomain)
 
virtual void observeCompletedTimeStep (const StepperBase< Scalar > &stepper, const StepControlInfo< Scalar > &stepCtrlInfo, const int timeStepIter)
 

Constructors/Initializers/Accessors

 ForwardResponseSensitivityComputerObserver ()
 
void initialize (const RCP< const Thyra::ModelEvaluator< Scalar > > &responseFunc, const Thyra::ModelEvaluatorBase::InArgs< Scalar > &basePoint, const int p_index, const int g_index)
 
const Array< ResponseAndFwdSensPoint< Scalar > > & responseAndFwdSensPoints () const
 

Additional Inherited Members

- Public Member Functions inherited from Rythmos::IntegrationObserverBase< Scalar >
virtual void observeStartTimeIntegration (const StepperBase< Scalar > &stepper)
 Observe the beginning of a time integration loop.
 
virtual void observeEndTimeIntegration (const StepperBase< Scalar > &stepper)
 Observe the end of a time integration loop.
 
virtual void observeStartTimeStep (const StepperBase< Scalar > &stepper, const StepControlInfo< Scalar > &stepCtrlInfo, const int timeStepIter)
 Observer the beginning of an integration step.
 
virtual void observeFailedTimeStep (const StepperBase< Scalar > &stepper, const StepControlInfo< Scalar > &stepCtrlInfo, const int timeStepIter)
 Observer a failed integration step.
 

Detailed Description

template<class Scalar>
class Rythmos::ForwardResponseSensitivityComputerObserver< Scalar >

Observer class that computes sensitivities at the end of each time step.

ToDo: Finish Documentation

Definition at line 48 of file Rythmos_ForwardResponseSensitivityComputerObserver.hpp.

Constructor & Destructor Documentation

◆ ForwardResponseSensitivityComputerObserver()

template<class Scalar >
Rythmos::ForwardResponseSensitivityComputerObserver< Scalar >::ForwardResponseSensitivityComputerObserver ( )

Member Function Documentation

◆ initialize()

template<class Scalar >
void Rythmos::ForwardResponseSensitivityComputerObserver< Scalar >::initialize ( const RCP< const Thyra::ModelEvaluator< Scalar > > & responseFunc,
const Thyra::ModelEvaluatorBase::InArgs< Scalar > & basePoint,
const int p_index,
const int g_index )

◆ responseAndFwdSensPoints()

template<class Scalar >
const Array< ResponseAndFwdSensPoint< Scalar > > & Rythmos::ForwardResponseSensitivityComputerObserver< Scalar >::responseAndFwdSensPoints ( ) const

◆ cloneIntegrationObserver()

template<class Scalar >
RCP< IntegrationObserverBase< Scalar > > Rythmos::ForwardResponseSensitivityComputerObserver< Scalar >::cloneIntegrationObserver ( ) const
virtual

◆ resetIntegrationObserver()

template<class Scalar >
void Rythmos::ForwardResponseSensitivityComputerObserver< Scalar >::resetIntegrationObserver ( const TimeRange< Scalar > & integrationTimeDomain)
virtual

◆ observeCompletedTimeStep()

template<class Scalar >
void Rythmos::ForwardResponseSensitivityComputerObserver< Scalar >::observeCompletedTimeStep ( const StepperBase< Scalar > & stepper,
const StepControlInfo< Scalar > & stepCtrlInfo,
const int timeStepIter )
virtual

Friends And Related Symbol Documentation

◆ forwardResponseSensitivityComputerObserver() [1/2]

template<class Scalar >
RCP< ForwardResponseSensitivityComputerObserver< Scalar > > forwardResponseSensitivityComputerObserver ( )
related

Non-member constructor.

Definition at line 110 of file Rythmos_ForwardResponseSensitivityComputerObserver.hpp.

◆ forwardResponseSensitivityComputerObserver() [2/2]

template<class Scalar >
RCP< ForwardResponseSensitivityComputerObserver< Scalar > > forwardResponseSensitivityComputerObserver ( const RCP< const Thyra::ModelEvaluator< Scalar > > & responseFunc,
const Thyra::ModelEvaluatorBase::InArgs< Scalar > & basePoint,
const int p_index,
const int g_index )
related

Non-member constructor.

Definition at line 124 of file Rythmos_ForwardResponseSensitivityComputerObserver.hpp.


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