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...

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. More...

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

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. 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_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_DgDx_dot_op (int j) 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)

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

Private Attributes
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_

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::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. More...

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

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

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

template<typename Scalar >

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

private

Default constructor - not allowed.

Member Function Documentation

template<typename Scalar >

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

inlinevirtual

Set the underlying application ModelEvaluator.

Definition at line 53 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 60 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

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`
	)

inline

Set parameters for application implicit ModelEvaluator solve.

Definition at line 66 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 86 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Implements Thyra::ModelEvaluator< class >.

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

inlinevirtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 97 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 102 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 107 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

inlinevirtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 112 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 117 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 122 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 127 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 132 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 137 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 142 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

inlinevirtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 147 of file Tempus_WrapperModelEvaluatorBasic_decl.hpp.

template<typename Scalar >

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

virtual

Implements Thyra::ModelEvaluator< class >.

Definition at line 17 of file Tempus_WrapperModelEvaluatorBasic_impl.hpp.

template<typename Scalar >

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

Definition at line 40 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