Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
Tempus::SensitivityModelEvaluatorBase< Scalar > Class Template Reference

A ModelEvaluator decorator for sensitivity analysis. More...

#include <Tempus_SensitivityModelEvaluatorBase.hpp>

Inheritance diagram for Tempus::SensitivityModelEvaluatorBase< Scalar >:
Tempus::CombinedForwardSensitivityModelEvaluator< Scalar > Tempus::StaggeredForwardSensitivityModelEvaluator< Scalar > Tempus::WrapperModelEvaluatorPairIMEX_CombinedFSA< Scalar > Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar > Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar > Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >

Public Member Functions

 SensitivityModelEvaluatorBase ()
 Constructor. More...
 
virtual ~SensitivityModelEvaluatorBase ()
 Destructor. More...
 
virtual Teuchos::RCP< const
Thyra::ModelEvaluator< Scalar > > 		getForwardModel () const
 Get the underlying forward model. More...
 
virtual void setForwardSolutionHistory (const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > &)
 Set solution history from forward state evaluation (for interpolation) More...
 
virtual void setForwardSolutionState (const Teuchos::RCP< const Tempus::SolutionState< Scalar > > &)
 Set solution state from forward state evaluation (for frozen state) More...
 
virtual void setSolver (const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &, const bool)
 Set the solver of the underlying model if you want to reuse it. More...
 

Detailed Description

template<typename Scalar>
class Tempus::SensitivityModelEvaluatorBase< Scalar >

A ModelEvaluator decorator for sensitivity analysis.

Used in sensitivity analysis model evaluators for interpolating from a previous solution and such. All additional methods have default, empty implementations, since different sensitivity model evaluators need slightly different capabilities.

Definition at line 26 of file Tempus_SensitivityModelEvaluatorBase.hpp.

Constructor & Destructor Documentation

template<typename Scalar >
Tempus::SensitivityModelEvaluatorBase< Scalar >::SensitivityModelEvaluatorBase ( )
inline

Constructor.

Definition at line 31 of file Tempus_SensitivityModelEvaluatorBase.hpp.

template<typename Scalar >
virtual Tempus::SensitivityModelEvaluatorBase< Scalar >::~SensitivityModelEvaluatorBase ( )
inlinevirtual

Destructor.

Definition at line 34 of file Tempus_SensitivityModelEvaluatorBase.hpp.

Member Function Documentation

template<typename Scalar >
virtual Teuchos::RCP<const Thyra::ModelEvaluator<Scalar> > Tempus::SensitivityModelEvaluatorBase< Scalar >::getForwardModel ( ) const
inlinevirtual

Get the underlying forward model.

Reimplemented in Tempus::StaggeredForwardSensitivityModelEvaluator< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >, Tempus::CombinedForwardSensitivityModelEvaluator< Scalar >, Tempus::WrapperModelEvaluatorPairIMEX_CombinedFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >.

Definition at line 38 of file Tempus_SensitivityModelEvaluatorBase.hpp.

template<typename Scalar >
virtual void Tempus::SensitivityModelEvaluatorBase< Scalar >::setForwardSolutionHistory ( const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > &  )
inlinevirtual

Set solution history from forward state evaluation (for interpolation)

Reimplemented in Tempus::StaggeredForwardSensitivityModelEvaluator< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >.

Definition at line 41 of file Tempus_SensitivityModelEvaluatorBase.hpp.

template<typename Scalar >
virtual void Tempus::SensitivityModelEvaluatorBase< Scalar >::setForwardSolutionState ( const Teuchos::RCP< const Tempus::SolutionState< Scalar > > &  )
inlinevirtual

Set solution state from forward state evaluation (for frozen state)

Reimplemented in Tempus::StaggeredForwardSensitivityModelEvaluator< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >.

Definition at line 45 of file Tempus_SensitivityModelEvaluatorBase.hpp.

template<typename Scalar >
virtual void Tempus::SensitivityModelEvaluatorBase< Scalar >::setSolver ( const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &  ,
const bool   
)
inlinevirtual

Set the solver of the underlying model if you want to reuse it.

Reimplemented in Tempus::StaggeredForwardSensitivityModelEvaluator< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX_StaggeredFSA< Scalar >.

Definition at line 49 of file Tempus_SensitivityModelEvaluatorBase.hpp.

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