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(\dot{x},x,t)$ . More...

#include <Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp>

Inheritance diagram for Tempus::WrapperModelEvaluatorSecondOrder< Scalar >:

Public Types
typedef Thyra::VectorBase< Scalar >	Vector

Public Member Functions
	WrapperModelEvaluatorSecondOrder (const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &appModel, const std::string schemeName)
	Constructor.

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

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

void	initializeNewmark (Teuchos::RCP< const Vector > v_pred, Teuchos::RCP< const Vector > d_pred, Scalar delta_t, Scalar t, Scalar beta, Scalar gamma)
	Set values needed in evalModelImpl.

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

Overridden from Thyra::StateFuncModelEvaluatorBase
enum	SCHEME_TYPE { NEWMARK_IMPLICIT_AFORM , NEWMARK_IMPLICIT_DFORM }

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

Scalar	t_

Scalar	gamma_

Scalar	beta_

Scalar	delta_t_

Teuchos::RCP< const Vector >	d_pred_

Teuchos::RCP< const Vector >	v_pred_

Teuchos::RCP< Teuchos::FancyOStream >	out_

SCHEME_TYPE	schemeType_

Teuchos::RCP< TimeDerivative< Scalar > >	timeDer_

Thyra::ModelEvaluatorBase::InArgs< Scalar >	wrapperInArgs_

Thyra::ModelEvaluatorBase::OutArgs< Scalar >	wrapperOutArgs_

Teuchos::RCP< Thyra::LinearOpBase< Scalar > >	create_W_op () 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::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

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

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

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

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

	WrapperModelEvaluatorSecondOrder ()
	Default constructor - not allowed.

Detailed Description

template<typename Scalar>
class Tempus::WrapperModelEvaluatorSecondOrder< 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(\dot{x},x,t)$ .

This class breaks the primary design principle for ModelEvaluators; it is not stateless!

Definition at line 33 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

Member Typedef Documentation

◆ Vector

template<typename Scalar >

typedef Thyra::VectorBase<Scalar> Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::Vector

Definition at line 36 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

Member Enumeration Documentation

◆ SCHEME_TYPE

template<typename Scalar >

enum Tempus::WrapperModelEvaluatorSecondOrder::SCHEME_TYPE

Enumerator
NEWMARK_IMPLICIT_AFORM
NEWMARK_IMPLICIT_DFORM

Definition at line 192 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

Constructor & Destructor Documentation

◆ WrapperModelEvaluatorSecondOrder() [1/2]

template<typename Scalar >

Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::WrapperModelEvaluatorSecondOrder	(	const Teuchos::RCP< const Thyra::ModelEvaluator< Scalar > > &	appModel,
		const std::string	schemeName
	)

inline

Constructor.

Definition at line 39 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ WrapperModelEvaluatorSecondOrder() [2/2]

template<typename Scalar >

Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::WrapperModelEvaluatorSecondOrder ( )

private

Default constructor - not allowed.

Member Function Documentation

◆ setAppModel()

template<typename Scalar >

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

inlinevirtual

Set the underlying application ModelEvaluator.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 65 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ getAppModel()

template<typename Scalar >

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

inlinevirtual

Get the underlying application model 'f'.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 74 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ initializeNewmark()

template<typename Scalar >

void Tempus::WrapperModelEvaluatorSecondOrder< Scalar >::initializeNewmark	(	Teuchos::RCP< const Vector >	v_pred,
		Teuchos::RCP< const Vector >	d_pred,
		Scalar	delta_t,
		Scalar	t,
		Scalar	beta,
		Scalar	gamma
	)

inline

Set values needed in evalModelImpl.

Definition at line 83 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ create_W_op()

template<typename Scalar >

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

inline

Definition at line 100 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ get_W_factory()

template<typename Scalar >

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

inline

Definition at line 109 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ get_f_space()

template<typename Scalar >

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

inline

Definition at line 117 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ get_p_space()

template<typename Scalar >

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

inlinevirtual

Get the p space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 125 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ get_p_names()

template<typename Scalar >

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

inline

Definition at line 133 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ get_x_space()

template<typename Scalar >

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

inlinevirtual

Get the x-solution space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 141 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ get_g_space()

template<typename Scalar >

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

inlinevirtual

Get the g space.

Implements Tempus::WrapperModelEvaluator< Scalar >.

Definition at line 149 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ getNominalValues()

template<typename Scalar >

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

inline

Definition at line 154 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ getInArgs()

template<typename Scalar >

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

inlinevirtual

Get InArgs the wrapper ModelEvalutor.

Definition at line 163 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ getOutArgs()

template<typename Scalar >

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

inlinevirtual

Get OutArgs the wrapper ModelEvalutor.

Definition at line 169 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ setForSolve()

template<typename Scalar >

virtual void Tempus::WrapperModelEvaluatorSecondOrder< 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 175 of file Tempus_WrapperModelEvaluatorSecondOrder_decl.hpp.

◆ createInArgs()

template<typename Scalar >

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

Definition at line 17 of file Tempus_WrapperModelEvaluatorSecondOrder_impl.hpp.

◆ createOutArgsImpl()

template<typename Scalar >

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

Definition at line 34 of file Tempus_WrapperModelEvaluatorSecondOrder_impl.hpp.

◆ evalModelImpl()

template<typename Scalar >

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