A ModelEvaluator for residual evaluations given a state. This ModelEvaluator takes a state, x, and determines its residual, , 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.

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

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

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)
	Set parameters for application implicit ModelEvaluator solve.

Public Member Functions inherited from Tempus::WrapperModelEvaluator< Scalar >

Overridden from Thyra::StateFuncModelEvaluatorBase
Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > >	appModel_

Teuchos::RCP< Thyra::VectorBase< Scalar > >	x_

Teuchos::RCP< Thyra::VectorBase< Scalar > >	xDot_

Scalar	time_

Teuchos::RCP< ImplicitODEParameters< Scalar > >	p_

Teuchos::RCP< Thyra::VectorBase< Scalar > >	y_

int	index_

Teuchos::RCP< TimeDerivative< Scalar > >	timeDer_

EVALUATION_TYPE	evaluationType_

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.

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

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

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

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

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

Teuchos::RCP< Thyra::LinearOpBase< Scalar > >	create_DfDp_op (int l) const

Teuchos::RCP< Thyra::LinearOpBase< Scalar > >	create_DgDx_op (int j) const

Teuchos::RCP< Thyra::LinearOpBase< Scalar > >	create_DgDp_op (int j, int l) 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

	WrapperModelEvaluatorBasic ()
	Default constructor - not allowed.

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

Constructor & Destructor Documentation

◆ WrapperModelEvaluatorBasic() [1/2]

template<typename Scalar >

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

inline

Constructor.

Definition at line 31 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ WrapperModelEvaluatorBasic() [2/2]

template<typename Scalar >

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

private

Default constructor - not allowed.

Member Function Documentation

◆ setAppModel()

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 53 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ getAppModel()

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 60 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ setForSolve()

template<typename Scalar >

void Tempus::WrapperModelEvaluatorBasic< 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`
	)

inlinevirtual

Set parameters for application implicit ModelEvaluator solve.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 66 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ create_W_op()

template<typename Scalar >

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

inline

Definition at line 86 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ create_W_prec()

template<typename Scalar >

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

inline

Definition at line 91 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ get_W_factory()

template<typename Scalar >

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

inline

Definition at line 97 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ get_f_space()

template<typename Scalar >

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

inline

Definition at line 102 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ get_p_space()

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 107 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ get_p_names()

template<typename Scalar >

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

inline

Definition at line 112 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ get_g_names()

template<typename Scalar >

Teuchos::ArrayView< const std::string > Tempus::WrapperModelEvaluatorBasic< Scalar >::get_g_names ( int g ) const

inline

Definition at line 117 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ get_x_space()

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 122 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ get_g_space()

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 127 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ getNominalValues()

template<typename Scalar >

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

inline

Definition at line 132 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ create_DfDp_op()

template<typename Scalar >

Teuchos::RCP< Thyra::LinearOpBase< Scalar > > Tempus::WrapperModelEvaluatorBasic< Scalar >::create_DfDp_op ( int l ) const

inline

Definition at line 137 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ create_DgDx_op()

template<typename Scalar >

Teuchos::RCP< Thyra::LinearOpBase< Scalar > > Tempus::WrapperModelEvaluatorBasic< Scalar >::create_DgDx_op ( int j ) const

inline

Definition at line 142 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ create_DgDp_op()

template<typename Scalar >

Teuchos::RCP< Thyra::LinearOpBase< Scalar > > Tempus::WrapperModelEvaluatorBasic< Scalar >::create_DgDp_op	(	int	j,
		int	l
	)		const

inline

Definition at line 147 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

◆ createInArgs()

template<typename Scalar >

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

Definition at line 17 of file Tempus_WrapperModelEvaluatorBasic_impl.hpp.

◆ createOutArgsImpl()

template<typename Scalar >

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

Definition at line 40 of file Tempus_WrapperModelEvaluatorBasic_impl.hpp.

◆ evalModelImpl()

template<typename Scalar >

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