A ModelEvaluator for residual evaluations given a state. This ModelEvaluator takes a state, x, and determines its residual, $ g(x) $ , which is suitable for a nonlinear solve. This is accomplished by computing the time derivative of the state, x_dot, (through Lambda functions), supplying the current time, and calling the application application ModelEvaluator, $f(x,\dot{x},t)$ . More...

#include <Tempus_WrapperModelEvaluatorBasic_decl.hpp>

Inheritance diagram for Tempus::WrapperModelEvaluatorBasic< Scalar >:

Public Member Functions
	WrapperModelEvaluatorBasic (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel)
	Constructor. More...

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

virtual Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	getAppModel () const
	Get the underlying application model 'f'. More...

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

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

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

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

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

Overridden from Thyra::StateFuncModelEvaluatorBase
Teuchos::RCP < Thyra::LinearOpBase< Scalar > >	create_W_op () const

Teuchos::RCP < Thyra::PreconditionerBase < Scalar > >	create_W_prec () const

Teuchos::RCP< const Thyra::LinearOpWithSolveFactoryBase < Scalar > >	get_W_factory () const

Teuchos::RCP< const Thyra::VectorSpaceBase< Scalar > >	get_f_space () const

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

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

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

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

Thyra::ModelEvaluatorBase::InArgs < Scalar >	getNominalValues () const

Thyra::ModelEvaluatorBase::InArgs < Scalar >	createInArgs () const

Thyra::ModelEvaluatorBase::OutArgs < Scalar >	createOutArgsImpl () const

void	evalModelImpl (const Thyra::ModelEvaluatorBase::InArgs< Scalar > &inArgs, const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &outArgs) const

Vector Methods.

Private Member Functions
	WrapperModelEvaluatorBasic ()
	Default constructor - not allowed. More...

Private Attributes
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	appModel_

Teuchos::RCP< TimeDerivative < Scalar > >	timeDer_

Thyra::ModelEvaluatorBase::InArgs < Scalar >	wrapperInArgs_

Thyra::ModelEvaluatorBase::OutArgs < Scalar >	wrapperOutArgs_

EVALUATION_TYPE	evaluationType_

Detailed Description

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

A ModelEvaluator for residual evaluations given a state. This ModelEvaluator takes a state, x, and determines its residual, $ g(x) $ , which is suitable for a nonlinear solve. This is accomplished by computing the time derivative of the state, x_dot, (through Lambda functions), supplying the current time, and calling the application application ModelEvaluator, $f(x,\dot{x},t)$ .

Definition at line 26 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

Constructor & Destructor Documentation

template<typename Scalar >

Tempus::WrapperModelEvaluatorBasic< Scalar >::WrapperModelEvaluatorBasic ( const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > & appModel )

inline

Constructor.

Definition at line 32 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

Tempus::WrapperModelEvaluatorBasic< Scalar >::WrapperModelEvaluatorBasic ( )

private

Default constructor - not allowed.

Member Function Documentation

template<typename Scalar >

Teuchos::RCP<Thyra::LinearOpBase<Scalar> > Tempus::WrapperModelEvaluatorBasic< Scalar >::create_W_op ( ) const

inline

Definition at line 79 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

Teuchos::RCP<Thyra::PreconditionerBase<Scalar> > Tempus::WrapperModelEvaluatorBasic< Scalar >::create_W_prec ( ) const

inline

Definition at line 82 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

Thyra::ModelEvaluatorBase::InArgs< Scalar > Tempus::WrapperModelEvaluatorBasic< Scalar >::createInArgs ( ) const

Definition at line 18 of file Tempus_WrapperModelEvaluatorBasic_impl.hpp.

template<typename Scalar >

Thyra::ModelEvaluatorBase::OutArgs< Scalar > Tempus::WrapperModelEvaluatorBasic< Scalar >::createOutArgsImpl ( ) const

Definition at line 32 of file Tempus_WrapperModelEvaluatorBasic_impl.hpp.

template<typename Scalar >

void Tempus::WrapperModelEvaluatorBasic< Scalar >::evalModelImpl	(	const Thyra::ModelEvaluatorBase::InArgs< Scalar > &	inArgs,
		const Thyra::ModelEvaluatorBase::OutArgs< Scalar > &	outArgs
	)		const

Definition at line 44 of file Tempus_WrapperModelEvaluatorBasic_impl.hpp.

template<typename Scalar >

Teuchos::RCP<const Thyra::VectorSpaceBase<Scalar> > Tempus::WrapperModelEvaluatorBasic< Scalar >::get_f_space ( ) const

inline

Definition at line 88 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Get the g space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 100 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

Teuchos::RCP<const Teuchos::Array<std::string> > Tempus::WrapperModelEvaluatorBasic< Scalar >::get_p_names ( int p ) const

inline

Definition at line 94 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Get the p space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 91 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

Teuchos::RCP<const Thyra::LinearOpWithSolveFactoryBase<Scalar> > Tempus::WrapperModelEvaluatorBasic< Scalar >::get_W_factory ( ) const

inline

Definition at line 86 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Get the x-solution space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 97 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Get the underlying application model 'f'.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 47 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Get InArgs the wrapper ModelEvalutor.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 54 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

Thyra::ModelEvaluatorBase::InArgs<Scalar> Tempus::WrapperModelEvaluatorBasic< Scalar >::getNominalValues ( ) const

inline

Definition at line 103 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Get OutArgs the wrapper ModelEvalutor.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 62 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Set the underlying application ModelEvaluator.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 41 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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