A ModelEvaluator decorator for sensitivity analysis. More...

#include <Tempus_SensitivityModelEvaluatorBase.hpp>

Inheritance diagram for Tempus::SensitivityModelEvaluatorBase< 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...

Public Member Functions inherited from Thyra::ModelEvaluator< class >
virtual int	Np () const =0

virtual int	Ng () const =0

virtual RCP< const VectorSpaceBase< Scalar > >	get_x_space () const =0

virtual RCP< const VectorSpaceBase< Scalar > >	get_f_space () const =0

virtual RCP< const VectorSpaceBase< Scalar > >	get_f_multiplier_space () const =0

virtual RCP< const VectorSpaceBase< Scalar > >	get_p_space (int l) const =0

virtual RCP< const Teuchos::Array< std::string > >	get_p_names (int l) const =0

virtual RCP< const VectorSpaceBase< Scalar > >	get_g_space (int j) const =0

virtual RCP< const VectorSpaceBase< Scalar > >	get_g_multiplier_space (int j) const =0

virtual Teuchos::ArrayView < const std::string >	get_g_names (int j) const =0

virtual ModelEvaluatorBase::InArgs < Scalar >	getNominalValues () const =0

virtual ModelEvaluatorBase::InArgs < Scalar >	getLowerBounds () const =0

virtual ModelEvaluatorBase::InArgs < Scalar >	getUpperBounds () const =0

virtual RCP < LinearOpWithSolveBase < Scalar > >	create_W () const =0

virtual RCP< LinearOpBase < Scalar > >	create_W_op () const =0

virtual RCP < PreconditionerBase< Scalar > >	create_W_prec () const =0

virtual RCP< LinearOpBase < Scalar > >	create_DfDp_op (int l) const =0

virtual RCP< LinearOpBase < Scalar > >	create_DgDx_dot_op (int j) const =0

virtual RCP< LinearOpBase < Scalar > >	create_DgDx_op (int j) const =0

virtual RCP< LinearOpBase < Scalar > >	create_DgDp_op (int j, int l) const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_f_xx () const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_f_xp (int l) const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_f_pp (int l1, int l2) const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_g_xx (int j) const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_g_xp (int j, int l) const =0

virtual RCP< LinearOpBase < Scalar > >	create_hess_g_pp (int j, int l1, int l2) const =0

virtual RCP< const LinearOpWithSolveFactoryBase < Scalar > >	get_W_factory () const =0

virtual ModelEvaluatorBase::InArgs < Scalar >	createInArgs () const =0

virtual ModelEvaluatorBase::OutArgs < Scalar >	createOutArgs () const =0

virtual void	evalModel (const ModelEvaluatorBase::InArgs< Scalar > &inArgs, const ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const =0

virtual void	reportFinalPoint (const ModelEvaluatorBase::InArgs< Scalar > &finalPoint, const bool wasSolved)=0

	ModelEvaluatorBase ()

std::string	toString (ModelEvaluatorBase::EInArgsMembers)

std::string	toString (ModelEvaluatorBase::EOutArgsMembers)

std::string	toString (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)

ModelEvaluatorBase::EDerivativeMultiVectorOrientation	getOtherDerivativeMultiVectorOrientation (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation)

Public Member Functions inherited from Teuchos::Describable
virtual std::string	description () const

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

Additional Inherited Members
Public Types inherited from Thyra::ModelEvaluator< class >
enum	EInArgsMembers

enum	EInArgs_p_mp

enum	EEvalType

enum	EDerivativeMultiVectorOrientation

enum	EDerivativeLinearOp

enum	EDerivativeLinearity

enum	ERankStatus

enum	EOutArgsMembers

enum	EOutArgsDfDp

enum	EOutArgsDgDx_dot

enum	EOutArgsDgDx

enum	EOutArgsDgDp

enum	EOutArgs_hess_vec_prod_f_xx

enum	EOutArgs_hess_vec_prod_f_xp

enum	EOutArgs_hess_vec_prod_f_px

enum	EOutArgs_hess_vec_prod_f_pp

enum	EOutArgs_hess_vec_prod_g_xx

enum	EOutArgs_hess_vec_prod_g_xp

enum	EOutArgs_hess_vec_prod_g_px

enum	EOutArgs_hess_vec_prod_g_pp

enum	EOutArgs_hess_f_xx

enum	EOutArgs_hess_f_xp

enum	EOutArgs_hess_f_pp

enum	EOutArgs_hess_g_xx

enum	EOutArgs_hess_g_xp

enum	EOutArgs_hess_g_pp

enum	EOutArgs_H_xx

enum	EOutArgs_H_xp

enum	EOutArgs_H_pp

enum	EOutArgsDfDp_mp

enum	EOutArgs_g_mp

enum	EOutArgsDgDx_dot_mp

enum	EOutArgsDgDx_mp

enum	EOutArgsDgDp_mp

typedef Teuchos::ScalarTraits < Scalar >::magnitudeType	ScalarMag

Static Public Attributes inherited from Thyra::ModelEvaluator< class >
static const int	NUM_E_IN_ARGS_MEMBERS

static const int	NUM_E_OUT_ARGS_MEMBERS

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

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

template<typename Scalar >

Tempus::SensitivityModelEvaluatorBase< Scalar >::SensitivityModelEvaluatorBase ( )

inline

Constructor.

Definition at line 32 of file Tempus_SensitivityModelEvaluatorBase.hpp.

template<typename Scalar >

virtual Tempus::SensitivityModelEvaluatorBase< Scalar >::~SensitivityModelEvaluatorBase ( )

inlinevirtual

Destructor.

Definition at line 35 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 39 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 42 of file Tempus_SensitivityModelEvaluatorBase.hpp.

template<typename Scalar >

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