Tempus Version of the Day
Time Integration
Loading...
Searching...
No Matches
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.
 
virtual ~SensitivityModelEvaluatorBase ()
 Destructor.
 
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > getForwardModel () const
 Get the underlying forward model.
 
virtual void setForwardSolutionHistory (const Teuchos::RCP< const Tempus::SolutionHistory< Scalar > > &)
 Set solution history from forward state evaluation (for interpolation)
 
virtual void setForwardSolutionState (const Teuchos::RCP< const Tempus::SolutionState< Scalar > > &)
 Set solution state from forward state evaluation (for frozen state)
 
virtual void setSolver (const Teuchos::RCP< Thyra::NonlinearSolverBase< Scalar > > &, const bool)
 Set the solver of the underlying model if you want to reuse it.
 

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 27 of file Tempus_SensitivityModelEvaluatorBase.hpp.

Constructor & Destructor Documentation

◆ SensitivityModelEvaluatorBase()

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

Constructor.

Definition at line 32 of file Tempus_SensitivityModelEvaluatorBase.hpp.

◆ ~SensitivityModelEvaluatorBase()

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

Destructor.

Definition at line 35 of file Tempus_SensitivityModelEvaluatorBase.hpp.

Member Function Documentation

◆ getForwardModel()

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

◆ setForwardSolutionHistory()

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

◆ setForwardSolutionState()

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

◆ setSolver()

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

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