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

#include <Tempus_WrapperModelEvaluator.hpp>

Inheritance diagram for Tempus::WrapperModelEvaluator< Scalar >:

Public Member Functions
virtual void	setAppModel (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &me)=0
	Set the underlying application ModelEvaluator. More...

virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getAppModel () const =0
	Get the underlying application ModelEvaluator. More...

virtual void	setInArgs (Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs)=0
	Set InArgs the wrapper ModelEvalutor. More...

virtual Thyra::ModelEvaluatorBase::InArgs < Scalar >	getInArgs ()=0
	Get InArgs the wrapper ModelEvalutor. More...

virtual void	setOutArgs (Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs)=0
	Set OutArgs the wrapper ModelEvalutor. More...

virtual Thyra::ModelEvaluatorBase::OutArgs < Scalar >	getOutArgs ()=0
	Get OutArgs the wrapper ModelEvalutor. More...

virtual void	setForSolve (Teuchos::RCP< TimeDerivative< Scalar > > td, Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs, Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs, EVALUATION_TYPE evaluationType=SOLVE_FOR_X)=0
	Set parameters for application implicit ModelEvaluator solve. More...

Public Member Functions inherited from Thyra::StateFuncModelEvaluatorBase< Scalar >
RCP< const VectorSpaceBase < Scalar > >	get_p_space (int l) const

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

RCP< const VectorSpaceBase < Scalar > >	get_g_space (int j) const

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

ModelEvaluatorBase::InArgs < Scalar >	getNominalValues () const

ModelEvaluatorBase::InArgs < Scalar >	getLowerBounds () const

ModelEvaluatorBase::InArgs < Scalar >	getUpperBounds () const

RCP< LinearOpBase< Scalar > >	create_W_op () const

RCP< PreconditionerBase< Scalar > >	create_W_prec () const

RCP< const LinearOpWithSolveFactoryBase < Scalar > >	get_W_factory () const

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

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

virtual int	Ng () 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_g_multiplier_space (int j) const =0

virtual RCP < LinearOpWithSolveBase < Scalar > >	create_W () 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 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

	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)

Vector Methods.
virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_x_space () const =0
	Get the x-solution space. More...

virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_g_space (int i) const =0
	Get the g space. More...

virtual Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_p_space (int i) const =0
	Get the p space. More...

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::WrapperModelEvaluator< Scalar >

A ModelEvaluator which wraps the application ModelEvaluator.

The WrapperModelEvaluator takes a state, $x$ , computes time derivative(s), $\dot{x}$ and/or $\ddot{x}$ , from the implicit stepper (StepperImplicit) and calls the application ModelEvaluator to determine its residual, $\mathcal{F}(x)$ , which is suitable for the nonlinear solve.

Definition at line 35 of file Tempus_WrapperModelEvaluator.hpp.

Member Function Documentation

template<typename Scalar >

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

pure virtual

Get the x-solution space.

Implements Thyra::ModelEvaluator< class >.

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

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.

Implements Thyra::ModelEvaluator< class >.

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

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.

Implements Thyra::ModelEvaluator< class >.

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

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::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorSecondOrder< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorBasic< Scalar >.

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::WrapperModelEvaluatorSecondOrder< Scalar >, Tempus::WrapperModelEvaluatorPairIMEX_Basic< Scalar >, Tempus::WrapperModelEvaluatorPairPartIMEX_Basic< Scalar >, and Tempus::WrapperModelEvaluatorBasic< Scalar >.

template<typename Scalar >

virtual void Tempus::WrapperModelEvaluator< Scalar >::setInArgs ( Thyra::ModelEvaluatorBase::InArgs< Scalar > inArgs )

pure virtual

Set InArgs the wrapper ModelEvalutor.

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

template<typename Scalar >

virtual Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus::WrapperModelEvaluator< Scalar >::getInArgs ( )

pure virtual

Get InArgs the wrapper ModelEvalutor.

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

template<typename Scalar >

virtual void Tempus::WrapperModelEvaluator< Scalar >::setOutArgs ( Thyra::ModelEvaluatorBase::OutArgs< Scalar > outArgs )

pure virtual

Set OutArgs the wrapper ModelEvalutor.

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

template<typename Scalar >

virtual Thyra::ModelEvaluatorBase::OutArgs<Scalar> Tempus::WrapperModelEvaluator< Scalar >::getOutArgs ( )

pure virtual

Get OutArgs the wrapper ModelEvalutor.

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

template<typename Scalar >

virtual void Tempus::WrapperModelEvaluator< Scalar >::setForSolve	(	Teuchos::RCP< TimeDerivative< Scalar > >	td,
		Thyra::ModelEvaluatorBase::InArgs< Scalar >	inArgs,
		Thyra::ModelEvaluatorBase::OutArgs< Scalar >	outArgs,
		EVALUATION_TYPE	evaluationType = `SOLVE_FOR_X`
	)

pure virtual

Set parameters for application implicit ModelEvaluator solve.

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

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

Tempus_WrapperModelEvaluator.hpp

Public Member Functions

Vector Methods.

Additional Inherited Members

Detailed Description

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

Member Function Documentation

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