Tempus::WrapperModelEvaluator< Scalar > Class Template Reference

A ModelEvaluator which wraps the application ModelEvaluator. More...

#include <Tempus_WrapperModelEvaluator.hpp>

Inheritance diagram for Tempus::WrapperModelEvaluator< Scalar >:

Vector Methods.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_x_space () const =0
	Get the x-solution space.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_g_space (int i) const =0
	Get the g space.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_p_space (int i) const =0
	Get the p space.
virtual void	setAppModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &me)=0
	Set the underlying application ModelEvaluator.
virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getAppModel () const =0
	Get the underlying application ModelEvaluator.
virtual void	setForSolve (const Teuchos::RCP< Thyra::VectorBase< Scalar > > &x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &xDot, const Scalar time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &p, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &y=Teuchos::null, const int index=-1)=0
	Set parameters for application implicit ModelEvaluator solve.

Detailed Description

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

A ModelEvaluator which wraps the application ModelEvaluator.

The WrapperModelEvaluator takes a state, , computes time derivative(s), and/or , from the implicit stepper (StepperImplicit) and calls the application ModelEvaluator to determine its residual, , which is suitable for the nonlinear solve.

Definition at line 70 of file Tempus_WrapperModelEvaluator.hpp.

Member Function Documentation

get_x_space()

template<typename Scalar >

virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus::WrapperModelEvaluator< Scalar >::get_x_space ( ) const

pure virtual

Get the x-solution space.

Implemented in Tempus::WrapperModelEvaluatorBasic< Scalar >, Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorSecondOrder< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.

get_g_space()

template<typename Scalar >

virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus::WrapperModelEvaluator< Scalar >::get_g_space ( int  i ) const

pure virtual

Get the g space.

Implemented in Tempus::WrapperModelEvaluatorBasic< Scalar >, Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorSecondOrder< Scalar >, and Tempus::WrapperModelEvaluatorPairIMEX< Scalar >.

get_p_space()

template<typename Scalar >

virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > > Tempus::WrapperModelEvaluator< Scalar >::get_p_space ( int  i ) const

pure virtual

Get the p space.

Implemented in Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_CombinedFSA< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_StaggeredFSA< Scalar >, Tempus::WrapperModelEvaluatorPairIMEX< Scalar >, Tempus::WrapperModelEvaluatorBasic< Scalar >, and Tempus::WrapperModelEvaluatorSecondOrder< Scalar >.

setAppModel()

template<typename Scalar >

virtual void Tempus::WrapperModelEvaluator< Scalar >::setAppModel ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &  me )

pure virtual

Set the underlying application ModelEvaluator.

Implemented in Tempus::WrapperModelEvaluatorBasic< Scalar >, Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorSecondOrder< Scalar >.

getAppModel()

template<typename Scalar >

virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > Tempus::WrapperModelEvaluator< Scalar >::getAppModel ( ) const

pure virtual

Get the underlying application ModelEvaluator.

Implemented in Tempus::WrapperModelEvaluatorBasic< Scalar >, Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorSecondOrder< Scalar >.

setForSolve()

template<typename Scalar >

virtual void Tempus::WrapperModelEvaluator< Scalar >::setForSolve ( const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  x, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  xDot, const Scalar  time, const Teuchos::RCP< ImplicitODEParameters< Scalar > > &  p, const Teuchos::RCP< Thyra::VectorBase< Scalar > > &  y = Teuchos::null, const int  index = -1  )

pure virtual

Set parameters for application implicit ModelEvaluator solve.

Implemented in Tempus::WrapperModelEvaluatorBasic< Scalar >, Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorSecondOrder< Scalar >.

---

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

• Tempus_WrapperModelEvaluator.hpp